contract risk management 8 · 2020. 6. 18. · aveva.com aveva™ embedded dashboards and widgets...

aveva.com

AVEVA™ Embedded Dashboards and Widgets

Contract Risk Management 8.0

June 2020

© 2020 AVEVA Group plc and its subsidiaries. All rights reserved.

No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.

Although precaution has been taken in the preparation of this documentation, AVEVA assumes no responsibility for errors or omissions. The information in this documentation is subject to change without notice and does not represent a commitment on the part of AVEVA. The software described in this documentation is furnished under a license agreement. This software may be used or copied only in accordance with the terms of such license agreement.

ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, IntelaTrac, InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo, SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at: https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.

Publication date: Wednesday, June 17, 2020

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.

Chapter 1 Dashboard Maintenance ............................................................................................. 5

Business Unit Dashboard Templates ............................................................................................... 6

Contract Dashboard Templates ...................................................................................................... 9

Widget Templates ........................................................................................................................ 13

Chapter 2 Widget Dashboards ................................................................................................... 15

Viewing Widget Dashboards......................................................................................................... 15

Adding Standard Widget Dashboards ........................................................................................... 16

Adding Personal Dashboards ........................................................................................................ 16

Editing Personal Widget Dashboard Details .................................................................................. 18

Configuring Personal Widget Dashboards ..................................................................................... 18

Deleting Widget Dashboards ........................................................................................................ 19

Chapter 3 The Contract Dashboard ............................................................................................ 21

Chapter 4 Reference: Widgets ................................................................................................... 27

Widget Types ............................................................................................................................... 27 Table Widgets ........................................................................................................................... 28 Slicer Widgets ........................................................................................................................... 35 Card Widgets ............................................................................................................................ 37 Bar Chart Widgets ..................................................................................................................... 40 Line Chart Widgets .................................................................................................................... 47 Pie Chart Widgets ...................................................................................................................... 51 Stacked Bar Chart Widgets ......................................................................................................... 58 Stacked Bar With Limit Chart Widgets......................................................................................... 61 Historical Data Widgets ............................................................................................................. 66 Trend Widgets........................................................................................................................... 70 Text Widgets ............................................................................................................................. 75

Specifying URLs ............................................................................................................................ 76

Contents


Configuring the Detail View .......................................................................................................... 79

Configuring Widgets to Broadcast and Receive Filters ................................................................... 79

Accessing Analytics from External Applications ............................................................................. 81

Data Models and Columns............................................................................................................ 83 Contracts .................................................................................................................................. 83 Breakdown Items ...................................................................................................................... 90 Contract Line Items ................................................................................................................... 94 Communications ....................................................................................................................... 99 Communication Reviews.......................................................................................................... 107 Communication Line Items....................................................................................................... 111 Contract Obligations ................................................................................................................ 116 Tenders .................................................................................................................................. 118 Schedule Items........................................................................................................................ 121 Tender Reviews ....................................................................................................................... 123 Stage Gates ............................................................................................................................. 125

Dashboard Examples .................................................................................................................. 128

Troubleshooting Dashboard Widgets .......................................................................................... 147


AVEVA Contract Risk Management manages a large amount of information relating to contractual risk, but this information is often only accessible to users accessing contracts on a regular basis. The dashboards functionality uses AVEVA Contract Risk Management Analytics and OData 4.0 APIs to surface this information and display it in a variety of easy-to-read table and chart widgets.

Dashboard templates can be created in AVEVA Contract Risk Management using a variety of configurable widgets to display the data in tables and charts in Business Unit and Contract level dashboards. See Reference: Widgets on page 27 for full details of the available types of widgets.

The OData APIs used by the widgets can also be consumed by third-party Business Intelligence products such as Microsoft PowerBI.

Note AVEVA Contract Risk Management Analytics must be installed on the system where widget dashboards will

be used.

Dashboard widgets are created from widget templates which are added and deployed in the Administration portal. See Widget Templates on page 13.

Users can only see data for the business unit to which they belong, even if they have access to all business units. To access data across all business units, the user must have the Analytics API Access Across Business Units permission and use a third-party reporting application such as Power BI.

Dashboard Types

Data Type Created By Information

Business Unit

Standard Administrator Created as a dashboard template in the Admin portal.

Can be published as read-only standard dashboards to all users with the Analytics API Access user role permission.

Users can manually add unpublished dashboard templates to their Widget Dashboards area as standard dashboards.

Users can copy a standard dashboard in their Widget Dashboards area as a new personal dashboard, which they can then configure as required.

See Business Unit Dashboard Templates on page 6.

Business Unit

Personal Users with the Analytics API Access user role permission

Created in the Widget Dashboards area of the Company Portal.

CHAPTER 1

Dashboard Maintenance

AVEVA™ Contract Risk Management 8.0 Chapter 1 – Dashboard Maintenance

Page 6 © Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.

Users can copy a standard or personal dashboard in their Widget Dashboards area as a new personal dashboard, which they can then configure as required.

See Widget Dashboards on page 15.

Contract Standard Administrator Created as a dashboard template in the Admin portal.

Users can manually add dashboard templates to their Contract Dashboard as standard dashboards.

Users can copy a standard dashboard on their Contract Dashboard as a new personal dashboard, which they can then configure as required.

See Contract Dashboard Templates on page 9.

Contract Personal Users with the following contract roles:

Contract Owner

Contract Administrator

Company Representative

Contract Budget Holder

Contract Auditor

Created in the Contract Dashboard.

Users can share a personal dashboard so that other users can add it to their Contract Dashboard.

