edison365projects: Admin User Guide

Published July 2021 Version 0.1

edison365projects: Admin User Guide

Version Date Author Comments
0.1 30 Jun 2021 Jake Favell Initial Draft
       
       

Contents

1. Introduction

2. Installation

3. Administrator's Console

4. Database Configuration

5. Global Users

5.1 User Profiles

6. Fields

7. Tables

8. Project Buttons

9. Forms

10. Types

11. News

12. Theme

13. Notifications

14. Projects

15. Product Links- Business Case Integration

16. Teams

17. Yammer (now Viva Engage)

18. Reports

19. Customer Information

 

1. Introduction

This document provides instructions for managing the edison365 application projects module and covers administrative tasks related to application configuration for administrators.

The audience for this document is the edison365 Application: Projects Module Administrators.

Back to Home

2. Installation

edison365 projects module requires two prerequisites as detailed in the product description document:

  • Azure SQL Database
    • At least S1 tier but the database usage should be monitored and scaled as required
  • A SharePoint Online Modern Team Site Collection to deploy the application to

The user installing the application on the new site collection will require Site Collection Administrator privileges as they will be the only users who have access to the edison365 projects module initially. This user accessing the application for the first time will be advised about SharePoint artefacts that will be deployed to the underlying SharePoint Online site collection to support edison365 projects module.

Once the Application is installed and the Admin Console is displayed the edison365 Support Team will walk you through the Customer Info screen. This will help capture information on your business and to capture information from edison365 to provide contact information for Support and Technical help from edison365.

Back to Home

3. Administrator's Control

The Administrator’s Console is accessed via the cog icon in the top right corner next to the user profile. The Admin cog navigates to the admin home page. Below is a screenshot of the edison365 projects module admin homepage.

Back to Home

4. Database Configuration

 

Before the Projects application can be used an empty Azure SQL database must be assigned. To do this ensure a valid Server Address, Port, Database Name, Database Account, and Password is entered. Should any of the database configuration be invalid the database updates will not save or updated.

Database schemas can occasionally be updated should a new schema be available. To update them click on the Upgrade button but ensure the actions outlined on the database status page are performed first. Once clicked a background job will take place on your database to update the schema to add any additional SQL objects such as new tables or columns in existing tables. This can take some time so it will be best to carry this out during a time that will not impact users as per the summary text on the database status page.

As always with any database updates it is essential to ensure a backup of the database is available before the database is updated.

Once the schema is updated the Database Status section will update to show the schema is up to date.

Back to Home

5. Global Users

This area is used to assign Admin and Exec roles to users for the Projects application.

To add a user, enter a name and a search will be carried out using the name entered and all possible matches will be displayed.

When the name from the search results is selected the full name will be added to the Admin/Execs boxes. When the user is added to the box click on the Save button and the user will be added to the role.

Admins have full access to edison365 projects module for configuration and data, Execs have read only access to all projects and no access to the configuration.   

Back to Home

5.1 User Profiles

When assigned to a Project role that user will be granted Read permissions on the SharePoint site collection and the role(s) given when setting up each type will used when viewing the application. Please see the User Guide for additional information on assigning roles to Projects (Projects User Guide)

  • edison365 Projects Administrators (Admin Global User)
    Members of this group can access the edison365 Projects administrator settings. These users have full control across all functionalities.
  • edison365 Project Owners
    Members of this group can create Projects for Project types they are set as a possible Owner. The assigned project owners can also edit the project where that user is the assigned project owner. 
  • edison365 Process Managers
    Members of this group can fully edit any project for the Project Types they are assigned to. They can edit a project, create versions, and assign readers. 
  • edison365 Project Readers
    Members of this group can view a Project in full for the Project Types they are assigned to as a reader. 
  • edison365 Project Viewers (Exec Global User)
    Members of this group can view all Projects in a read only format for all Project Types.
  • edison365 Project Reviewers
    Members of this group can review a project if it is currently in a Review stage. They can View and Review a Project. They can also Edit a Project but only when configured on a Stage at Type Level.

Below is a visual guide to show each role and the functionalities that role can carry out.

This permission matrix can be used to determine the roles required.

Back to Home

6. Fields

