KeyedIn Projects 5.3 Analytics Dashboard User Guide
Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
1 of 11
User Guide
Contents 1. 2. 3.
4. 5. 6.
Introduction ............................................................................................................. 3 What You Need to Know ............................................................................................ 3 Analytics Tab ........................................................................................................... 4 3.1 Activating the Analytics tab ..................................................................... 4 3.2 Configuring the Analytics tab ................................................................... 4 3.3 Set the Analytics tab as the Default Start Page .......................................... 5 Project Analytics Tab ................................................................................................. 5 4.1 Activating and Configuring the Project Analytics tab ................................... 5 Widget Features ....................................................................................................... 6 Adding New Widgets ................................................................................................. 7 6.1 General Tab .......................................................................................... 7 6.2 Definition Tab........................................................................................ 7
6.3 Assigning Widgets to the Analytics tab ................................................... 10 6.4 Assigning Widgets to the Project Analytics tab ......................................... 10 Edit an Existing Widget ........................................................................................... 10 Upload a Widget Package File ................................................................................... 11
Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
2 of 11
User Guide
1. Introduction The 5.3 release introduces the new Analytics Dashboard that allows you to get better visibility of your data. The new dashboards leverage the existing functionality of the KeyedIn Projects report writer, allowing you to create your own widgets in a graphical or tabular format.
2. What You Need to Know
The dashboard can be configured to appear standalone on the Analytics tab to give you analysis across a portfolio of projects or a group of resources. In addition to this, you can also configure the Analytics tab to appear on the Project tab to provide analysis of an individual project (lowest level projects only). The maximum number of widgets permitted per dashboard is 6. You can create different dashboard configurations based on the type of user. For example, you can configure a dashboard for a project manager and another for a resource manager with different layouts and a different set of widgets. You can create your own widgets using the KeyedIn Projects report writer. You can create chart widgets as well as tabular, column and cross-tab data reports. Widget data is cached to improve performance. When creating a widget you need to specify when the cache is refreshed. Options include hourly\daily\weekly and monthly. There is also an option to manually refresh the cache.
Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
3 of 11
User Guide
3. Analytics Tab 3.1 Activating the Analytics tab Before activating the Analytics tab, you need to decide which login groups will be allowed access. To activate: 1. Navigate to the Login Group search from the Admin tab 2. Edit the Login Group you want to give access 3. On the Dashboards tab click the Add button and select Analytics from the available options 4. Save the Login Group 5. Logout of the system and log back in for the system to be refreshed
3.2 Configuring the Analytics tab To configure the Analytics tab: 1. Navigate to the Analytics application tab 2. Click on the screen.
icon on the top right hand side of the screen to display the configuration
Tip: If you can’t see the icon, your login profile requires the Ability to set System Defaults setting to be enabled.
3. On the Configuration screen you can: a) Choose the required layout b) On the Available Widgets section, drag the widgets onto the dashboard layout c) Add new widgets by clicking the Add Widget button d) Click the Save button to save the configuration.
Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
4 of 11
User Guide
Tip: You can only configure the Analytics tab for your login group. To configure for another login group, you will need to change the login group against your login to the login group you want to configure.
3.3 Set the Analytics tab as the Default Start Page To make the Analytics tab the first screen to be displayed after a user logs in: 1. 2. 3. 4.
Navigate to the Login search from the Admin tab Edit the Login you want to set the default start page for In the Startup Page dropdown, select the Analytics option Save the Login
4. Project Analytics Tab 4.1 Activating and Configuring the Project Analytics tab To activate the Project Analytics tab: 1. Navigate to the Project application tab 2. Click on the icon on the top right hand side of the screen to display the configuration screen. Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
5 of 11
User Guide
3. On the configuration screen, tick the Show Analytics Tab checkbox. The analytics configurator will appear below the check box where the user can configure the layout (See 4.2).
5. Widget Features For each widget you can click: 1.
to refresh the data and ensure it is up-to-date. This option is only available for widgets set to Allow Manual Refresh.
2.
to see when the data was last refreshed and is next due to be refreshed. Each widget may have its data refreshed automatically through its definition and you can choose to refresh it now if required. You can also view the description of the widget entered on its definition.
3.
to collapse the widget; click
to expand again when needed
4.
to open the content in a new window so you can view and print it.
Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
6 of 11
User Guide
6. Adding New Widgets New widgets can be created on the Reports application tab or on the Analytics\Project Analytics dashboard configuration screen. To create a new widget on the Reports tab: 1. Click on the Reports application tab 2. Click on the Create Report link Follow the steps below to create a widget:
6.1 General Tab On the General tab: 1. Enter the Name of the widget 2. Enter the Title of the widget 3. Enter the Description of the widget, which can be viewed on the widget by clicking on the icon.
6.2 Definition Tab On the Definition tab: 4. Select the Data view you want to create the widget from 5. Select the Report Type. The available options are:
Tabular – Data widget where the data is displayed in a tabular format Example: Project Code PROJ001 PROJ001
Project Name Timesheet Date Project 1 01/02/2013 Project 1 01/09/2013
Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
Hours 8 8
7 of 11
User Guide
Cross-Tabular – Data widget where data can be cross-tabbed and displayed in a tabular format. Example: Project Code PROJ001
01/09/2013 8
Column – Data widget where the data is displayed in a column format Example: Project Code: Project Name: Timesheet Date: Hours:
Project Name 01/02/2013 Project 1 8
PROJ001 Project 1 01/02/2013 8
Chart – The following chart widgets can be created: i) ii) iii) iv)
Area Area Stacked Bar Horizontal Bar
v) vi) vii) viii)
Stacked Bar Horizontal Stacked Bar Line Pie
6. Select the Widget option in the Usage Type dropdown
6.2.1 Definition – Fields Tab On the Fields tab: 7. Select the fields you want to include in the widget. If you want to change the name of the field, enter the new name in the Display Name text box. 8. For drill-through capability, tick the Drill Through option against the field you want to drill into. Then select which screen you want to drill into in the Drill Through To dropdown. If you want to drill into a project, you have the option to go to the Edit Page or Dashboard (Project tab). For all other drill through fields, you have the option to go to the Edit Page.
6.2.2 Definition – Calculated Fields Tab To add a calculated field: 9. Click on the Add To List button 10. Click on the button to load the Expression Builder 11. Enter the expression in the Expression Builder. To use a field in a calculation, it must be selected on the Fields tab. If you don’t want the field to appear on the widget, select the Hidden option against the field on the Fields tab
Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
8 of 11
User Guide
6.2.3 Definition – Order Tab On the Order tab: 12. For data widgets, select the order in which you want the fields to appear 13. Select the order in which you want to sort the data by
6.2.4 Definition – Grouping Tab On the Grouping tab: 14. Select the fields you want to group the data by 15. Select the total fields
6.2.5 Definition – Chart Tab For chart widgets: 16. Select the type of chart you want to display 17. Select the Series, Category and Values. Tip: If you want to compare 2 different fields (e.g. planned vs actuals) on a chart widget, leave the Series field blank and the select the 2 fields in the Values field.
6.2.6 Definition – Widget tab On the Widget tab: 18. Select the Refresh Intervals. You can get the widget to refresh:
Hourly – the widget will refresh every hour Daily – the widget will refresh at the start of every day Weekly – select the day of the week you want the widget to refresh Monthly – the widget will refresh on the first day of each calendar month
If you access an edit page from a widget using the drill through feature and save the data, the widget data will automatically refresh. Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
9 of 11
User Guide
19. Tick the Allow Manual Refresh checkbox on the Widget tab if you want to allow users to refresh the widget by clicking on the icon on the widget
6.2.7 Definition - Filter tab On the Filter tab: 20. Select the fields you want the filter by and enter the values you want to filter each field by in the text box to the right. Select the and buttons to help you specify the filter values. Please be aware that you cannot change the filter fields or filter values when running the widget. The widget automatically uses the filter values specified against each filter field. Tip: When creating widgets to be displayed on the Project Analytics tab, you should select a Project Code filter and set the filter value to be #CONTEXT-PROJECTCODE#. This means that the widget will always return data for the current selected project on the Project tab.
6.3 Assigning Widgets to the Analytics tab To make a widget available for selection on the Analytics tab: 1. Select the Dashboards tab 2. Click on the Add button and select the Analytics option
6.4 Assigning Widgets to the Project Analytics tab To make a widget available for selection on the Analytics tab: 1. Select the Dashboards tab 2. Click on the Add button and select the Project option
7. Edit an Existing Widget To edit an existing widget: 1. Click on the Reports application tab 2. Enter the name of the widget and press the Search button 3. Click on the icon against the widget you want to edit Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
10 of 11
User Guide
8. Upload a Widget Package File To upload a widget package file: 1. Click on the Reports application tab 2. Click on the Upload Report Package File link. The Upload Report Package screen will be displayed. 3. Click on the Browse button and choose the package file to upload. 4. Click the Upload link 5. On the Login Groups tab, select the login groups you want to make the widget available to 6. Click the Load button
Phone (US) p +1 866 662 6820 (UK) p +44 1274 863300