Users can copy a standard, shared or personal dashboard on their Contract Dashboard as a new personal dashboard, which they can then configure as required.

See The Contract Dashboard on page 21.

Business Unit Dashboard Templates Business Unit level dashboards are available to company users who have the Analytics API Access permission.

Business Unit level dashboard templates can be automatically published by the administrator to appear in the Widget Dashboards area for all users as read-only standard dashboards. They can also be added manually by the user either as standard dashboards (see Adding Standard Widget Dashboards on page 16) or as copies of the templates which can then be configured as personal dashboards (see Adding Personal Dashboards on page 16).

Any changes made by an Administrator to a Business Unit dashboard template will be reflected in the users' standard dashboards once the template has been published.


Warning The administrator creating and configuring dashboard templates must be assigned to a Business Unit for any data to appear in the configured widgets. They will then see data from that Business Unit in the widgets.


Page 7


Viewing Business Unit Dashboard Templates

To view a list of business unit dashboard templates configured for the AVEVA Contract Risk Management system:

1. Click the Dashboard Maintenance tab on the Main Menu and select Business Unit Dashboard Templates.

The Business Unit Dashboard Templates page is displayed.

The number of users who have chosen to display the dashboard template as a standard dashboard or to whom the dashboard template has been published is shown for each template.

Creating Business Unit Dashboard Templates


To add a new business unit dashboard template:

1. Click the Dashboard Maintenance tab on the Main Menu and select Business Unit Dashboard Templates.

The Business Unit Dashboard Templates page is displayed.

2. Click Add.

The Add Dashboard Template page is displayed.

3. Enter a Title and Description for the dashboard.

The Title is the name shown on the dashboard tab in the Widget Dashboards area.

4. Click Save.

A new, empty dashboard tab is displayed.

Note The dashboard template is now available for users to copy or add manually.

You can also add it automatically for all users by publishing it. See Publishing Business Unit Dashboard Templates for more information.

It is recommended that widgets are added to the dashboard before it is published.

To add a widget to your dashboard:

1. Click the drop-down arrow on the dashboard tab and select Add Widget.

The Add Widget window is displayed.

2. Click the name of the widget type you want to add to the dashboard. Widget types are defined by the Administrator.

The dashboard is refreshed to show the new widget ready for configuration.

Tip You can drag the widget to a different location on the page, e.g. to a different column, and to above or below existing widgets. You can also resize the widget by dragging the edges to change the height or width.

3. Enter information as required in the relevant fields.

See Reference: Widgets on page 27 for full details of how to configure the data shown in widgets.

Note Fields marked with an asterisk are mandatory.

4. Click Save.



The widget is updated. Any changes are automatically deployed.

Repeat this step to add multiple widgets to a dashboard. A maximum of 15 widgets can be displayed per dashboard.

Editing Business Unit Dashboard Template Details

To edit the details of a business unit dashboard template:

1. On the Business Unit Dashboard Templates page, click Edit for the dashboard template for which you want to update the details.

The Edit Dashboard Template page is displayed.

2. Alternatively, click Configure for the dashboard template you want to update. On the dashboard tab,

click the drop-down arrow and select Edit to display the Edit Dashboard window.



4. Click Save to update the dashboard template details. Any changes are automatically deployed to users' standard dashboards.

Configuring Business Unit Dashboard Templates


Note A maximum of 15 widgets can be displayed per dashboard.

To update the configuration of a business unit dashboard template:

1. On the Business Unit Dashboard Templates page, click Configure for the dashboard template you want to configure.

The dashboard tab is displayed, showing any widgets have been previously added.

To add a widget to your dashboard template:




3. The dashboard is refreshed to show the new widget ready for configuration.





5. Click Save.



Page 9



To edit an existing widget:

1. Click Edit on the title bar of the widget to open its properties.




3. Click Save.


To remove a widget:

1. Click Delete for the widget you want to remove.

A confirmation message is displayed.

2. Click OK to permanently remove the widget from the dashboard.


Publishing Business Unit Dashboard Templates

If a Business Unit level dashboard template is published, it is automatically displayed as a read-only standard dashboard for all users who can view the Widget Dashboards area of the Company Portal. They can remove it from their visible dashboards if they do not wish to see it.

A Business Unit level dashboard template does not need to be published for users to be able to add it manually as a standard dashboard.

To publish a Business Unit dashboard template:

1. On the Business Unit Dashboard Templates page, click Publish for the dashboard template you want to publish to all users with the Analytics API Access permission.


2. Click OK to publish the dashboard template. It is now visible from the Widget Dashboards area of the Company Portal for all users who can view it.

Deleting Business Unit Dashboard Templates

Warning A dashboard template can be deleted even if it is in use.

To delete a business unit dashboard template:

1. On the Business Unit Dashboard Templates page, click Delete for the dashboard template you want to delete.


2. Click OK to delete the dashboard template.

Contract Dashboard Templates Contract level dashboards are available to company users with the appropriate company roles (see The Contract Dashboard on page 21).



Users can add the dashboard templates as read-only standard dashboards to their Contract Dashboards. They can also make copies of standard dashboards to personalise them - changes made to the dashboard template do not affect the personal copies.

You can set a default standard dashboard, which will always be automatically available to all users who have access to a Contract Dashboard.


Viewing Contract Dashboard Templates

To view a list of contract dashboard templates configured for the AVEVA Contract Risk Management system:

1. Click the Dashboard Maintenance tab on the Main Menu and select Contract Dashboard Templates.

The Contract Dashboard Templates page is displayed.

Creating Contract Dashboard Templates


To add a new contract dashboard template:

1. Click the Dashboard Maintenance tab on the Main Menu and select Contract Dashboard Templates.

The Contract Dashboard Templates page is displayed.

2. Click Add.

The Add Dashboard Template page is displayed.


The Title is the name shown in the drop-down list of available dashboards on the Contract Dashboard.

4. Click Save.


Note The dashboard template is now available for users to copy or add manually.


1. Click the Actions button on the dashboard and select Add Widget.

2. The Add Widget window is displayed.








Page 11


5. Click Save.



Editing Contract Dashboard Template Details

To edit the details of a contract dashboard template:

1. On the Contract Dashboard Templates page, click Edit for the dashboard template for which you want to update the details.

The Edit Dashboard Template page is displayed.

Alternatively, click Configure for the dashboard template you want to update. On the dashboard tab,

click the drop-down arrow and select Edit to display the Edit Dashboard window.


The Title is the name shown in the drop-down list of available dashboards on the Contract Dashboard.

3. Click Save to update the dashboard template details. Any changes are automatically deployed to users' standard dashboards.

Configuring Contract Dashboard Templates



To update the configuration of a contract dashboard template:

1. On the Contract Dashboard Templates page, click Configure for the dashboard template you want to configure.


To add a widget to your dashboard template:









4. Click Save.

5. The widget is updated. Any changes are automatically deployed.






Enter information as required in the relevant fields.

2. See Reference: Widgets on page 27 for full details of how to configure the data shown in widgets.


3. Click Save.


To remove a widget:





Setting the Default Contract Dashboard

Optionally, any one of contract dashboard templates can be set as the default contract dashboard. This is visible as a read-only standard dashboard to all users who have access to the Contract Dashboard page.

To set the default contract dashboard :

1. On the Contract Dashboard Templates page, click the toggle for the dashboard template you want to make the default.


2. Click OK to set the default dashboard.

The toggle now shows as on for the dashboard:

The dashboard is now visible on the Contract Dashboard page as a read-only standard dashboard.

To clear the default contract dashboard :

1. On the Contract Dashboard Templates page, click the toggle for the dashboard template you want to stop being the default.

Alternatively, click the toggle for the dashboard template you want to make the new default.


2. Click OK to set the default dashboard.

The toggle now shows as off for the dashboard which was previously the default:

This dashboard is now no longer visible on the Contract Dashboard page except for users who had already added it as a standard dashboard.

Deleting Contract Dashboard Templates

Warning A dashboard template can be deleted even if it is in use.


Page 13


To delete a contract dashboard template:

1. On the Contract Dashboard Templates page, click Delete for the dashboard template you want to delete.


2. Click OK to delete the dashboard template.

Widget Templates Dashboards consist of a number of widgets such as charts and tables, each of which can use a different set of data. The widget templates from which these are created are defined in the Admin portal and must be deployed before they can be used in dashboards.

Adding Widget Templates

To add a new widget template:

1. Click the Dashboard Maintenance tab on the Main Menu and select Widgets.

The Widgets page is displayed.

2. Click Add.

The Add Widget page is displayed.

3. Enter the Widget Name and an optional Description.

4. Select the Widget Category from the drop-down list.

5. Click Save.

The Widgets page is displayed, with the new widget template.

Note The widget template must be deployed before widgets can be added from it for use in a dashboard. See Deploying Widget Versions below.

Editing Widgets

To edit a widget template:



2. Click Edit for the widget template you want to edit.

The Edit Widget page is displayed.

3. Edit the information as required in the relevant fields.

4. Click Save.


Deploying Widget Versions

Widget templates must be deployed before they can be used to create dashboard widgets. To do this, the location of the most recent assembly file (DLL) for the widget type must be specified.

The widget template must also be redeployed if an update to the assembly file is issued.



To deploy a widget template:



Tip The Widget Version column shows the version of the assembly file with which the widget template is currently deployed. If this column is blank, the widget template has never been deployed and cannot be used to create dashboard widgets.

2. Click Deploy for the widget template you want to make available or update the assembly file for.

The Deploy Widget page is displayed.

3. Click Browse to locate the current assembly file for the widget, e.g. EightOverEight.Presentation.Widgets.TableWidget.dll for a table widget.

4. Click Save.

Note If the assembly file you have selected is the same as the file currently specified for the widget, an error message is displayed. Browse for a different file, or click Cancel.

The Widgets page is displayed. The Widget Version is updated for the widget template you have deployed or redeployed.

Deleting Widget Templates

Warning Widget templates can be deleted at any time. Any widgets created from them will be deleted from

dashboards.

To delete a widget template:



2. Click Delete for the widget template you want to delete.


3. Click OK.

The widget template is deleted, and any dashboard widgets created from it are also deleted.


AVEVA Contract Risk Management manages a large amount of information relating to contractual risk, but this information is often only accessible to users accessing contracts on a regular basis. The dashboards functionality uses AVEVA Contract Risk Management Analytics and OData 4.0 APIs to surface this information and display it in a variety of easy-to-read table and chart widgets at Business Unit and contract level. The Widgets Dashboard area displays the Business Unit dashboards.

The OData APIs used by the AVEVA Contract Risk Management widgets can also be consumed by third-party Business Intelligence products such as Microsoft PowerBI.

Widgets are created from widget templates which are added and deployed in the Administration portal. See Widget Templates on page 13.

Note AVEVA Contract Risk Management Analytics must be installed on the AVEVA Contract Risk Management

system where widget dashboards will be used.