This area is where all custom fields can be added and managed.

To create a new field, click on the Create Field button and the following window will be opened.

Once the window is opened simply enter the name for the field in the Label field which will automatically assign the Internal Name field which cannot be changed. The Field Type can also be changed. See image 3 for the different field types. Depending on the field type selected additional settings may be added or removed. Below is a summary of the fields and field settings:

  • Textbox – Max Length (numeric), and Multiple Lines of Text (Yes/No switch).
  • Rich Text – None.
  • Number – Format (Number, Percentage, or Currency), Decimal Places (Drop down values 0 – 5), Min Value (numeric text box), Max Value (numeric text box).
  • Choice – Text box to enter choices for the field.
  • Multi-Level Choice: Choice field with multiple layers. Can be set as single or multi select.
  • RAG Status: Fully customisable visual indication of progress.
  • Date – None.
  • Switch – On Label (text box), Off Label (text box), Default Value (on/off switch).
  • People Picker – Multi Select (Yes/No switch).
  • URL – None.
  • Calculated – Any Text and Number fields can be added and when values are added to the fields used the calculation will take place. If a value is not set for all fields the field will display ‘error’

To Edit a field simply click on the Edit button next to the relevant field which will open a window like when a field is created. However, the only difference is all the data that was set when the field was created is displayed. Clicking the Delete button will display a confirmation message and clicking Yes will delete the field.

Some fields are automatically generated in edison365 Projects to support a Project when created. These are known as System Fields. System Fields can be edited to support full customisation so you can configure them based on your needs. The properties can also be changed for certain fields. However, there are occasions the properties cannot be changed. If so, these config values will be greyed out. System fields cannot be deleted so the Delete button is removed from these fields.

Projects from Project Online can also be surfaced in edison365 Projects if configured using edison365 DataStore. Part of the support for this is to allow a field to be set as an External Field. This can be configured when creating the field by setting the checkbox to the ‘External Field button.

Once a field has been created the External Field setting cannot be changed. When a field is set as an External Field this will enable the data for the field from Project Online to be surfaced in edison365 Projects as read-only.

Back to Home

7. Tables

This area is where all Tables are created. The tables created will be available to be used when creating a form. Below are example tables created.

To create a table, click on the Create Table button and the following window will be displayed.

Click on the Label field and enter a name for the table. Like the Fields section the Internal Name will be set as the name entered minus any spaces automatically.

Existing tables can be copied so the configuration set can be used for other tables. To do this set the name for the new table and click on the Copy from Table dropdown and select a table then click the copy button. The tables displayed in the dropdown will be dependent on the Table Type used. If a Periodic type is selected only Periodic tables will be displayed in the Copy from Table dropdown. Once the copy button is clicked all the rows and configuration such as row widths from the original table will be added to the new table.

If you add text in the Description field, it will be add a new icon to the right of the table and when clicked the text entered will be displayed. This can be used to support why the table is used and what data is required.

Clicking on the Table Type drop down will display a list of available table types. Each table type will display the same fields except Aggregated Totals which will display all Periodic tables. Below is a list of additional fields for each Table Type

  • Periodic – None
    This type of table is used when time phased data is required with the table items
  • Standard – None
    This type of table is used when a list type table is required
  • Task – This table will include the default system fields required on the Task table
    This type of table is used to capture tasks, this includes a timeline view with a Gantt
  • Aggregated Totals – Calculated Rows

This type of table enables data from periodic tables to be calculated.

Once the Name and Table Type has been set the next option to set is assign the fields for the table. If you click on a field in the Available pane a button with an arrow pointing right is displayed. Click on this button and the field selected will be moved to the Selected pane.

For periodic tables you can include more specific configuration:

  • Period Units – The time phasing the table will gather data on. This can be Monthly, Quarterly and Yearly.
  • Default View – When first loaded the table will be displayed in the Periodic or Details based on what is selected.
  • Data Type – This is to specify the type of data the table is used for. You can select Cost, Effort, or Materials. Selecting effort will allow additional configuration for Hours, Days, or FTE’s.

To remove a field, click on the field to remove on the Selected pane which will highlight the button with the left arrow. Click on the button and the field will be moved back to the available pane.

The selected fields order can be updated by using the square drag handle to the left of the field name, use this to drag the field up or down as required.

Each column added to a table can have a specific width set. To do this enter a value (in pixels) in the Min. width field for each column. Once a minimum width is set for a column, ensure to click off of the current row onto another row to commit the change. For Periodic and Aggregated tables, the totals columns can also have a minimum width set. When selected the following fields are displayed.

Standard tables can also have a board view defined, the table will need to have 3 columns / fields added:

  • A choice field
  • The default “Owner” field
  • The “Appear on Person Page” field

The Board view can then be enabled once the choice field has been set in the “Board column field” option and the “Work Item title field” has been set:

The table will then have a Board view option on the project. Table items can also be pushed to the table row Owners personal page using by setting the “Appear on personal page” to Yes for that table row item. The column setting “Personal Page” can be used to control what fields the table row owner can view or edit:

Back to Home

8. Project Buttons

The Project Buttons is where you can create buttons that can be added to a Form which when clicked by a user will open a URL in a new tab. These can be used to allow an external page to be accessed directly from the Project. The buttons will require a name, URL, and an optional icon.

To Create a button, click on the ‘Create Button’ button which will open the following window.

The details entered in the Label field will be displayed as the Button Name which will also automatically set the Internal Name in the same way when a field or table is created. If you include a Description this will be included as a tooltip when the button is added to a form. The final thing to configure the button is to include the URL for the button to use.

If your edison365 Projects instance is linked to an instance of edison365 Project Online DataStore and PWA is configured a set of tokens will be included to use which will allow you to automatically include the links from PWA. If an external project is created and a button uses the tokens when clicked the external project will be opened.

These will be available at the top of the list of Tokens. To view the tokens ensure the switch for ‘Display Available Tokens’ is set to Show.

The remaining tokens are the current field set configured in your edison365 Projects instance.

The final optional configuration is the Icon to display on a button. Before an Icon can be selected ensure the Display Button Icon switch is set to Yes which will display an icon. To change the icon click on the icon displayed

Once clicked the following modal will be displayed where you can select a new icon.

Click on the Icon to use which will close the modal and the new icon will be displayed. Once the configuration is completed click the Save button which will add the new button to the Grid and is now available to be added to a Form. Please note a button cannot be added to a Table.

Back to Home

9. Forms

edison365Projects allows a form template to be created which can be used across all Project types. The form designer used to create a form is broken down in 4 sections: Zones, Fields, Tables, and Buttons.

You can include tabs to a Form to allow the Project to be broken down in sections. You do not have to add any tabs to create a form, but it is down to your business requirements. If you click on the Add Tabbed Zone option in the Zones section, the following is displayed. A maximum of 8 tabs can be included. If a tab is added it will be displayed as follows:

To change the name of a tab click on the cog icon under ‘label’ which will open the Tab Settings and enter the desired name for the tab.

If a tab is no longer needed simply click on the bin icon. Any fields added will also be removed from the form.

If multiple tabs have been added to a Form, they can be rearranged by clicking the right and left arrows.

Before any fields and tables can be added at least 1 zone has to be added to the Form Designer. All zones must have at least 1 field / table added, empty zones are not supported.

The zones are broken down in 5 different formats:

  • One Column Zone
  • Two Column Zone
  • One Third Two Thirds Zone
  • Two Thirds One Third Zone
  • Three Column Zone

When a zone is selected it will be displayed in the Design Surface in a blank format.

The zone order can be changed using the up / down arrows in the zone heading. Once all the Zones required have been added the next thing to do is to add any fields and/or tables to the zones added. Click on the Fields tab on the Form Designer to display all the fields created in the Fields section. These are broken down by the field type (Boolean, Choice, Date, Multi-Level Choice, Number, People Picker, Project Online (if configured) Rich Text, System, Text, or URL).

To add a field or a table to a zone drag and drop the field or table to a zone. Once a field or table is added it cannot be added to another zone on the same form.

Once the zones, fields, and tables have been added to the Design Surface a name will be needed for the form. To add a name, click on the Label field above the Design Surface area and enter a name. Once added the Internal Name field will be automatically populated with the name entered minus any spaces.