Dashboard templates can be created in AVEVA Contract Risk Management, using a variety of configurable widgets, to display the data in tables and charts in Business Unit and Contract level dashboards. See Reference: Widgets on page 27 for full details of the available types of widgets.

Business Unit level dashboard templates are created in the Administration portal and can be published so that they are visible as read-only standard dashboards for all users with the Analytics API Access user role permission. Users with this permission can also create personal dashboards in the Widget Dashboards area by manually creating a dashboard or by copying a standard or personal dashboard and configuring it as required.


See The Contract Dashboard on page 21 for more information about contract-level dashboards.

Watch a demonstration video: Setting Up a Reporting Dashboard (https://youtu.be/KsQHh6KlfZ8)

Viewing Widget Dashboards Only users with the Analytics API Access user role permission can view the Widget Dashboards area in the AVEVA Contract Risk Management Company Portal.

Only the data for the business unit to which the user belongs is displayed, even if they have access to all business units. To access data across all business units, the user must have the Analytics API Access Across Business Units permission and use a third-party reporting application such as Power BI.

To view the Widgets dashboards:

1. Open the navigation bar. If necessary, click the My Work tab.

2. From the User Dashboards menu, select Widget Dashboards.

3. The Widgets page is displayed, showing a tab for each dashboard you have previously added:

CHAPTER 2

Widget Dashboards

https://youtu.be/KsQHh6KlfZ8

AVEVA™ Contract Risk Management 8.0 Chapter 2 – Widget Dashboards


o Standard dashboards created by a Administrator

o Personal dashboards

4. Click a dashboard tab to view the widgets included on that dashboard.

From the Widgets page you can:

Add new dashboards - see Adding Standard Widget Dashboards on page 16 and Adding Personal Dashboards on page 16.

Copy a dashboard to create a new personal dashboard - see Adding Personal Dashboards on page 16.

Use options on the drop-down menu for the current dashboard tab to:

o Add widgets (personal dashboards only) - see Configuring Personal Widget Dashboards on page 18.

o Edit the dashboard (personal dashboards only) - see Editing Personal Widget Dashboard Details on page 18.

o Refresh the data on the dashboard.

o Delete the dashboard; for a standard dashboard, this removes it from the Widgets area, but does not delete the dashboard from the system.

Click the Minimise and Restore buttons on the title bar of a widget to hide and show its contents.

Adding Standard Widget Dashboards Standard dashboards are created and configured as dashboard templates by a Administrator. These read-only dashboards display any data in your Business Unit to which you have access. You cannot edit the widgets, but you can click into them to display further information. Changes made to the dashboard by an administrator will be shown automatically when the dashboard is next refreshed.

If a dashboard is published by the administrator, it appears automatically in your Widgets area. If the dashboard has not been published, it can be added manually.

You can copy a standard dashboard which appears in your Widgets area, to modify it for your own needs. See Adding Personal Dashboards on page 16.

To add a new standard dashboard:



The Widgets page is displayed, showing a tab for each dashboard you have previously added.

3. Click Add on the tabs.

The Add Dashboard window is displayed.

4. Select Standard Dashboard.

A list of the available dashboard templates is displayed.

5. Click the Select icon for the dashboard you want to add.

A new dashboard tab is displayed, with the widgets that have been configured by a Administrator.

Adding Personal Dashboards A personal dashboard is only visible to the user who created it.


Page 17


Manually Adding a New Personal Dashboard

To add a new personal dashboard:




3. Click Add on the tabs.


4. Select Personal Dashboard.



6. Click Save.





2. Click the name of the widget you want to add to the dashboard.




See the Reference: Widgets on page 27 for full details of how to configure the data shown in widgets.


4. Click Save.



Copying a Dashboard

To create a new personal dashboard by copying an existing standard or personal dashboard:




3. Click the tab for the dashboard you want to copy.

4. Click the drop-down arrow on the dashboard tab and select Copy.



A new personal dashboard is created with the same name as the copied dashboard. You can edit its details to rename it and configure the widgets as required - see Editing Personal Widget Dashboard Details on page 18 and Configuring Personal Widget Dashboards on page 18.

Note If you create multiple copies of a dashboard without renaming the copies, each new dashboard will

have a number added to its title, e.g. Dashboard (1), Dashboard (2).

Editing Personal Widget Dashboard Details To edit the details of a personal dashboard:




3. Click the tab for the dashboard you want to edit.


4. On the dashboard tab, click the drop-down arrow and select Edit to display the Edit Dashboard window.



6. Click Save to update the dashboard details.

Configuring Personal Widget Dashboards


To configure a personal widget dashboard:




3. Click the tab for the dashboard you want to edit.











Page 19



4. Click Save.








3. Click Save.


To remove a widget:





Deleting Widget Dashboards

Note Deleting a standard dashboard removes it from your Widgets area but it remains available and can be added again if required.

Deleting a personal dashboard permanently deletes it.

To delete a dashboard from your Widgets area:




3. Click the tab for the dashboard you want to delete.


4. On the dashboard tab, click the drop-down arrow and select Delete.


5. Click OK to delete the dashboard.


The Contract Dashboard uses AVEVA Contract Risk Management Analytics to display contract data in a variety of personalised, customisable, easy-to-read table and chart widgets.

Users with the following contract roles can view the Dashboard tab, and add and configure dashboards and widgets:

Contract Owner

Contract Administrator

Company Representative

Contract Budget Holder

Contract Auditor

Dashboard templates are created by the Administrator, and can be added as read-only standard dashboards to your Contract Dashboard. The administrator can set a default standard dashboard, which will always be automatically available to you.

You can also create blank personal dashboards, or copy a standard, shared or personal dashboard and personalise it as required. These are available in all the contracts for which you have one of the appropriate contract roles.

You can share your personal dashboards so that they are available as read-only to other users who have access to a Contract Dashboard.

Watch a demonstration video: Creating and Sharing Contract Dashboards (https://youtu.be/n8qXWe3q5vE)

Viewing Your Contract Dashboard

To view your contract dashboard:

1. Navigate to the home page of the contract you want to work on.

2. Click the Dashboard tab.

The last contract dashboard you viewed is displayed. If you do not have any other dashboards, the default dashboard is displayed if one has been set by the Administrator.

3. Click the drop-down list to swap between dashboards. The list is divided into:

o Standard Dashboards - read-only dashboards created by the Administrator, including any default dashboard.

o Personal Dashboards - dashboards which you have created manually or by copying an existing dashboard. These dashboards are available in all contracts for which you have access to the Contract Dashboard.

o Shared Dashboards - read-only dashboards which have been made available by other users.

You can refresh the data on the dashboard at any time by clicking the Actions button and selecting Refresh.

CHAPTER 3

The Contract Dashboard

https://youtu.be/n8qXWe3q5vE

AVEVA™ Contract Risk Management 8.0 Chapter 3 – The Contract Dashboard


Click the Minimise and Restore buttons on the title bar of a widget to hide and show its contents.

Manually Adding a New Personal Dashboard

A personal dashboard is only visible to the user who created it unless it is shared. It is automatically available in all contracts for which you have access to the Contract Dashboard.

To add a new personal dashboard:

1. On the Contract Dashboard, click Add.


2. Select Personal Dashboard.


The Title is the name shown in the drop-down list of dashboards on the Contract Dashboard tab.

4. Click Save.

A new, empty dashboard tab is displayed. The dashboard is available in all contracts for which you have access to the Contract Dashboard.










4. Click Save.



Adding Standard Dashboards

Standard dashboards are created and configured as dashboard templates by a Administrator. These read-only dashboards display any data in your contract to which you have access. You cannot edit the widgets, but you can click into them to display further information. Changes made to the dashboard by an administrator will be shown automatically when the dashboard is next refreshed.

If a dashboard has been set as default by the administrator, it appears automatically on your Contract Dashboard. If the dashboard has not been set as default, it can be added manually.

You can copy a standard dashboard which appears on your Contract Dashboard, to modify it for your own needs. See Copying a Dashboard #copy.


Page 23


To add a new standard dashboard:



2. Select Shared Dashboard.

A list of the available standard dashboards is displayed.


A new read-only dashboard is displayed, with the widgets that have been configured by a Administrator.

Adding Shared Dashboards

When a dashboard created by another user is shared, you can add it manually to your Contract Dashboard. Shared dashboards are read-only, and display any data in your contract to which you have access. You cannot edit the widgets, but you can click into them to display further information. Changes made to the dashboard by its creator will be shown automatically when the dashboard is next refreshed.

You can copy a standard dashboard which appears on your Contract Dashboard, to modify it for your own needs. See Copying a Dashboard below.

To add a shared dashboard:



2. Select Shared Dashboard.

A list of the available shared dashboards is displayed.


A new read-only dashboard is displayed, with the widgets that have been configured by the user who created the dashboard.

Note If the user unshares the dashboard, it will no longer be visible on your Contract Dashboard. However, if they reshare the dashboard, it will automatically become visible again and you will not need to re -add it.

Copying a Dashboard

To create a new personal dashboard by copying an existing standard, personal or shared dashboard:

1. On the Contract Dashboard, select the dashboard you want to copy from the drop-down list.

2. Click the Actions button on the dashboard and select Copy.

A new personal dashboard is created with the same name as the copied dashboard. You can edit its details to rename it and configure the widgets as required.

The dashboard is available in all contracts for which you have access to the Contract Dashboard.

Note If you create multiple copies of a dashboard without renaming the copies, each new dashboard will

have a number added to its title, e.g. Dashboard (1), Dashboard (2).

Configuring Your Contract Dashboard













4. Click Save.







3. Click Save.


To remove a widget:





Sharing a Contract Dashboard

You can share a personal dashboard to make it available as a read-only dashboard for all other users who have access to a Contract Dashboard.

To share a personal contract dashboard:

1. On the Contract Dashboard, select the dashboard you want to share from the drop-down list.

2. Click the Actions button on the dashboard and select Share.


3. Click OK to share the dashboard.

The dashboard is now available to other users to add to their Contract Dashboards.


Page 25


To stop sharing a personal contract dashboard:

1. On the Contract Dashboard, select the dashboard you want to stop sharing from the drop-down list.

2. Click the Actions button on the dashboard and select Unshare.


3. Click OK to stop sharing the dashboard.

It is no longer visible to other users but personal dashboards copied from it are not affected.

Note If you choose to reshare the dashboard, it will be automatically visible again to users who had previously added it to their Contract Dashboard.

Deleting Contract Dashboards

Deleting a standard or shared dashboard removes it from your Contract Dashboard but it remains available and can be added again if required.

Deleting a personal dashboard permanently deletes it.

Note You must have at least one personal dashboard. If you have only one, you cannot delete it until you create another.

Note You cannot delete the default standard dashboard, if one has been set by the Administrator.

To delete a dashboard from your Contact Dashboard:

1. On the Contract Dashboard, select the dashboard you want to delete from the drop-down list.

2. Click the Actions button on the dashboard and select Delete.


3. Click OK to delete the dashboard.


AVEVA Contract Risk Management manages a large amount of information relating to contractual risk, but this information is often only accessible to users accessing contracts on a regular basis. The dashboards functionality uses AVEVA Contract Risk Management Analytics and OData 4.0 APIs to surface this information and display it in a variety of easy-to-read table and chart widgets.

Dashboard templates can be created in AVEVA Contract Risk Management, using a variety of configurable widgets, to display the data in tables and charts in Business Unit and Contract level dashboards.

This section details how to configure dashboard widgets as an administrator or a company user with the Analytics API Access user role permission.

On AVEVA Contract Risk Management dashboards, users can only see data for the business unit to which they belong, even if they have access to all business units. To access data across all business units, the user must have the Analytics API Access Across Business Units permission and use a third-party reporting application such as Power BI - see Analytics API Access.

See Dashboard Maintenance on page 5 for information specific to standard dashboards, layouts, and deploying widget types as an Administrator.

See Widget Dashboards on page 15 (business unit level data) and The Contract Dashboard on page 21 (contract level data) for information specific to company users.

Also see Accessing Analytics from External Applications on page 81 for information about how to get data from the Analytics API into Microsoft Excel.

Watch a demonstration video: Setting Up a Reporting Dashboard (https://youtu.be/KsQHh6KlfZ8)

Widget Types Dashboards can be configured in a variety of different ways using the various types of table and chart widgets within AVEVA Contract Risk Management.

Table Widgets on page 28

Slicer Widgets on page 35

Card Widgets on page 37

Bar Chart Widgets on page 40

Line Chart Widgets on page 47

Pie Chart Widgets on page 51

Stacked Bar Chart Widgets on page 58

Stacked Bar With Limit Chart Widgets on page 61

Historical Data Widgets on page 66

CHAPTER 4

Reference: Widgets

https://youtu.be/KsQHh6KlfZ8

AVEVA™ Contract Risk Management 8.0 Chapter 4 – Reference: Widgets


Trend Widgets on page 70

Text Widgets on page 75

Table Widgets

Table widgets display information from a specific data model, according to the specified REST URL and the columns selected in the table configuration.

You can group and aggregate data as required, limit the number of records displayed, configure the data displayed in the Detail Panel, and receive and broadcast filter events which apply to the table.

The options selected when the table widget is configured affect its behaviour when a row is clicked.

Options Behaviour When Row is Clicked

Group By No change.

Enable Detail Panel

Broadcast Filter Events

Group By The table is replaced with the Detail Panel. This shows a new set of columns (specified by Details Columns) which display information for only the item that was clicked.

Enable Detail Panel


Group By The table is replaced with the Detail Panel. This shows a new set of columns (specified by Details Columns) which display information for only the item that was clicked.

Any widgets on the dashboard which are configured to receive filter events will be filtered according to the row selected and the column specified by Field to Broadcast.

For example, if the Field to Broadcast is CommunicationState, when the table widget is filtered to show only data for a specific communication state (by clicking on the row for that state), any receiving widgets such as bar and pie charts will be filtered to show only information for the same communication state.

Enable Detail Panel


Group By The table is replaced by the Detail View, which displays a table


Page 29


Enable Detail Panel - of data filtered according to the row that was clicked.

For example, if the table is grouped by CommunicationState, clicking the row for the count of Draft communications will open the Detail View to display the data for Draft communications only.

See Configuring the Detail View on page 79 for more information.


Group By The row that was clicked is highlighted.

Any widgets on the dashboard which are configured to receive filter events will be filtered according to the row selected and the column specified by Field to Broadcast.

For example, if the Field to Broadcast is CommunicationState, when the table widget is filtered to show only data for a specific communication state (by clicking on the row for that state), any receiving widgets such as bar and pie charts will be filtered to show only information for the same communication state.

Enable Detail Panel -


Adding a Table Widget

To add a table widget to a dashboard:





Tip You can drag the widget to a different location on the page, e.g. to a different column, and to above or

below existing widgets. You can also resize the widget by dragging the edges to change the height or width.

Configuration Field Descriptions


Field/Section Displayed When Description

Title The title of the widget.

Rest URL The URL of the data which will be used in the table widget.

See Specifying URLs on page 76 for more information.

Group By Enter the name of the column by which you want to group the data.

For example, to group communication data by the state of the communications, enter CommunicationState.



See Data Models and Columns on page 83 for information about the columns which are available for each type of data.

Aggregated Column(s) A value is entered in Group By.

Select the Type: Average, Count or Sum.

For Average and Sum, enter the Column Name for the column by which you want to aggregate the data.

Tip You can use the $filter option with the Rest URL to exclude zero values from calculated averages. For example, to exclude zero values for the average DaysToRespond for communications, use $filter=DaystoRespond gt 0. See

Specifying URLs on page 76 for more information.

For Count, the Group By column is automatically used.


.Click Add to add more columns.

Limit Records A value is entered in Group By.

Select how to limit the number of records which are displayed, based on the value of the Group By column:

None - all records are displayed.

Top or Bottom - the top or bottom X records are displayed, where X is the Record Count, e.g. the top 5 records.

Include Tied Results Top or Bottom is selected for Limit Records.

Select to display all records which rank equally in the top or bottom X, even if this means that more than X records are displayed.

For example, if X is 10, and the 11th and 12th records have the same value as the 10th, all 12 records will be displayed.

However, if the 5th and 6th records have the same value but the 10th has a unique value, only 10 records are displayed.

Record Count Top or Bottom is selected for Limit Records.

The number of records (X) which are displayed.

Limit Column Top or Bottom is selected for Limit Records.

The column on which the records are sorted to get the top or bottom X records. The column must be listed in the Table Columns to Display.

Tip Column names can include the aggregate


Page 31


type, e.g. Count of CommunicationState.

Table Columns to Display

The columns displayed in the table.

If Aggregated Columns are specified, these are listed by default and cannot be removed or added to.

Otherwise, enter the Column Name for the column you want to include in the table display.

Click Add to add more columns.

If desired, enter a Display Name for the column (e.g. a short name or friendly name).

Enable Detail Panel A value is not entered in Group By.

Select to display drill-down data in the Detail Panel when the table is filtered (by clicking a table row).

See the Options table above for what happens if Enable Detail Panel is not selected.

Details Columns Enable Detail Panel is selected.

Enter the Column Name for the column you want to include in the Detail Panel.

Tip Column names can include the aggregate

type, e.g. Count of CommunicationState.

Click Add to add more columns.


Receive Filter Events Select to receive any broadcast filter events from other widgets. This widget will be filtered based on the filter event received.

For example, if the current widget shows the financial values of all communications, and a filter event is received from another widget which has been filtered to show only data for a specific communication state, the current widget will be filtered by the same communication state.

Broadcast Filter Events Select to broadcast any filters applied to the current widget. The value of the Group By column is used as the filter; if this is not specified, enter the required column name in Field to Broadcast.

For example, if the current widget is grouped by Communication State, and is filtered to show only data for a specific communication state (by clicking on the relevant table row), any receiving widgets will be filtered by the same communication state.



Field to Broadcast Broadcast Filter Events is selected but no Group By column is specified.

The name of the column which is used as the value for the filter events.

For example, if CommunicationState is entered, and the current widget is filtered to show only data for a specific communication state (by clicking on the relevant table row), any receiving widgets will be filtered by the same communication state.

Basic Configuration

To configure the table widget:

1. If necessary, click Edit on the title bar of the widget to open its properties.


2. Enter the Title of the widget.

3. Enter the Rest URL of the data model which will be used in the widget, typically https://YourServer/ProConAnalyticsAPI/datamodel where datamodel is:

o Contracts on page 83

o BreakdownItems (see "Breakdown Items" on page 90)

o LineItems (see "Contract Line Items" on page 94)

o Communications on page 99

o CommunicationReviews (see "Communication Reviews" on page 107)

o CommunicationLineItems (see "Communication Line Items" on page 111)

o Obligations (see "Contract Obligations" on page 116)

o Tenders on page 118

o ScheduleItems (see "Schedule Items" on page 121)

o TenderReviews (see "Tender Reviews" on page 123)

o StageGates (see "Stage Gates" on page 125)

If necessary, customise the URL to select, filter, sort and limit the data - see Specifying URLs on page 76 for more information.

Tip By default, data is returned from deleted contracts/tenders which are in the recycle bin.

Include $filter=IsDeleted eq 'No' in your URL to exclude this data.

4. If you do not want to group and aggregate data, specify the Table Columns to Display:

a. Enter the Column Name for a column you want to include in the table display. Click Add to add more columns.

b. If desired, enter a Display Name for the column (e.g. a short name or friendly name).

c. You can click Save to display a table with the specified columns, or continue to refine your widget data before saving.


Page 33


Grouping and Aggregating Data

To group the data:

1. In the Group By field, enter the name of the column by which you want to group the data.

Note This is also the column for which the value is broadcast as a filter event if Broadcast Filter Events is

selected.



2. Select the Type: Average, Count or Sum.


Tip You can use the $filter option with the Rest URL to exclude zero values from calculated averages. For example, to exclude zero values for the average DaysToRespond for communications, use $filter=DaystoRespond gt 0. See Specifying URLs on page 76 for more information.

For Count, the Group By column is automatically used.


3. Click Add to specify more aggregated columns.

4. The list of Table Columns to Display automatically updates to include the Group By column and all Aggregated Columns.


Limiting the Displayed Records

If you have chosen to group your data (by specifying a Group By column), you can limit the number of records displayed in the table. Limiting the records displayed also sorts the rows in the table by ascending/descending order.

To limit the number of records displayed:

1. From Limit Records, select:

o Top to show the first X records.

o Bottom to show the last X records.

2. Select Include Tied Results if you want to display all records which rank equally in the top or bottom X, even if this means that more than X records are displayed.

3. Enter the number of records you want to display in the Record Count field.

4. Enter the name of the Limit Column on which the records will be sorted to get the top or bottom X records - the column must be listed in the Table Columns to Display. You can use aggregated columns, e.g. Sum of TotalFinancialValue.

Detail Panel Configuration

To configure the data displayed in the Detail Panel when the table is filtered (by clicking a row):

1. Select Enable Detail Panel. See the Options table above for what happens if Enable Detail Panel is not selected.



2. Specify the column you want to display by entering the following details:

o Column Name

o Display Name (e.g. a short name or friendly name)

3. Click Add to specify more columns.

Broadcasting and Receiving Filter Events

See Configuring Widgets to Broadcast and Receive Filters on page 79.

Example

Business Unit dashboard.

Lists the projects in the business unit, with the number of contract communications in each project and the average value of the financial impact of the communications.

Field Value Notes

Title Project Breakdown The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Communications

Returns data from the Communications data model. No filter applied on the URL.

Group By ProjectDepartmentName

Groups the data by the name of the project/dept - i.e. each row of the table is a project/dept.

Aggregated Columns - Type

1. Count

2. Average

1. Counts the number of records returned for each project/dept.

2. Averages the values of the TotalFinancialImpactBase for the communications in each project/dept.

Aggregated Columns - Column Name

1. -

2. TotalFinancialImpactBase

Limit Records Optional Used to specify the maximum number of records you want to include in the data shown.


Page 35


Table Columns to Display - Column Name

- The selected Aggregated Columns.

Table Columns to Display - Display Name

1. Project

2. No of Comms

3. Avg of Financial Impact

Optional display names.

Receive Filter Events Optional If selected, the data will be filtered according to the selection in a Slicer or Table widget that broadcasts filter events.

Broadcast Filter Events Optional If selected, and if a project/dept is selected in the table (displayed in bold), widgets which are set to receive filter events will show only the data for that project/dept.

Slicer Widgets

A slicer widget is a single-column table which is used to filter other widgets on the dashboard. It automatically broadcasts a filter event for the selected row to any widgets such as bar and pie charts which have been configured to receive filter events (see Configuring Widgets to Broadcast and Receive Filters on page 79).

Note Only one broadcasting slicer or table widget is active at a time on a dashboard.

Adding a Slicer Widget

To add a slicer widget to a dashboard:










Field/Section Description


Rest URL The URL of the data which will be used in the table widget.


Group By Enter the name of the column you want to show on the slicer widget, which will be used to filter other widgets.

For example, to be able to filter communication data on other widgets by the state of the communications, enter CommunicationState.


Display Name The name displayed for the column (e.g. a short name or friendly name).

Widget Configuration

To configure the slicer widget:



















Page 37



Broadcasting Filter Events

The slicer widget automatically broadcasts filter events when any of the rows in the table are clicked.


Example

Business Unit dashboard.

Lists the categories of the tenders in the business unit. If a category is selected (displayed in bold), widgets which are set to receive filter events will show only the data for tenders in that category.

Field Value Notes

Title Tender Category Filter The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Tenders

Returns data from the Tenders data model. No filter applied on the URL.

Group By Category Groups the data by the tender category, i.e. each row of the table is a category.

Display Name Tender Category Optional display name.

Card Widgets

Card widgets display single values which do not need to show any context such as a positive or negative trend, for example the number of days remaining on a contract.



Adding a Card Widget

To add a card widget to a dashboard:








Field/Section Description


Rest URL The URL of the data which will be used in the card widget.


Prefix The prefix to be shown before the value on the card; e.g. a currency symbol.

Suffix The suffix to be shown after the value on the card; e.g. "days". A space is automatically added before the suffix.

Aggregation Select the Type: Average, Count or Sum.


Tip You can use the $filter option with the Rest URL to exclude zero values from calculated averages. For example, to exclude zero values for the average DaysToRespond for communications, use $filter=DaystoRespond gt 0. See Specifying URLs on page 76 for more

information.

For Count, the number of items which are returned by the REST URL is displayed - e.g. the total number of communications.


Receive Filter Events Select to receive any broadcast filter events from other widgets. This widget will be filtered based on the filter event received.

For example, if the current widget shows the financial values of all communications, and a filter event is received from another widget which has been filtered to show only data for a specific communication state, the current widget will be filtered by the same communication state.


Page 39


Widget Configuration

To configure the card widget:



















4. Enter any Prefix and/or Suffix that you want displayed with the value on the card.

5. In the Aggregation section, select the Type (Average, Count or Sum) and enter the Column Name for the column by which you want to aggregate the data (not required for Count).

6. You can click Save to display the value returned by the specified Rest URL and specified columns, or continue to refine your widget data before saving.

Receiving Filter Events


Example

Contract Dashboard.



Displays the number of days until the planned end date of the contract.

Field Value Notes

Title Days Remaining on Contract The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Contracts

Returns data from the Contracts data model. No filter applied on the URL.

Because this is a Contract dashboard, only data for the current contract is returned.

Prefix (leave blank)

Suffix (leave blank)

Aggregation - Type Count Counts the number of records returned.

Aggregation - Column Name

-

Receive Filter Events Optional If selected, the data will be filtered according to the selection in a Slicer or Table widget that broadcasts filter events.

Bar Chart Widgets

Bar chart widgets display information from a specific data model, according to the filters applied to the Rest URL for the data, as a single set of bars on a chart.

You can group and aggregate the data as required, limit the number of records displayed, and receive filter events which apply to the chart.


Page 41


If a Group By column is specified for the bar chart, the X axis of the chart displays the values from the specified Group By column; the Y axis displays the values from the column selected for Aggregation.

If a Group By column is not specified, the aggregated values from the columns selected for the chart are shown. Each column corresponds to a bar on the chart.



Clicking a bar drills through to the Detail View, which displays a table of data filtered according to the bar that was clicked. For example, if a bar chart is grouped by CommunicationState, clicking the bar for the count of Draft communications will open the Detail View to display the data for Draft communications only. See Configuring the Detail View on page 79 for more information.

Note Drill-through on charts is not available to the Administrator when creating and updating standard dashboards.

Note Column names longer than 10 characters will be truncated.

Adding a Bar Chart Widget

To add a bar chart widget to a dashboard:








Field/Section Displayed When Description


Rest URL The URL of the data which will be used in the chart widget.


Group By Enter the name of a column by which you want to group the data.



Aggregation A Group By column is specified.

Select the Type: Average, Count or Sum.


Tip You can use the $filter option with the Rest URL to exclude zero values from calculated averages. For example, to exclude zero values for


Page 43


the average DaysToRespond for communications, use $filter=DaystoRespond gt 0. See Specifying URLs on page 76 for more information.

contract risk management 8 · 2020. 6. 18. · aveva.com aveva™ embedded dashboards and widgets...

Documents