Once saved a form can be accessed in the form designer and managed to keep it up to date should any changes be needed. Click on the Load Form Design and all forms created will be displayed.

Single Column Zones can have a header included in them to help grouping of fields. When a single column zone is added to the Form Designer text labelled ‘Set Header’ will be added along with an edit icon.

If you click on the edit icon next to the ‘Set Header’ text a window will open where the header can be set.

When a header has been added close the window and the text entered will replace the ‘Set Header’ text and will be used throughout the form. If the ‘Set Header’ text is not set a header will not be used on the zone.

When a form is selected all the Zones, Fields, and Tables will be loaded in the Design Surface. From the Design Surface all zones and the contents can be deleted, moved up or down in order.

Once a form is completed the following actions can be carried out to manage the form:

  • Save – When a change is made to a Form this will overwrite any previous versions.
  • Save as New – When a change is made to a form and the Label is also changed this will save the Form and keep the previous version.
  • Clear Form – This will remove all Zones, Fields, and Tables from the form.
  • Delete Form – The form will be removed from the available forms.

If a field or table configuration has been updated and that field is used on the form, if those changes are required on the form, access that form and click yes when prompted to include the field changes to the form then Save the form. If the change is then required in the project type, the project type will need to be edited – see the project type section for details.

Back to Home

10. Types

edison365 Projects allows multiple types to create multiple types to support a project for different project requirements. The roles set in each type will also control the permissions to the application for the Admins, Owners, and Readers.

To create a Project type, click on the Create Project Type button which will open the following page (page not displayed in full in screen shot).

To complete the form to create a Project type ensure all mandatory fields are completed. All mandatory fields are marked with a red asterisk. If the form is saved and a mandatory field has no data in it an error will be displayed on the field when saved.

Documents can be included as a default attachment for a project type when a new project is created for the type. This is achieved by using the document explorer which opens the file explorer. To delete any attached documents, click the Delete button next to the correct attachment

When all the core details have been added the users can be assigned to specific roles for the Project type (Process Managers, Owners, and Readers).

To add a user, enter the name required and once three characters have been entered a search will take place and any matches based on the criteria entered.

Once the username has been found, select the correct match then click the name to add the user to the role.

The next config options are to support Version creation on a Stage Change (Project Status). If enabled when the Project Status is changed a new version of the project will be created automatically.

Projects can be created from an external source. Currently a project can be created from Project Online, and Microsoft Project. To enable this for the type ensure the External Project check box is ticked and then click on the External Data Source dropdown to select the source for the creation of the project. To create a project from Project Online the Projects section will need to be configured and enabled. To create a project from Microsoft Project a Microsoft Project license will be required.

The Project Type can also have the Year Start set so each Project has the correct start month label on Monthly period tables.

The format of the Quarters can be set as Q%q %yy which will display as Q1 20 or Q%q %yyyy as Q1 2020. If you enter anything other than this the value will not be allowed and an error will occur. This controls the Quarters label on Quarterly period tables.

Projects can also have stages configured to allow various members of the project team to review the various stages and approve or reject the stage of the project. By default, this will be disabled at type level.

Once the Stages functionality has been enabled on the type level an additional set of fields will be added to allow you to create and maintain new and existing stages.

Once enabled a new section will be added where you can enter the details for your stages with one default stage added.

To add a new stage, you will need to click on the Add Stage button which will add a blank stage below the previous stage. Each stage needs the following info to be fully configured:

  • Name: Stage Name displayed in the progress bar.
  • Description: A brief description of any additional information for the stage.
  • Status: If set to Open the project will need actioning by the Process Manager. If set to Under Review a new set of fields will be generated to set the Reviewers and Tasks to be completed for the stage.
Colour: The background colour of the Stage displayed on the Project card.

 

To add a reviewer, click on the Reviewers box and enter the individual names of the required reviewers and a people picker will display the matching names to select. Once the reviewers are added the Tasks for each reviewer will need to be added. To add a task, click on the Reviewer Tasks text box and enter the name of a task and click the Add Task button which will add the task to a list of tasks.

When the Next button is clicked after the Details are completed a blank form is displayed in the same way as the Forms section (section 7) minus the Zones, Fields, and Tables selectors.

To select the form to use click on the Load Form Design drop down to display a list of all the current form designs. When selected the form template will be displayed.

In the same way a document can be attached as default to any new projects for the project type, the form can also have default data included. If you add data to any field or table on the form when creating or editing a project type the data will be included on all new projects created from that type.

If data is added as default data to a form the configuration settings for the field will still be applied so it can still be set required if needed.

From here you can select whether you tailor the form by selecting whether a Zone or Field (or a tab if added) is set as required. To do this click on the cog icon for the area you wish to apply the settings to. When the cog icon is clicked the windows will look as follows:

There is a switch with a Yes/No option for Required, Read Only, and Visible and depending on the selection will affect the behaviour of the zone, tab or field.

Please note, should a change be made to a Form (new or updated field / table) the changes will need to be accepted on the Project Type before they can be used by users. When a change is made to a Form, access the type and the following message will be displayed:

Clicking ‘Yes’ will accept the changes for the type and the form will be updated with the updated version of the Field, Table, or Form.

Back to Home

11. News

edison365 Projects allows News items to be created and displayed on the Home page of the Projects Module.

To create a news item, click on the Create News Item button which will open the following window

To complete the creation of the news item all mandatory fields (marked with a red asterisk) must be completed. The fields in the form are as follows:

  • Heading* - The name for the news item to be displayed on the Home page.
  • Image* - The Image used when viewing the news item on the Home page.
  • Image Alt Text – The text used to summarise the image used.
  • Summary Text – The main details of the news item.
  • Read More URL – If more information is available and accessible via a URL, the URL can be added here.
  • Read More text – This is the text that will be used on the Read More button of a News item.
  • Display Order* – This is the order the news item will be placed on the news carousel of the Home page.

If no News Items are created the default edison365 news will be displayed on the News carousel of the Home page. If at least one news item has been created the default edison365 news can be toggled on and off to be displayed. This can be achieved by adding (to enable) or removing (to disable) the edison365 news.

To edit a news item, click on the Edit button which will display the news item in the Edit News Item window with the data set when creating the News item pre-populated.

To delete the news item, click on the Delete button and confirm the deletion and the news item will be removed from the list and the carousel of the Home page.

Back to Home

12. Themes

edison365 Projects allows the customisation of the application. Allowing the colour scheme, logos, and footer text used to suit the business requirements.

The Header and Banner images can be uploaded using the image uploader and cropping tool. Once uploaded and saved the images used will be saved to the site collection under the paths set below the images.

Logo image should be 385px (width) x 90px (height), or an image with this aspect ratio.

The colour palette options will change the colour of each area listed in the colour picker to ensure the colours used matches any branding.

The text used in the footer area is what will be displayed at the bottom of each page in the Projects application.

Back to Home

13. Notifications 

edison365 Projects allows notifications to be sent to users once a specific action has taken place. To access the Notifications configuration screen, click on the Notifications tile from the Admin Console. Once accessed the default enabled option will be ‘No’ and the configuration fields will be hidden. When enabled the following will be displayed:

From here you can set the URL for the banner image used in the emails, the banner colour, the language used via a dropdown – this is not saved but is used for preview as emails will be sent based on the language the user sets in the application, and the email signature as well as a Show Learn More switch which if enabled will take users to the edison365 website.

The email signature field is a rich text field which includes text formatting options to add full customisation to the signature.

Once happy with the configuration click the Save button and this configuration will be used on all email notifications. If you have made changes and no longer wish to use them click the Reset Settings button to revert to the default settings. To ensure you are happy with the configuration set you can view how the emails will be displayed by clicking on the Email Preview button. From here you can use the dropdown to view how each template will look.

Back to Home

14. Projects

Projects from Project Online can be surfaced into edison365 Projects via edison365 DataStore. Configuring the Project Online Connection settings allows this. If a Project Type is configured to be an External Project Type, it will allow a user to select a Project Online Project to be surfaced in edison365 Projects. Once accessed the following is displayed:

The Project Online URL will need to be the URL to access your instance of Project Online.

The following will need to match the same as set in edison365 DataStore:

  • Server Address
  • Server Port
  • Database Name
  • Database Account
  • Password

Should any of these not match what is used in edison365 DataStore the link cannot be fully established and updates between Project Online and edison365 Projects will not take place.

A configuration option to enable automatic background refreshes can also be used. Simply tick the Enable background data refresh button and use the Hours and Minute dropdowns to select when the refresh takes place. The minutes are in 15 minute intervals. Please note the time set is set as UTC.

Back to Home

15. Projects Link- Business Case Integration

edison365 products can be linked together. edison365ideas can be linked to edison365businesscase and or edison365 Projects, and edison365businesscase can be linked to edison365 Projects. This allows an idea from a user to become a business case or project, and a business case a project. This makes the process from idea to project streamlined when you have a licence for all 3 modules.

To configure a link from Business Case to Projects you will need to enter a password in the Product Link Password field in edison365 Projects in the screen as above. Once the password has been entered click on the Generate Token button. Once that is clicked a window will open with a token value:

Once the token has been generated you will have to copy the token by clicking the button to the right of the token (highlighted in image above). Now it is copied you can access edison365businesscase and use that token and password to link the products together by pasting the token in the Token field and the same password used to generate the token in the Product Link Password. Once both details have been added click the Link to Products button which will then link the two products.

Back to Home

16. Teams

Projects can be linked to a Team in Microsoft Teams. Once linked the Projects can be viewed and managed in Teams. To enable this feature click on the Teams tile on the Admin Console which will display the following screen:

By default, the feature will be disabled and will look like the above screenshot. To enable the feature click on the ‘Teams Enabled’ switch and ensure one of the ‘Team Creation Enabled’ or ‘Team Association Enabled’ Boolean fields also must be enabled. If one of these are not enabled an error will be displayed.

A quick summary of each field is as follows:

  • Teams Enabled – This is the master switch to enable the whole feature. Until this is enabled the other 2 features cannot change.
  • Team Creation Enabled – Once enabled users will be able to create new Teams for Microsoft Teams to link their project with.
  • Teams Association Enabled – Once enabled users will be able to link their project to any Team, they are a member of in Microsoft Teams.

Once the required configuration has been set click on the Save button and depending on the configuration options enabled the users will be able to link a project to a Team.

To make use of this feature one of the Office 365 tenant administrators will have to first access the following link to authorize the edison365 application in Azure AD if they haven’t done so already for another edison365 product:

https://login.microsoftonline.com/common/adminconsent?client_id=1268dd20-fb8a-47b5-b781-736bde942005&redirect_uri=https://www.edison365.com/appregsuccess

Once this link is clicked and access is granted to the edison365 Azure AD Application, this will allow edison365 Projects and Microsoft Teams to work together to on your tenant.

Back to Home

17. Yammer (now Viva Engage)

Projects can be linked to a Yammer channel on your network to allow users to discuss the Project. This must be enabled at a global level before this can be enabled on a Project Type and Project level. To do this click on the Yammer tile on the Admin Console. Once accessed the following page will be displayed:

Once the settings have been Enabled as above you need to add your network name that you login to Yammer with in the Yammer Network field. Once saved a Type can now have a Yammer channel assigned to it to start discussions.

Back to Home

18. Reports

Reports can be accessed directly through the edison365 Projects UI. Multiple reports can be configured to allow ease of access to your reports to support your project needs. To access the configuration, click on the Reports tile on the Admin Console which will take you to the below grid.

The grid will show all the reports configured including a name, Url (hidden in the above example), the order, and whether accessing the report will be in a new tab.

To configure a new report enter a name in the Title field, the URL of the report in the Link field, if you require the report to be placed in a specific place set the Order (All reports will be set at 0 and placed in order of creation unless stated), the final option is to set whether the report will open in a new tab or not by adding a tick in the Open in New Tab field to open the report in a new tab.

Once the Report information is configured click the Add button which will add the Report to the Reports grid.

To view a report, hover the cursor over the Reports option on the navigation bar which will display the list of reports. Then click on the Report listed to view it in full.

Back to Home

19. Customer Information

The Customer Info page will be used after the edison365 Projects instance is first deployed and installed by edison365. This is where you can capture and store information such as your company information, and information from edison365 such as contact details. This will be provided by edison365 when first deployed.

Back to Home