procon 7 embedded dashboards and widgetsproconhelp.aveva.com/.../procon-7-widgets-reference.pdf ·...

PROCON 7 EMBEDDED DASHBOARDS ANDWIDGETSPP1039-11 / Apr. 2019

AVEVA Solutions LimitedHigh Cross Madingley RoadCambridge CB3 0HBTel +44 (0)1223 556655Fax +44 (0)1223 556666aveva.com

PROCON 7EMBEDDED DASHBOARDS AND WIDGETS PAGE 2OF 132

CONTENTS

Dashboard Maintenance 5Business Unit Dashboard Templates 6Viewing Business Unit Dashboard Templates 6Creating Business Unit Dashboard Templates 6Editing Business Unit Dashboard Template Details 7Configuring Business Unit Dashboard Templates 7Publishing Business Unit Dashboard Templates 8Deleting Business Unit Dashboard Templates 8

Contract Dashboard Templates 9Viewing Contract Dashboard Templates 9Creating Contract Dashboard Templates 9Editing Contract Dashboard Template Details 10Configuring Contract Dashboard Templates 10Setting the Default Contract Dashboard 11Deleting Contract Dashboard Templates 11

Widget Templates 12AddingWidget Templates 12EditingWidget Templates 12DeployingWidget Templates 12DeletingWidget Templates 13

Widget Dashboards 14ViewingWidget Dashboards 14Adding StandardWidget Dashboards 15Adding Personal Dashboards 15Manually Adding a New Personal Dashboard 15Copying a Dashboard 16

Editing Personal Widget Dashboard Details 16Configuring Personal Widget Dashboards 16DeletingWidget Dashboards 17

The Contract Dashboard 19Viewing Your Contract Dashboard 19Manually Adding a New Personal Dashboard 19Adding Standard Dashboards 20Adding Shared Dashboards 21Copying a Dashboard 21Configuring Your Contract Dashboard 21Sharing a Contract Dashboard 22Deleting Contract Dashboards 22

Reference: Widgets 24Widget Types 24


TableWidgets 24SlicerWidgets 30CardWidgets 33Bar Chart Widgets 35Line Chart Widgets 41Pie Chart Widgets 45Stacked Bar Chart Widgets 51Stacked BarWith Limit Chart Widgets 53Historical DataWidgets 57TrendWidgets 60Text Widgets 65

Specifying URLs 66Returning a Count of Records 67Selecting Specific Data to Return 67Filtering the Returned Data 67Sorting and Limiting the Returned Data 68

Configuring the Detail View 69Using the Detail View Data Externally 69

ConfiguringWidgets to Broadcast and Receive Filters 69Configuration 70

Using Historical Data 70Accessing ProCon Analytics from External Applications 71Example - Microsoft Excel Power Query 71

DataModels and Columns 72Contracts 72Breakdown Items 78Contract Line Items 81Communications 85Communication Reviews 94Communication Line Items 99Contract Obligations 102Tenders 103Schedule Items 105Tender Reviews 107StageGates 109UserMetrics 111

Dashboard Examples 111MilestoneObligations Summary 111Tender Summary 118

Troubleshooting DashboardWidgets 128"Error in Configuration" 128"REST URLReturned NoData" 128Errors in Band, Limit andGroup By Columns 128TableMissing Expected Data 128


Index 129


DASHBOARD MAINTENANCEProConmanages a large amount of information relating to contractual risk, but this information is often onlyaccessible to users accessing contracts on a regular basis. The dashboards functionality uses ProCon AnalyticsandOData 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 ProCon, using a variety of configurable widgets, to display the data intables and charts in Business Unit and Contract level dashboards. SeeReference: Widgets for full details of theavailable types of widgets.TheOData APIs used by the ProCon widgets can also be consumed by third-party Business Intelligenceproducts such as Microsoft PowerBI.Note: ProCon Analytics must be installed on the ProCon system where widget dashboards will be used.

Dashboard widgets are created from widget templates which are added and deployed in the Administration portal.SeeWidget Templates.

Dashboard Types

Data Type Created By InformationBusinessUnit

Standard ProCon Administrator Created as a dashboard template in the Admin portal.Can be published as read-only standard dashboards toall users with theBusiness Unit Dashboard Accessuser role permission.Users canmanually add unpublished dashboardtemplates to theirWidget Dashboards area as standarddashboards.Users can copy a standard dashboard in theirWidgetDashboards area as a new personal dashboard, whichthey can then configure as required.SeeBusiness Unit Dashboard Templates.

BusinessUnit

Personal Users with theDashboard andWidgets Access userrole permission

Created in theWidget Dashboards area of the ProConCompany Portal.Users can copy a standard or personal dashboard intheirWidget Dashboards area as a new personaldashboard, which they can then configure as required.

Contract Standard ProCon Administrator Created as a dashboard template in the Admin portal.Users canmanually add dashboard templates to theirContract Dashboard as standard dashboards.Users can copy a standard dashboard on their ContractDashboard as a new personal dashboard, which theycan then configure as required.SeeContract Dashboard Templates.

Contract Personal Users with thefollowing contractroles:

Contract OwnerContractAdministratorCompanyRepresentativeContract BudgetHolderContract Auditor

Created in the Contract Dashboard.Users can share a personal dashboard so that otherusers can add it to their Contract Dashboard.Users can copy a standard, shared or personaldashboard on their Contract Dashboard as a newpersonal dashboard, which they can then configure asrequired.


BUSINESS UNIT DASHBOARD TEMPLATESBusiness Unit level dashboards are available to company users who have theBusiness Unit Dashboard Accesspermission.Business Unit level dashboard templates can be automatically published by the administrator to appear in theWidget Dashboards area for all users as read-only standard dashboards. They can also be addedmanually bythe user either as standard dashboards or as copies of the templates which can then be configured as personaldashboards.Any changes made by a ProCon administrator to a Business Unit dashboard template will be reflected in theusers' standard dashboards once the template has been published.Warning: The administrator creating and configuring dashboard templates must be assigned to a BusinessUnit for any data to appear in the configured widgets. They will then see data from that Business Unit in thewidgets.

Viewing Business Unit Dashboard TemplatesTo view a list of business unit dashboard templates configured for the ProCon system:

1. Click theDashboard Maintenance tab on theMainMenu 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 towhom the dashboard template has been published is shown for each template.

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

To add a new business unit dashboard template:

1. Click theDashboard Maintenance tab on theMainMenu 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 andDescription for the dashboard.The Title is the name shown on the dashboard tab in theWidget Dashboards area.

4. Click Save.A new, empty dashboard tab is displayed.Note: The dashboard template is now available for users to copy or addmanually.You can also add it automatically for all users by publishing it. SeePublishing Business UnitDashboard 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 AddWidget.The AddWidget window is displayed.

2. Click the name of the widget type you want to add to the dashboard. Widget types are defined by the ProConAdministrator.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 orbelow existing widgets. You can also resize the widget by dragging the edges to change the height orwidth.

3. Enter information as required in the relevant fields.SeeReference: Widgets for full details of how to configure the data shown in widgets.Note: Fields marked with an asterisk aremandatory.

4. Click Save.The widget is updated. Any changes are automatically deployed.

Repeat this step to addmultiple widgets to a dashboard. A maximum of 15 widgets can be displayed perdashboard.

Editing Business Unit Dashboard Template DetailsTo edit the details of a business unit dashboard template:

1. On the Business Unit Dashboard Templates page, clickEdit for the dashboard template for which youwant to update the details.The Edit Dashboard Template page is displayed.Alternatively, clickConfigure for the dashboard template you want to update. On the dashboard tab, clickthe drop-down arrow and select Edit to display the Edit Dashboard window.

2. Enter a Title andDescription for the dashboard.The Title is the name shown on the dashboard tab in theWidget Dashboards area.

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

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

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, clickConfigure for the dashboard template you want toconfigure.The dashboard tab is displayed, showing any widgets have been previously added.

To add a widget to your dashboard template:


2. Click the name of the widget type you want to add to the dashboard. Widget types are defined by the ProConAdministrator.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 orbelow existing widgets. You can also resize the widget by dragging the edges to change the height orwidth.

3. Enter information as required in the relevant fields.SeeReference: Widgets for full details of how to configure the data shown in widgets.


Note: Fields marked with an asterisk aremandatory.4. Click Save.

The widget is updated. Any changes are automatically deployed.


To edit an existing widget:

1. ClickEdit on the title bar of the widget to open its properties.2. Enter information as required in the relevant fields.

SeeReference: Widgets for full details of how to configure the data shown in widgets.Note: Fields marked with an asterisk aremandatory.


To remove a widget:

1. Click Delete for the widget you want to remove.A confirmationmessage is displayed.

2. Click OK to permanently remove the widget from the dashboard.The widget is updated. Any changes are automatically deployed.

Publishing Business Unit Dashboard TemplatesIf a Business Unit level dashboard template is published, it is automatically displayed as a read-only standarddashboard for all users who can view theWidget Dashboards area of the Company Portal. They can remove itfrom 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 manuallyas a standard dashboard.

To publish a Business Unit dashboard template:

1. On the Business Unit Dashboard Templates page, clickPublish for the dashboard template you want topublish to all users with theBusiness Unit Dashboard Access permission.A confirmationmessage is displayed.

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

Deleting Business Unit Dashboard TemplatesWarning: 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 todelete.A confirmationmessage is displayed.

2. Click OK to delete the dashboard template.


CONTRACT DASHBOARD TEMPLATESContract level dashboards are available to company users with the appropriate company roles.Users can add the dashboard templates as read-only standard dashboards to their Contract Dashboards. Theycan alsomake copies of standard dashboards to personalise them - changes made to the dashboard template donot affect the personal copies.You can set a default standard dashboard, which will always be automatically available to all users who haveaccess to a Contract Dashboard.Warning: The administrator creating and configuring dashboard templates must be assigned to a BusinessUnit for any data to appear in the configured widgets. They will then see data from that Business Unit in thewidgets.

Viewing Contract Dashboard TemplatesTo view a list of contract dashboard templates configured for the ProCon system:

1. Click theDashboard Maintenance tab on theMainMenu and select Contract Dashboard Templates.The Contract Dashboard Templates page is displayed.

Creating Contract Dashboard TemplatesWarning: The administrator creating and configuring dashboard templates must be assigned to a BusinessUnit for any data to appear in the configured widgets. They will then see data from that Business Unit in thewidgets.

To add a new contract dashboard template:

1. Click theDashboard Maintenance tab on theMainMenu and select Contract Dashboard Templates.The Contract Dashboard Templates page is displayed.

2. Click Add.The Add Dashboard Template page is displayed.

3. Enter a Title andDescription for the dashboard.The Title is the name shown in the drop-down list of available dashboards on the Contract Dashboard.

4. Click Save.A new, empty dashboard tab is displayed.Note: The dashboard template is now available for users to copy or addmanually.


1. Click theActions button on the dashboard and select AddWidget.The AddWidget window is displayed.






Editing Contract Dashboard Template DetailsTo edit the details of a contract dashboard template:

1. On the Contract Dashboard Templates page, clickEdit for the dashboard template for which you want toupdate the details.The Edit Dashboard Template page is displayed.Alternatively, clickConfigure for the dashboard template you want to update. On the dashboard tab, clickthe drop-down arrow and select Edit to display the Edit Dashboard window.

2. Enter a Title andDescription for the dashboard.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 TemplatesWarning: The administrator creating and configuring dashboard templates must be assigned to a BusinessUnit for any data to appear in the configured widgets. They will then see data from that Business Unit in thewidgets.

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

To update the configuration of a contract dashboard template:

1. On the Contract Dashboard Templates page, clickConfigure for the dashboard template you want toconfigure.The dashboard tab is displayed, showing any widgets have been previously added.

To add a widget to your dashboard template:











To remove a widget:



Setting the Default Contract DashboardOptionally, any one of contract dashboard templates can be set as the default contract dashboard. This is visibleas 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 tomake the default.A confirmationmessage is displayed.

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 stopbeing the default.Alternatively, click the toggle for the dashboard template you want to make the new default.A confirmationmessage is displayed.

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 alreadyadded it as a standard dashboard.

Deleting Contract Dashboard TemplatesWarning: A dashboard template can be deleted even if it is in use.

To delete a contract dashboard template:

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

2. Click OK to delete the dashboard template.


WIDGET TEMPLATESDashboards consist of a number of widgets such as charts and tables, each of which can use a different set ofdata. The widget templates from which these are created are defined in the Admin portal andmust be deployedbefore they can be used in dashboards.

Adding Widget TemplatesTo add a new widget template:

1. Click theDashboard Maintenance tab on theMainMenu and selectWidgets.TheWidgets page is displayed.

2. Click Add.The AddWidget page is displayed.

3. Enter theWidget Name and an optional Description.4. Select theWidget Category from the drop-down list.5. Click Save.

TheWidgets page is displayed, with the new widget template.Note: The widget templatemust be deployed before widgets can be added from it for use in a dashboard.SeeDeploying Widget Templates.

Editing Widget TemplatesTo 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.

TheWidgets page is displayed.

Deploying Widget TemplatesWidget templates must be deployed before they can be used to create dashboard widgets. To do this, thelocation of themost recent assembly file (DLL) for the widget typemust be specified.The widget templatemust also be redeployed if an update to the assembly file is issued.

To deploy a widget template:

1. Click theDashboard Maintenance tab on theMainMenu and selectWidgets.TheWidgets page is displayed.Tip: TheWidget Version column shows the version of the assembly file with which the widget template iscurrently deployed. If this column is blank, the widget template has never been deployed and cannot beused 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, anerror message is displayed. Browse for a different file, or click Cancel.

TheWidgets page is displayed. TheWidget Version is updated for the widget template you have deployedor redeployed.

Deleting Widget TemplatesWarning: Widget templates can be deleted at any time. Any widgets created from them will be deleted fromdashboards.

To delete a widget template:


2. Click Delete for the widget template you want to delete.A confirmationmessage is displayed.

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


WIDGET DASHBOARDSProConmanages a large amount of information relating to contractual risk, but this information is often onlyaccessible to users accessing contracts on a regular basis. The dashboards functionality uses ProCon AnalyticsandOData 4.0 APIs to surface this information and display it in a variety of easy-to-read table and chart widgetsat Business Unit and contract level. TheWidgets Dashboard area displays the Business Unit dashboards.TheOData APIs used by the ProCon widgets can also be consumed by third-party Business Intelligenceproducts such as Microsoft PowerBI.Widgets are created from widget templates which are added and deployed in the Administration portal.Note: ProCon Analytics must be installed on the ProCon system where widget dashboards will be used.

Dashboard templates can be created in ProCon, using a variety of configurable widgets, to display the data intables and charts in Business Unit and Contract level dashboards. SeeReference: Widgets for full details of theavailable types of widgets.Business Unit level dashboard templates are created in the Administration portal and can be published so thatthey are visible as read-only standard dashboards for all users with theBusiness Unit Dashboard Access userrole permission. Users with this permission can also create personal dashboards in theWidget Dashboards areaby manually creating a dashboard or by copying a standard or personal dashboard and configuring it as required.Users can only see data for the business unit to which they belong, even if they have access to all businessunits.See for more information about contract-level dashboards.

VIEWING WIDGET DASHBOARDSOnly users with theBusiness Unit Dashboard Access user role permission can view theWidget Dashboardsarea in the ProCon Company Portal.Only the data for the business unit to which the user belongs is displayed, even if they have access to allbusiness units.

To view theWidgets dashboards:

1. Open the navigation bar. If necessary, click theMy ProCon tab.2. From theUser Dashboardsmenu, selectWidget Dashboards.

TheWidgets page is displayed, showing a tab for each dashboard you have previously added:Standard dashboards created by a ProCon administratorPersonal dashboards

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

From theWidgets page you can:

Add new dashboards - seeAdding Standard Widget Dashboards andAdding Personal Dashboards.Copy a dashboard to create a new personal dashboard - seeCopying a Dashboard.Use options on the drop-downmenu for the current dashboard tab to:

Add widgets (personal dashboards only) - seeConfiguring Personal Widget Dashboards.Edit the dashboard (personal dashboards only) - seeEditing Personal Widget Dashboard Details.Refresh the data on the dashboard.Delete the dashboard; for a standard dashboard, this removes it from theWidgets area, but does notdelete the dashboard from the system.

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


ADDING STANDARDWIDGET DASHBOARDSStandard dashboards are created and configured as dashboard templates by a ProCon administrator. Theseread-only dashboards display any data in your Business Unit to which you have access. You cannot edit thewidgets, but you can click into them to display further information. Changes made to the dashboard by anadministrator will be shown automatically when the dashboard is next refreshed.If a dashboard is published by the administrator, it appears automatically in yourWidgets area. If the dashboardhas not been published, it can be addedmanually.You can copy a standard dashboard which appears in yourWidgets area, to modify it for your own needs. SeeCopying a Dashboard.

To add a new standard dashboard:


TheWidgets 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 ProCon administrator.

ADDING PERSONAL DASHBOARDSA personal dashboard is only visible to the user who created it.

Manually Adding a New Personal DashboardTo add a new personal dashboard:


TheWidgets 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 Personal Dashboard.5. Enter a Title andDescription for the dashboard.

The Title is the name shown on the dashboard tab in theWidget Dashboards area.6. Click Save.

A new, empty dashboard tab is displayed.



2. Click the name of the widget type you want to add to the dashboard. Widget types are defined by the ProConAdministrator.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 orbelow existing widgets. You can also resize the widget by dragging the edges to change the height orwidth.




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


TheWidgets page is displayed, showing a tab for each dashboard you have previously added.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 torename it and configure the widgets as required - seeEditing Personal Widget Dashboard Details andConfiguring Personal Widget Dashboards.Note: If you createmultiple copies of a dashboard without renaming the copies, each new dashboard willhave a number added to its title, e.g. Dashboard (1), Dashboard (2).

EDITING PERSONAL WIDGET DASHBOARD DETAILSTo edit the details of a personal dashboard:


TheWidgets page is displayed, showing a tab for each dashboard you have previously added.3. Click the tab for the dashboard you want to edit.

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

4. On the dashboard tab, click the drop-down arrow and select Edit to display the Edit Dashboard window.5. Enter a Title andDescription for the dashboard.

The Title is the name shown on the dashboard tab in theWidget Dashboards area.6. Click Save to update the dashboard details.

CONFIGURING PERSONAL WIDGET DASHBOARDSNote: A maximum of 15 widgets can be displayed per dashboard.

To configure a personal widget dashboard:


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


3. Click the tab for the dashboard you want to edit.The dashboard tab is displayed, showing any widgets have been previously added.











To remove a widget:



DELETING WIDGET DASHBOARDSNote: Deleting a standard dashboard removes it from yourWidgets area but it remains available and can beadded again if required.Deleting a personal dashboard permanently deletes it.

To delete a dashboard from yourWidgets area:


TheWidgets page is displayed, showing a tab for each dashboard you have previously added.3. Click the tab for the dashboard you want to delete.


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

4. On the dashboard tab, click the drop-down arrow and select Delete.A confirmationmessage is displayed.

5. Click OK to delete the dashboard.


THE CONTRACT DASHBOARDThe Contract Dashboard uses ProCon 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 andwidgets:

Contract OwnerContract AdministratorCompany RepresentativeContract Budget HolderContract Auditor

Dashboard templates are created by the ProCon administrator, and can be added as read-only standarddashboards to your Contract Dashboard. The administrator can set a default standard dashboard, which willalways be automatically available to you.You can also create blank personal dashboards, or copy a standard, shared or personal dashboard andpersonalise it as required. These are available in all the contracts for which you have one of the appropriatecontract roles.You can share your personal dashboards so that they are available as read-only to other users who have accessto a Contract Dashboard.

VIEWING YOUR CONTRACT DASHBOARDTo view your contract dashboard:

1. Navigate to the home page of the contract you want to work on.2. Click theDashboard tab.

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

3. Click the drop-down list to swap between dashboards. The list is divided into:Standard Dashboards - read-only dashboards created by the ProCon administrator, including any defaultdashboard.Personal Dashboards - dashboards which you have createdmanually or by copying an existingdashboard. These dashboards are available in all contracts for which you have access to the ContractDashboard.Shared Dashboards - read-only dashboards which have beenmade available by other users.

You can refresh the data on the dashboard at any time by clicking theActions button and selectingRefresh.Click theMinimise andRestore buttons on the title bar of a widget to hide and show its contents.

MANUALLY ADDING A NEW PERSONAL DASHBOARDA personal dashboard is only visible to the user who created it unless it is shared. It is automatically available inall contracts for which you have access to the Contract Dashboard.

To add a new personal dashboard:

1. On the Contract Dashboard, click Add.The Add Dashboard window is displayed.

2. Select Personal Dashboard.3. Enter a Title andDescription for the 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 haveaccess to the Contract Dashboard.







ADDING STANDARD DASHBOARDSStandard dashboards are created and configured as dashboard templates by a ProCon administrator. Theseread-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 administratorwill 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 ContractDashboard. If the dashboard has not been set as default, it can be addedmanually.You can copy a standard dashboard which appears on your Contract Dashboard, to modify it for your own needs.SeeCopying a Dashboard.

To add a new standard dashboard:


2. Select Shared Dashboard.A list of the available standard dashboards is displayed.

3. Click the Select icon for the dashboard you want to add.A new read-only dashboard is displayed, with the widgets that have been configured by a ProConadministrator.


ADDING SHARED DASHBOARDSWhen a dashboard created by another ProCon user is shared, you can add it manually to your ContractDashboard. 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 thedashboard 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.SeeCopying a Dashboard.

To add a shared dashboard:


2. Select Shared Dashboard.A list of the available shared dashboards is displayed.

3. Click the Select icon for the dashboard you want to add.A new read-only dashboard is displayed, with the widgets that have been configured by the ProCon user whocreated the dashboard.

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

COPYING A DASHBOARDTo 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 theActions 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 torename 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 createmultiple copies of a dashboard without renaming the copies, each new dashboard willhave a number added to its title, e.g. Dashboard (1), Dashboard (2).

CONFIGURING YOUR CONTRACT DASHBOARDNote: A maximum of 15 widgets can be displayed per dashboard.




3. Enter information as required in the relevant fields.







Note: Fields marked with an asterisk aremandatory.3. Click Save.

The widget is updated. Any changes are automatically deployed.

To remove a widget:



SHARING A CONTRACT DASHBOARDYou can share a personal dashboard tomake it available as a read-only dashboard for all other users who haveaccess 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 theActions button on the dashboard and select Share.

A confirmationmessage is displayed.3. Click OK to share the dashboard.

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

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 theActions button on the dashboard and select Unshare.

A confirmationmessage is displayed.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 hadpreviously added it to their Contract Dashboard.

DELETING CONTRACT DASHBOARDSDeleting a standard or shared dashboard removes it from your Contract Dashboard but it remains available andcan be added again if required.


Deleting a personal dashboard permanently deletes it.Note: Youmust have at least one personal dashboard. If you have only one, you cannot delete it until youcreate another.

Note: You cannot delete the default standard dashboard, if one has been set by the ProCon 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 theActions button on the dashboard and select Delete.A confirmationmessage is displayed.

3. Click OK to delete the dashboard.


REFERENCE: WIDGETSProConmanages a large amount of information relating to contractual risk, but this information is often onlyaccessible to users accessing contracts on a regular basis. The dashboards functionality uses ProCon AnalyticsandOData 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 ProCon, using a variety of configurable widgets, to display the data intables and charts in Business Unit and Contract level dashboards.This section details how to configure dashboard widgets in ProCon, as an administrator or a company user withtheBusiness Unit Dashboard Access user role permission.

SeeDashboard Maintenance for information specific to standard dashboards, layouts, and deploying widgettypes as a ProCon administrator.SeeWidget Dashboards (business unit level data) and The Contract Dashboard (contract level data) forinformation specific to company users.Also seeAccessing ProCon Analytics from External Applications for information about how to get data fromthe Analytics API into Microsoft Excel.

WIDGET TYPESDashboards can be configured in a variety of different ways using the various types of table and chart widgetswithin ProCon.

TablesSlicersCardsBar ChartsLine ChartsPie ChartsStacked Bar ChartsStacked Bar Charts with LimitHistorical DataTrendsText Widgets

Table WidgetsTable widgets display information from a specific datamodel, according to the specified REST URL and thecolumns selected in the table configuration.You can group and aggregate data as required, limit the number of records displayed, configure the datadisplayed 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 ClickedGroup By No change.

EnableDetailPanel

BroadcastFilterEvents

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 wasclicked.

EnableDetailPanel


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 wasclicked.Any widgets on the dashboard which are configured to receive filter events will befiltered according to the row selected and the column specified by Field toBroadcast.For example, if the Field to Broadcast is CommunicationState, when the tablewidget is filtered to show only data for a specific communication state (by clicking onthe row for that state), any receiving widgets such as bar and pie charts will be filteredto show only information for the same communication state.

EnableDetailPanel


Group By The table is replaced by the Detail View, which displays a table of data filteredaccording to the row that was clicked.For example, if the table is grouped by CommunicationState, clicking the row for thecount of Draft communications will open the Detail View to display the data forDraftcommunications only.SeeConfiguring the Detail View for more information.

EnableDetailPanel

-


Group By The row that was clicked is highlighted.Any widgets on the dashboard which are configured to receive filter events will befiltered according to the row selected and the column specified by Field toBroadcast.For example, if the Field to Broadcast is CommunicationState, when the tablewidget is filtered to show only data for a specific communication state (by clicking onthe row for that state), any receiving widgets such as bar and pie charts will be filteredto show only information for the same communication state.

EnableDetailPanel

-


Adding a Table WidgetTo add a table widget to a dashboard:


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


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 orbelow existing widgets. You can also resize the widget by dragging the edges to change the height orwidth.

Configuration Field DescriptionsNote: Fields marked with an asterisk aremandatory.

Field/Section DisplayedWhen

Description

Title The title of the widget.

Rest URL The URL of the data which will be used in the table widget.SeeSpecifying URLs 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 thecommunications, enter CommunicationState.SeeData Models and Columns for information about the columnswhich are available for each type of data.

AggregatedColumn(s)

A value isentered inGroup By.

Select the Type: Average, Count orSum.ForAverage andSum, enter theColumn Name for the column bywhich you want to aggregate the data.Tip: You can use the $filter option with the Rest URL toexclude zero values from calculated averages. For example, toexclude zero values for the average DaysToRespond forcommunications, use $filter=DaystoRespond gt 0. SeeSpecifying URLs for more information.

ForCount, theGroup By column is automatically used.SeeData Models and Columns for information about the columnswhich are available for each type of data.Click Add to addmore columns.

LimitRecords

A value isentered inGroup By.

Select how to limit the number of records which are displayed, basedon the value of theGroup By column:

None - all records are displayed.Top orBottom - the top or bottom X records are displayed, whereX is theRecord Count, e.g. the top 5 records.

Include TiedResults

Top orBottomis selected forLimit 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 samevalue as the 10th, all 12 records will be displayed.However, if the 5th and 6th records have the same value but the 10thhas a unique value, only 10 records are displayed.

RecordCount


The number of records (X) which are displayed.



Description

LimitColumn


The column on which the records are sorted to get the top or bottom Xrecords. The columnmust be listed in the Table Columns toDisplay.Tip: Column names can include the aggregate type, e.g. Count ofCommunicationState.

TableColumns toDisplay

The columns displayed in the table.If Aggregated Columns are specified, these are listed by default andcannot be removed or added to.Otherwise, enter theColumn Name for the column you want toinclude in the table display. Click Add to addmore columns.If desired, enter aDisplay Name for the column (e.g. a short name orfriendly name).

EnableDetail Panel

A value is notentered inGroup By.

Select to display drill-down data in the Detail Panel when the table isfiltered (by clicking a table row).See theOptions table above for what happens if Enable Detail Panelis not selected.

DetailsColumns

Enable DetailPanel isselected.

Enter theColumn Name for the column you want to include in theDetail Panel.Tip: Column names can include the aggregate type, e.g. Count ofCommunicationState.

Click Add to addmore columns.If desired, enter aDisplay Name for the column (e.g. a short name orfriendly name).

ReceiveFilter Events

Select to receive any broadcast filter events from other widgets. Thiswidget will be filtered based on the filter event received.For example, if the current widget shows the financial values of allcommunications, and a filter event is received from another widgetwhich has been filtered to show only data for a specificcommunication state, the current widget will be filtered by the samecommunication state.

BroadcastFilter Events

Select to broadcast any filters applied to the current widget. The valueof theGroup 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 CommunicationState, and is filtered to show only data for a specific communicationstate (by clicking on the relevant table row), any receiving widgets willbe filtered by the same communication state.

Field toBroadcast

BroadcastFilter Events isselected but noGroup Bycolumn isspecified.

The name of the columnwhich is used as the value for the filterevents.For example, if CommunicationState is entered, and the currentwidget is filtered to show only data for a specific communication state(by clicking on the relevant table row), any receiving widgets will befiltered by the same communication state.

Basic ConfigurationTo configure the table widget:


1. If necessary, clickEdit on the title bar of the widget to open its properties.Note: Fields marked with an asterisk aremandatory.

2. Enter the Title of the table widget.3. Enter theRest URL of the datamodel which will be used in the table, typically

https://YourServer/ProConAnalyticsAPI/datamodel where datamodel is:ContractsBreakdownItemsLineItemsCommunicationsCommunicationReviewsCommunicationLineItemsObligationsTendersScheduleItemsTenderReviewsStageGates

If necessary, customise the URL to select, filter, sort and limit the data - seeSpecifying URLs for moreinformation.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 theColumn Name for a column you want to include in the table display. Click Add to addmore

columns.b. If desired, enter aDisplay 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.

Grouping and Aggregating DataTo group the data:

1. In theGroup 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 Eventsis selected.

For example, to group communication data by the state of the communications, enter CommunicationState.SeeData Models and Columns for information about the columns which are available for each type of data.

2. Select the Type: Average, Count orSum.ForAverage andSum, enter theColumn 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. SeeSpecifying URLs for more information.

ForCount, theGroup By column is automatically used.SeeData Models and Columns for information about the columns which are available for each type of data.

3. Click Add to specify more aggregated columns.4. The list of Table Columns to Display automatically updates to include theGroup By column and all

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


Limiting the Displayed RecordsIf you have chosen to group your data (by specifying aGroup By column), you can limit the number of recordsdisplayed in the table. Limiting the records displayed also sorts the rows in the table by ascending/descendingorder.

To limit the number of records displayed:

1. From Limit Records, select:Top to show the first X records.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, evenif this means that more than X records are displayed.

3. Enter the number of records you want to display in theRecord 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 columnmust be listed in the Table Columns to Display. You can use aggregated columns, e.g. Sum ofTotalFinancialValue.

Detail Panel ConfigurationTo 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 notselected.

2. Specify the column you want to display by entering the following details:Column NameDisplay Name (e.g. a short name or friendly name)

3. Click Add to specify more columns.

Broadcasting and Receiving Filter EventsSeeConfiguring Widgets to Broadcast and Receive Filters.

ExampleBusiness Unit dashboard.Lists the projects in the business unit, with the number of contract communications in each project and theaverage value of the financial impact of the communications.


Field Value NotesTitle Project Breakdown The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Communications

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

Group By ProjectDepartmentName Groups the data by the name of theproject/dept - i.e. each row of the table is aproject/dept.

AggregatedColumns -Type

1. Count2. Average

1. Counts the number of records returned foreach project/dept.

2. Averages the values of theTotalFinancialImpactBase for thecommunications in each project/dept.

AggregatedColumns -ColumnName

1. -2. TotalFinancialImpactBase

LimitRecords

Optional Used to specify themaximum number ofrecords you want to include in the datashown.

TableColumns toDisplay -ColumnName

- The selectedAggregated Columns.

TableColumns toDisplay -Display Name

1. Project2. No of Comms3. Avg of Financial Impact

Optional display names.

Receive FilterEvents

Optional If selected, the data will be filtered accordingto the selection in a Slicer or Table widget thatbroadcasts filter events.


Optional If selected, and if a project/dept is selected inthe table (displayed in bold), widgets whichare set to receive filter events will show onlythe data for that project/dept.

Slicer WidgetsA slicer widget is a single-column table which is used to filter other widgets on the dashboard. It automaticallybroadcasts a filter event for the selected row to any widgets such as bar and pie charts which have beenconfigured to receive filter events (seeConfiguring Widgets to Broadcast and Receive Filters).


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

Adding a Slicer WidgetTo add a slicer widget to a dashboard:


2. Click the name of the widget you want to add to the dashboard.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 orbelow existing widgets. You can also resize the widget by dragging the edges to change the height orwidth.


Field/Section DescriptionTitle The title of the widget.

Rest URL The URL of the data which will be used in the table widget.SeeSpecifying URLs for more information.

Group By Enter the name of the column you want to show on the slicer widget, which will be used tofilter other widgets.For example, to be able to filter communication data on other widgets by the state of thecommunications, enter CommunicationState.SeeData Models and Columns for information about the columns which are availablefor each type of data.

DisplayName

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

Widget ConfigurationTo configure the slicer widget:



2. Enter the Title of the table widget.3. Enter theRest URL of the datamodel which will be used in the slicer widget, typically



Broadcasting Filter EventsThe slicer widget automatically broadcasts filter events when any of the rows in the table are clicked.SeeConfiguring Widgets to Broadcast and Receive Filters.

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

Field Value NotesTitle Tender Category Filter The title of the widget.


Field Value NotesRestURL

https://YourServer/ProConAnalyticsApi/Tenders

Returns data from the Tenders datamodel. No filterapplied on the URL.

GroupBy

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

DisplayName

Tender Category Optional display name.

Card WidgetsCard 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 WidgetTo add a card widget to a dashboard:





Rest URL The URL of the data which will be used in the card widget.SeeSpecifying URLs for more information.

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 automaticallyadded before the suffix.


Field/Section DescriptionAggregation Select the Type: Average, Count orSum.

ForAverage andSum, enter theColumn Name for the column by which you want toaggregate the data.Tip: You can use the $filter option with the Rest URL to exclude zero values fromcalculated averages. For example, to exclude zero values for the averageDaysToRespond for communications, use $filter=DaystoRespond gt 0. SeeSpecifying URLs for more information.

ForCount, the number of items which are returned by the REST URL is displayed - e.g.the total number of communications.SeeData Models and Columns for information about the columns which are availablefor each type of data.


Select to receive any broadcast filter events from other widgets. This widget will be filteredbased on the filter event received.For example, if the current widget shows the financial values of all communications, and afilter event is received from another widget which has been filtered to show only data for aspecific communication state, the current widget will be filtered by the samecommunication state.

Widget ConfigurationTo configure the card widget:


2. Enter the Title of the widget.3. Enter theRest URL of the datamodel which will be used in the widget, typically



4. Enter any Prefix and/orSuffix that you want displayed with the value on the card.5. In theAggregation section, select the Type (Average, Count orSum) and enter theColumn 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 EventsSeeConfiguring Widgets to Broadcast and Receive Filters.

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

Field Value NotesTitle Days Remaining on Contract The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Contracts

Returns data from the Contracts datamodel. No filterapplied on the URL.Because this is a Contract dashboard, only data forthe current contract is returned.

Prefix (leave blank)

Suffix (leave blank)

Aggregation -Type

Count Counts the number of records returned.

Aggregation -ColumnName

-


Optional If selected, the data will be filtered according to theselection in a Slicer or Table widget that broadcastsfilter events.

Bar Chart WidgetsBar chart widgets display information from a specific datamodel, according to the filters applied to the Rest URLfor 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 eventswhich apply to the chart.If aGroup By column is specified for the bar chart, the X axis of the chart displays the values from the specifiedGroup By column; the Y axis displays the values from the column selected forAggregation.


If aGroup 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 wasclicked. For example, if a bar chart is grouped by CommunicationState, clicking the bar for the count of Draftcommunications will open the Detail View to display the data forDraft communications only.SeeConfiguringthe Detail View for more information.Note: Drill-through on charts is not available to the ProCon administrator when creating and updating standarddashboards.

Note: Column names longer than 10 characters will be truncated.

Adding a Bar Chart WidgetTo add a bar chart widget to a dashboard:





Description


Rest URL The URL of the data which will be used in the chart widget.SeeSpecifying URLs for more information.

Group By Enter the name of a column by which you want to group the data.For example, to group communication data by the state of thecommunications, enter CommunicationState.SeeData Models and Columns for information about the columns whichare available for each type of data.

Aggregation A GroupBy columnisspecified.

Select the Type: Average, Count orSum.ForAverage andSum, enter theColumn Name for the column by whichyou want to aggregate the data.Tip: You can use the $filter option with the Rest URL to excludezero values from calculated averages. For example, to exclude zerovalues for the average DaysToRespond for communications, use$filter=DaystoRespond gt 0. SeeSpecifying URLs for moreinformation.

ForCount, theGroup By column is automatically used.SeeData Models and Columns for information about the columns whichare available for each type of data.



Description

Limit Order A GroupBy columnisspecified.

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

None - all records are displayed.Top orBottom - the top or bottom X records are displayed, where X istheRecord Count, e.g. the top 5 records.

RecordCount

Top orBottom isselectedfor LimitRecords.


Include TiedResults


Select to display all records which rank equally in the top or bottom X, evenif this means that more than X records are displayed.For example, if X is 10, and the 11th and 12th records have the same valueas the 10th, all 12 records will be displayed.However, if the 5th and 6th records have the same value but the 10th has aunique value, only 10 records are displayed.

AggregatedColumns

A GroupBy columnis notspecified.

Select the Type: Sum orAverage.Enter theColumn Names andDisplay Names for the columns by whichyou want to aggregate the data.Tip: You can use the $filter option with the Rest URL to excludezero values from calculated averages. For example, to exclude zerovalues for the average DaysToRespond for communications, use$filter=DaystoRespond gt 0. SeeSpecifying URLs for moreinformation.

SeeData Models and Columns for information about the columns whichare available for each type of data.

X Axis Title The text to be displayed as the title of the X axis of the bar chart.

Y Axis Title The text to be displayed as the title of the Y axis of the bar chart.


Select to receive any broadcast filter events from other widgets. Thiswidget will be filtered based on the filter event received.For example, if the current widget shows the financial values of allcommunications, and a filter event is received from another widget whichhas been filtered to show only data for a specific communication state, thecurrent widget will be filtered by the same communication state.

Widget ConfigurationTo configure the bar chart widget:


2. Enter the Title of the widget.3. Enter theRest URL of the datamodel which will be used in the chart, typically

https://YourServer/ProConAnalyticsAPI/datamodel where datamodel is:ContractsBreakdownItems


LineItemsCommunicationsCommunicationReviewsCommunicationLineItemsObligationsTendersScheduleItemsTenderReviewsStageGates


4. If you want to group the data by a single column:a. Enter the name of the column in theGroup By field.

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

b. In theAggregation section, select the Type (Average, Count orSum) and enter theColumn Name forthe column by which you want to aggregate the data (not required for Count).

5. If you want to view data for several columns, enter theColumn Names andDisplay Names for the columnsby which you want to aggregate the data. Click Add to addmore columns.

6. If desired, enter theX Axis Title andY Axis Title. If aGroup By column is specified and these are not set,the column names are used.

7. You can click Save to display a bar chart of all the data returned by the specified Rest URL and specifiedcolumns, or continue to refine your widget data before saving.

Limiting the Displayed RecordsIf aGroup By column has been specified, you can limit the number of records displayed in the chart, based on asort of the values of theGroup By column. Limiting the records displayed also sorts the data in the chart byascending/descending order.



Tip: Numeric values are sorted in ascending order (smallest first). Therefore, for columns which havenumeric values, youmust specify Bottom to get the records with the highest values or Top to get therecords with the lowest.

2. Enter the number of records you want to display in theRecord Count field.3. 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 .



ExampleBusiness Unit or Contract dashboard.Displays the total number of communications for each communication template.

Field Value NotesTitle Communications by Communication Template The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Communications?$filter=IsLatestRevisioneq 'Yes'

Returns data from theCommunications datamodel.

Filters by:

communication islatest revision

If this is a Contractdashboard, only datafor the currentcontract is returned.

Group By CommunicationTemplateTitle Groups the data bythe communicationtemplate - i.e. eachbar of the chart is acommunicationtemplate.

Aggregation- Type

Count Counts the number ofrecords returned foreach communicationtemplate.

Aggregation- ColumnName

-


Field Value NotesLimitRecords

Optional Used to specify themaximum number ofrecords you want toinclude in the datashown.

Axis Titles -X Axis Title

Communication Template Optional displayname.

Axis Titles -Y Axis Title

Count Optional displayname.

ReceiveFilterEvents

Optional If selected, the datawill be filteredaccording to theselection in a Slicer orTable widget thatbroadcasts filterevents.

Line Chart WidgetsLine chart widgets display information from a specific datamodel, according to the filters applied to the Rest URLfor the data, as a single line graph.You can group and aggregate the data as required, limit the number of records displayed, and receive filter eventswhich apply to the chart.The X axis of the chart displays the values from the specifiedGroup By column; the Y axis displays the valuesfrom the column selected forAggregation.Clicking a point on the line drills through to the Detail View, which displays a table of data filtered according to thepoint that was clicked . For example, if a line chart is grouped by CommunicationState, clicking the point for thecount of Draft communications will open the Detail View to display the data forDraft communications only.SeeConfiguring the Detail View for more information.Note: Drill-through on charts is not available to the ProCon administrator when creating and updating standarddashboards.

Note: Column names longer than 10 characters will be truncated.


Adding a Line Chart WidgetTo add a line chart widget to a dashboard:





Description



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 thecommunications, enter CommunicationState.SeeData Models and Columns for information about the columns whichare available for each type of data.

Aggregation Select the Type: Average, Count orSum.ForAverage andSum, enter theColumn Name for the column by whichyou want to aggregate the data.Tip: You can use the $filter option with the Rest URL to excludezero values from calculated averages. For example, to exclude zerovalues for the average DaysToRespond for communications, use$filter=DaystoRespond gt 0. SeeSpecifying URLs for moreinformation.


LimitRecords



RecordCount





Description

Include TiedResults



X Axis Title The text to be displayed as the title of the X axis of the line chart.

Y Axis Title The text to be displayed as the title of the Y axis of the line chart.



Widget ConfigurationTo configure the line chart widget:





4. In theGroup By field, 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.

5. In theAggregation section, select the Type (Average, Count orSum) and enter theColumn Name for thecolumn by which you want to aggregate the data (not required for Count).

6. If desired, enter theX Axis Title andY Axis Title. If these are not set, the column names are used.


7. You can click Save to display a line chart of all the data returned by the specified Rest URL and specifiedcolumns, or continue to refine your widget data before saving.

Limiting the Displayed RecordsYou can limit the number of records displayed in the chart, based on a sort of the values of theGroup By column.Limiting the records displayed also sorts the data in the chart by ascending/descending order.







ExampleBusiness Unit dashboard.Displays the total number of contracts for each project.

Field Value NotesTitle Contracts per Project The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Contracts

Returns data from the Contracts datamodel. No filterapplied on the URL.


Field Value NotesGroup By ProjectDepartmentName Groups the data by the project/dept - i.e. each point of

the chart is a project/dept.

Aggregation -Type

Count Counts the number of records returned for eachproject/dept.

Aggregation -ColumnName

-

LimitRecords

Optional Used to specify themaximum number of records youwant to include in the data shown.


Project Optional display name.

Axis Titles -Y Axis Title

Count Optional display name.


Optional If selected, the data will be filtered according to theselection in a Slicer or Table widget that broadcastsfilter events.

Pie Chart WidgetsPie chart widgets display information from a specific datamodel, according to the filters applied to the Rest URLfor the data, as a pie chart.If aGroup By column is specified for the pie chart, its sections are determined by theGroup By column, and thevalues displayed for them are determined by the column selected forAggregation.

If aGroup By column is not specified, the chart's sections are determined by the aggregated values from thecolumns selected for the chart. Each column corresponds to a section on the pie chart.


You can group and aggregate the data as required, limit the number of records displayed, and receive filter eventswhich apply to the chart.Clicking a section of the pie chart drills through to the Detail View, which displays a table of data filteredaccording to the section that was clicked. For example, if a pie chart is grouped by CommunicationState, clickingthe section for the count of Draft communications will open the Detail View to display the data forDraftcommunications only.SeeConfiguring the Detail View for more information.Note: Drill-through on charts is not available to the ProCon administrator when creating and updating standarddashboards.

Adding a Pie Chart WidgetTo add a pie chart widget to a dashboard:






Description



Group By Enter the name of a column by which you want to group the data.For example, to group communication data by the state of thecommunications, enter CommunicationState.SeeData Models and Columns for information about the columns whichare available for each type of data.

Aggregation A GroupBy columnisspecified.

Select the Type: Average, Count orSum.ForAverage andSum, enter theColumn Name for the column by whichyou want to aggregate the data.Tip: You can use the $filter option with the Rest URL to excludezero values from calculated averages. For example, to exclude zerovalues for the average DaysToRespond for communications, use$filter=DaystoRespond gt 0. SeeSpecifying URLs for moreinformation.


LimitRecords

A GroupBy columnisspecified.



RecordCount



Include TiedResults



AggregatedColumns

A GroupBy columnis notspecified.

Select the Type: Sum orAverage.Enter theColumn Names andDisplay Names for the columns by whichyou want to aggregate the data.Tip: You can use the $filter option with the Rest URL to excludezero values from calculated averages. For example, to exclude zerovalues for the average DaysToRespond for communications, use$filter=DaystoRespond gt 0. SeeSpecifying URLs for moreinformation.

SeeData Models and Columns for information about the columns whichare available for each type of data.



Description

Legend Title The text displayed as the title for the pie chart legend. If this is not set, theGroup By column name is used if it has been specified; otherwise the titleof the legend is left blank.



Widget ConfigurationTo configure the pie chart widget:





4. If you want to group the data by a single column:a. Enter the name of the column in theGroup By field.

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

b. In theAggregation section, select the Type (Average, Count orSum) and enter theColumn Name forthe column by which you want to aggregate the data (not required for Count).

5. If you want to view data for several columns, enter theColumn Names andDisplay Names for the columnsby which you want to aggregate the data. Click Add to addmore columns.

6. If desired, enter the Legend Title. If this is not set, theGroup By column name is used if it has beenspecified; otherwise the title of the legend is left blank.

7. You can click Save to display a pie chart of all the data returned by the specified Rest URL and specifiedcolumns, or continue to refine your widget data before saving.


Limiting the Displayed RecordsIf aGroup By column has been specified, you can limit the number of records displayed in the chart, based on asort of the values of theGroup By column. Limiting the records displayed also sorts the data in the chart byascending/descending order.






The sections in the chart are displayed in sorted order, depending on whether Top orBottom was selected.


ExampleBusiness Unit or Contract Dashboard.Displays the total number of overdue communications for each communication template.

Field Value NotesTitle Overdue Communications by Communication Template The title of the

widget.


Field Value NotesRest URL https://YourServer

/ProConAnalyticsApi/Communications?$filter=IsCommunicationOverdue eq 'Yes'

Returns datafrom theCommunicationsdatamodel.

Filters by:

communication is overdue

If this is aContractdashboard, onlydata for thecurrent contractis returned.

Group By CommunicationTemplateTitle Groups the databy thecommunicationtemplate - i.e.each segment ofthe pie chart is adifferentcommunicationtemplate.

Aggregation - Type

Count Counts thenumber ofrecords returnedfor eachcommunicationtemplate.

Aggregation - ColumnName

-

LimitRecords

Optional Used to specifythemaximumnumber ofrecords you wantto include in thedata shown.

LegendTitle

Communication Template Optional displayname.

ReceiveFilterEvents

Optional If selected, thedata will befiltered accordingto the selection ina Slicer or Tablewidget thatbroadcasts filterevents.


Stacked Bar Chart WidgetsStacked bar chart widgets display information for a single column from a specific datamodel, according to thefilters applied to the Rest URL for the data, grouped in bands of values.For example, you can display the number of communications which require response grouped by how many daysuntil they are due, in bands of 0-1 days until due, 2-4, 5-6, 7-8 and over 9 days.

Clicking a band of the bar drills through to the Detail View, which displays a table of data filtered according to theband that was clicked. For example, if a stacked bar chart showing the days that an obligation is overdue hasbands representing 10 days, clicking the band for 0-10 days will open the Details View to display the data only forobligations which have DaysOverdue values between 0 and 10. SeeConfiguring the Detail View for moreinformation.Note: Drill-through on charts is not available to the ProCon administrator when creating and updating standarddashboards.

You can receive filter events which apply to the chart.

Adding a Stacked Bar Chart WidgetTo add a stacked bar chart widget to a dashboard:



Configuration Field DescriptionNote: Fields marked with an asterisk aremandatory.



BandedColumn

Enter theColumn Name for the column for which you want to group values into bands.The values in the columnmust be numeric.If desired, enter aDisplay Name for the column (e.g. a short name or friendly name). Thisis used in the chart's key.SeeData Models and Columns for information about the columns which are availablefor each type of data.


Field/Section DescriptionBands Enter the Low andHigh values for each band.

If the Low value for the first band and theHigh value for the final band are left blank:

The first band contains all values below its High value.The final band contains all values above its Low value.

Click Add to addmore bands.ReceiveFilter Events


Widget ConfigurationTo configure the stacked bar chart widget:





4. In theBanded Column section, enter theColumn Name for the column for which you want to group valuesinto bands. The values in the columnmust be numeric.If desired, enter aDisplay Name for the column (e.g. a short name or friendly name). This is used in thechart's key.

5. In theBands section, enter the Low andHigh values for each band.Click Add to addmore bands.

6. You can click Save to display a stacked bar chart of all the data returned by the specified Rest URL andcolumn, or continue to refine your widget data before saving.



ExampleBusiness Unit or Contract dashboard.Displays the number of communications for each defined band of the number of days until the date that aresponse is due.

Field Value NotesTitle Communications Approaching Time

LimitThe title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Communications

Returns data from the Communications datamodel. No filter applied on the URL.If this is a Contract dashboard, only data for thecurrent contract is returned.

BandedColumn -ColumnName

DaysToResponseDueOnDate The data in the DaysToResponseDueOnDatecolumn is used to build the stacked bar chart.

BandedColumn -DisplayName

Days to Due Date Optional display name.

Bands - to 12 to 45 to 67 to 89 to -

Groups the values ofDaysToResponseDueOnDate into thespecified bands, and displays the number ofrecords in each band.Note: - indicates that the value should be leftblank.


Optional If selected, the data will be filtered according tothe selection in a Slicer or Table widget thatbroadcasts filter events.

Stacked Bar With Limit Chart WidgetsA Stacked Bar with Limit chart shows the relationship between values, either in reference to a specified limit or, ifno limit is specified, to each other. It can act as a doomsday chart for contract commitment or expenditure bydisplaying the components of the entire exposure. For example, Commitment Exposure is the ActualCommitment + Pending Commitment + Potential Commitment.


A running total of the exposure values is displayed next to the chart, to allow users to quickly see the impact thatpotential changes may have on their "bottom line".The way in which data is displayed in a Stacked Bar with Limit chart depends on whether a limit is specified:

Without a limit: The chart displays the percentage that each value contributes to a total across the selectedcolumns.With a limit: The chart displays the relationship of individual values to the specified limit.

new sshot needed

Adding a Stacked Bar Chart With Limit WidgetTo add a stacked bar chart with limit widget to a dashboard:






Limit TheColumn Name for the columnwhich contains the value which will be displayed as alimit line on the bar chart. Leave blank to have no limit line.If desired, enter aDisplay Name for the column (e.g. a short name or friendly name).SeeData Models and Columns for information about the columns which are availablefor each type of data.

ColumnswithNumericValues

Select the Type of aggregation required for the columns: Sum orAverage.Enter theColumn Name for the columnwith the numeric values that you want to displayin the Stacked Bar chart.If desired, enter aDisplay Name for the column (e.g. a short name or friendly name).Click Add to addmore columns.SeeData Models and Columns for information about the columns which are availablefor each type of data.

Y Axis Title The text to be displayed as the title of the Y axis of the chart.




Widget ConfigurationTo configure the stacked bar chart widget:


2. Enter the Title of the chart widget.3. Enter theRest URL of the datamodel which will be used in the chart, typically


Customise the URL to specify the values you want to display - seeSpecifying URLs 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. In the Limit field, optionally enter theColumn Name for the columnwhich will be displayed as the limit lineon the chart.If desired, enter aDisplay Name for the column (e.g. a short name or friendly name).

5. If aggregation of values is required, select the Type (Average orSum). This aggregation will apply to all thecolumns specified for the chart.Leave the Type as blank if you do not want to aggregate values.

6. Specify the values you want to display by entering the following details in theColumns With NumericValues section:

Column NameDisplay Name (e.g. a short name or friendly name)

Click Add to specify more columns.7. You can click Save to display a chart of all the data returned by the specified Rest URL, or continue to refine

your widget data before saving.


ExampleBusiness Unit or Contract dashboard.Displays the values for the specified columns as a stacked bar with a limit line - in this case, the ApprovedFinancial Commitment, Pending Contract Change and Potential Contract Change breakdown, with a limit of thecontract Not to Exceed value.


Field Value NotesTitle Contract Change Exposure The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Contracts?$filter=ContractStatene 'Closed'

Returns data from theContracts datamodel.

Filters by:

contract state is notClosed

If this is a Contractdashboard, the filter is notneed; only data for the currentcontract is returned.

Limit -Column Name

NotToExceedBase The value which will bedisplayed as a black limit lineon the chart.

Limit - DisplayName

NTE Optional display name.

Columns withNumericValues - Type

Sum For a Business Unitdashboard, sums the valuesfor the contracts in eachproject/dept.For a Contract dashboard,only the values for thatspecific contract are used.


Field Value NotesColumns withNumericValues -Column Name

1. ApprovedFinancialCommitmentBase2. PendingFinancialCommitmentBase3. PotentialFinancialCommitmentBase

The selectedAggregatedColumns.

Columns withNumericValues -Display Name

1. Approved Financial Commitment2. Pending Contract Change3. Potential Contract Change


Y Axis Title - Optional display name.


Optional If selected, the data will befiltered according to theselection in a Slicer or Tablewidget that broadcasts filterevents.

Historical Data WidgetsHistorical data widgets are used to view trends, in order to mitigate risk and check the health of processes. Forexample, an historical data widget can display the total number of overdue obligations per month for thepreceding year. The widget displays a bar chart of the count of records in a datamodel over a specific date range.Each bar on the chart represents a configured time period, e.g. a day or month.

Note: If ProCon is configured to use Snapshot data, no historical data is returned and no useful values areshown on this widget. SeeUsing Historical Data for more information.

Clicking a bar drills through to the Detail View, which displays a table of data filtered according to the bar that wasclicked. For example, clicking the bar for the count of overdue obligations in June 2015 will open the Detail Viewto display the data for only the obligations which became overdue in that month. SeeConfiguring the DetailView for more information.

Adding an Historical Data WidgetTo add an historical data widget to a dashboard:





Field/Section Displayed When DescriptionTitle The title of the widget.

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

Interval Select whether to display the data with intervals of months or days.

Use RelativeDates

Select to compare the current data with data from a set number ofmonths or days ago, depending on the selected Interval.

ComparisonPeriod

Use RelativeDates is selected.

The number of months or days of data that you want to view.

Start Date Use RelativeDates is notselected.

The start date of the historical data to be used in the widget, in theformat YYYY-MM-DD.

End Date Use RelativeDates is notselected.

The end date of the historical data to be used in the widget, in theformat YYYY-MM-DD.

X Axis Title The text to be displayed as the title of the X axis of the chart.

Y Axis Title The text to be displayed as the title of the Y axis of the chart.

Widget Configuration If Using Relative DatesTo configure the historical data widget if using relative dates:


2. Enter the Title of the historical data widget.3. Enter theRest URL of the datamodel which will be used, typically

https://YourServer/ProConAnalyticsAPI/datamodel where datamodel is:ContractsBreakdownItemsLineItemsCommunicationsCommunicationReviewsCommunicationLineItemsObligationsTendersScheduleItems


TenderReviewsStageGates


4. Select the Interval for the data:Months orDays.5. Select Use Relative Dates.6. Enter theComparison Period for the chart, as the number of months or days for which you want to see the

data.7. If desired, enter theX Axis Title andY Axis Title.8. Click Save.

The widget is updated.

Widget Configuration If Not Using Relative DatesTo configure the historical data widget if not using relative dates:


2. Enter the Title of the historical data widget.3. Enter theRest URL of the datamodel which will be used, typically



4. Customise the URL to specify the values you want to display - seeSpecifying URLs for more information.5. Select the Interval for the data:Months orDays.6. Ensure that Use Relative Dates is not selected.7. Enter theStart Date andEnd Date for the chart, in the format YYYY-MM-DD.8. If desired, enter theX Axis Title andY Axis Title.9. Click Save.


ExampleBusiness Unit or Contract dashboard


Displays the total number of overdue obligations, for eachmonth for the previous 12months.

Field Value Notes

Title OverdueObligations Historical View The title of the widget.

Rest URL https://YourServer/ProConAnalyticsApi/Obligations?$filter=State ne'Completed' and ContractObligationIsOverdue eq'Yes'

Returns data from theObligations datamodel.Filters by:

obligation state is notCompletedobligation is overdue

If this is a Contract dashboard,only data for the currentcontract is returned.

Interval Months

UseRelativeDates

Yes Use relative dates for thecomparison period.If not selected, exact datesmust be supplied.

ComparisonPeriod

12 Data will be displayed for theprevious 12months (Interval).

X Axis Title Month(s) Optional display name.

Y Axis Title Count Optional display name.

Trend WidgetsTrend widgets provides the user with a snapshot of a particular metric, and context as to how this value haschanged in a specified time period. For example, a trend widget can display the number of overdue obligations,with an arrow which indicates whether this number has increased or decreased in the preceding six months.The widget also displays the percentage increase or decrease and the original value, and if relative dates areused, the time period.You can select whether the arrow displays upward and downward trends as positive, negative or neutral - thisaffects the colour of the arrow.


Upward = Positive Upward = Negative

Trend widgets can receive filter events from table and slicer widgets. These filters are applied automatically tothe values displayed in the widget.Note: If ProCon is configured to use Snapshot data, no historical data is returned and no useful values areshown on this widget. SeeUsing Historical Data for more information.

Clicking the value displayed on the widget drills through to the Detail View, which shows a table with the data forthe entities which are included in the number displayed in the widget. For example, if the widget shows thenumber of overdue obligations, the Details View displays only those obligations which are overdue.SeeConfiguring the Detail View for more information.Note: Drill-through on charts is not available to the ProCon administrator when creating and updating standarddashboards.

Adding a Trend WidgetTo add a trend widget to a dashboard:





Description


Use RelativeDates

Select to compare the current data with data from a set number of days ormonths ago, e.g. from 30 days or 12months ago.

Baseline -Rest URL

The URL of the data which provides the baseline for the comparison. Ifrelative dates are used, the current data is taken. Otherwise, a date couldbe specified in the Rest URL.



Description

Comparison-Rest URL

UseRelativeDates isnotselected.

The URL of the data which provides the comparison.

Comparison-CompareWith

UseRelativeDates isselected.

Specify the age of the date to use as the comparison, in days or months.

Aggregation Select the Type (Average, Count orSum) and enter the name of theColumn for which you want to aggregate the data (not required for Count).

TrendHighlighting-RepresentTrending UpAs

Select how the trending arrow is displayed:

Neutral -The upward and downward arrows and the NoChangeindicator are displayed in black.Positive - An upward trend is considered positive and shown in green.The downward arrow is red and the NoChange indicator is amber.Negative - An upward trend is considered negative and shown in red.The downward arrow is green and the NoChange indicator is amber.



Widget Configuration If Using Relative DatesTo configure the trend widget if using relative dates:


2. Enter the Title of the trend widget.3. Select Use Relative Dates.4. For the Baseline, enter theRest URL of the datamodel which will be used, typically




5. For theComparison, specify the number of days or months previous to the current date.6. In theAggregation section, select the Type (Average, Count orSum) and enter theColumn Name for the

column by which you want to aggregate the data (not required for Count).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. SeeSpecifying URLs for more information.

7. Select whether toRepresent Upwards Trending As neutral, positive or negative. This determines how thetrending arrow is displayed.

8. Click Save.The widget is updated.

Widget Configuration If Not Using Relative DatesTo configure the trend widget if not using relative dates:


2. Enter the Title of the trend widget.3. Ensure that Use Relative Dates is not selected.4. For theBaseline andComparison points of the data:

a. Enter theRest URL of the datamodel which will be used, typicallyhttps://YourServer/ProConAnalyticsAPI/datamodel where datamodel is:

ContractsBreakdownItemsLineItemsCommunicationsCommunicationReviewsCommunicationLineItemsObligationsTendersScheduleItemsTenderReviewsStageGates

b. Customise the URL to specify the values you want to display - seeSpecifying URLs for moreinformation.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.

5. In theAggregation section, select the Type (Average, Count orSum) and enter theColumn Name for thecolumn by which you want to aggregate the data (not required for Count).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. SeeSpecifying URLs for more information.

6. Select whether toRepresent Upwards Trending As neutral, positive or negative. This determines how the


trending arrow is displayed.7. Click Save.



ExampleBusiness Unit dashboard.Displays the total number of active contracts in the business unit. A trend arrow and the percentageincrease/decrease shows indicates a change in the number of records compared to 1month before.

Field Value NotesTitle Total Active Contracts The title of the

widget.

UseRelativeDates

Yes Use relative datesfor thecomparisonperiod.If not selected,exact dates mustbe supplied.

Baseline -Rest URL

https://YourServer/ProConAnalyticsApi/Contracts?$filter=ContractState ne 'Closed'

Returns data fromthe Contractsdatamodel.Filters by:

contract stateis not Closed

Comparison -CompareWith

1Month The comparisonperiod for thetrend arrow andpercentageincrease/decrease.


Field Value NotesAggregation - Type

Count Counts thenumber of recordsreturned.


-

TrendHighlighting -RepresentUpwardTrend as

Positive An increase in thenumber of recordsis shown as apositive trend(green arrow).

ReceiveFilterEvents

Optional If selected, thedata will befiltered accordingto the selection ina Slicer or Tablewidget thatbroadcasts filterevents.

Text WidgetsText widgets display user-entered information about the dashboard, for example to inform other users of a shareddashboard about who created the dashboard, the filters used, and any further information about the displayeddata.

Adding a Text WidgetTo add a text widget to a dashboard:





Field/Section DescriptionText The text you want to display in the widget. A maximum of 255 characters is allowed.

Note: You canmanually enter line breaks or adjust the size of the widget to ensure alltext is displayed.

Font Size Select the size of text to be displayed. All text is displayed at this size.

Bold Select if you want all text to be displayed as bold.

Widget ConfigurationTo configure the text widget:


2. Enter the Text of the widget.Note: You canmanually enter line breaks or adjust the size of the widget to ensure all text is displayed.

3. Change the Font Size if required.4. Select Bold if you want to display the text as bold.5. Click Save.

ExampleBusiness Unit or Contract dashboard.Displays the entered text.

Field/Section Value NotesText Please note that this dashboard only displays

obligationswhich are not linked to a communication.

For details of communication obligations,see the Communication Response TimeDashboard.

The text to display in thewidget.

Font Size 16px Text size

Bold No Text is not displayed as bold.

SPECIFYING URLSThe Rest URL for a widget is specified as https://YourServer/ProConAnalyticsAPI/datamodel where datamodelis one of:

ContractsBreakdownItems


LineItemsCommunicationsCommunicationReviewsCommunicationLineItemsObligationsTendersScheduleItemsTenderReviewsStageGates

Further options can be added to the URL to restrict, filter, sort and limit the data for use before it is used by thewidget, regardless of the options selected in the widget configuration. These options are based on theOData 4.0standard:http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part2-url-conventions/odata-v4.0-errata02-os-part2-url-conventions-complete.htmlTheseOData options can also be used when specifying the REST URL for use in a third-party solution.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.

Returning a Count of RecordsYou can use $count=true to get the number of records in a collection.Example:

https://YourServer/ProConAnalyticsApi/Contracts?$count=true

Selecting Specific Data to ReturnThe columns included in the data can be restricted to only those specified with $select. This can improveperformance.Warning: The $select cannot be used when specifying URLs for widgets on ProCon dashboards.

Example:

https://YourServer/ProConAnalyticsApi/Contracts?$select=ContractName,ContractType,ContractState,AwardValueBase,ProjectDepartmentName

Note: Any columns you want to use in the widget configuration as the Group By column or AggregatedColumns must be included.

Filtering the Returned DataBy using $filter in the Rest URL, you can filter the data used in the widget for specific values, e.g. for one ormore communication states, or for contracts which have a Not to Exceed value.See http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part2-url-conventions/odata-v4.0-errata02-os-part2-url-conventions-complete.html#_Toc406398094 for more details about each option.The options which can be used are:

eq concat year

ne and month

http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part2-url-conventions/odata-v4.0-errata02-os-part2-url-conventions-complete.html

http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part2-url-conventions/odata-v4.0-errata02-os-part2-url-conventions-complete.html

http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part2-url-conventions/odata-v4.0-errata02-os-part2-url-conventions-complete.html#_Toc406398094

http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part2-url-conventions/odata-v4.0-errata02-os-part2-url-conventions-complete.html#_Toc406398094


gt or day

lt not hour

ge contains minute

le endswith second

() startswith fractionalseconds

add length date

sub indexof time

- substring now

mul toupper round

div tolower floor

mod trim ceiling

Examples:

https://YourServer/ProConAnalyticsApi/Communications?$filter=(CommunicationStatene 'Draft' orCommunicationState ne 'Approved %26 Awaiting Agreement') and DaysTakenToRespondne null

https://YourServer/ProConAnalyticsApi/Contracts?$filter=ContractType eq'Standard' andContractState ne 'Closed' and NotToExceedBase ne null

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. SeeSpecifying URLs for more information.

Sorting and Limiting the Returned DataAlthough table and chart widgets can be configured to limit the data displayed, for example to the top ten recordsby a particular value, this functionality can only be used in these widgets and only if you have selected aGroupBy column and any Aggregated Columns.You can sort the data used by any widget by using the $orderby option in the Rest URL:

$orderby=ColumnName asc - sorts the data by the values inColumnName in ascending order.$orderby=ColumnName desc - sorts the data by the values inColumnName in descending order.

You can limit the data used by any widget by using $top=X to return the top X records according to the appliedsorting option.You can also skip the first Y records returned, using $skip=Y. For example, if Y = 10, only records 11 to 20 arereturned.Note: Where both $top and $skip are used, $skip is applied before $top.

Examples:

https://YourServer/ProConAnalyticsApi/Contracts?$filter=ContractType eq'Standard' andContractState ne 'Closed'&$orderby=AwardValueBase desc&$top=10

https://YourServer/ProConAnalyticsAPI/Communications?$orderby=DaysSinceCreateddesc

https://YourServer


/ProConAnalyticsAPI/Communications?$filter=CommunicationTemplateAbbreviationeq 'SI'&$orderby=DaysSinceCreated desc

CONFIGURING THE DETAIL VIEWThe Detail View is displayed when you click an area of a chart to drill through to data, which is filtered accordingto the area clicked on. For example, if a bar chart is grouped by CommunicationState, clicking the bar for thecount of Draft communications will open the Detail View to display the data forDraft communications only.

By default:

The Detail View displays all the columns for the datamodel, except for the ID.Each column is labelled with its name in the datamodel.The width of each column is set to the length of the column name.

SeeData Models and Columns for a complete list of all columns.

Click a row to drill down to the specific entity such as the contract, communication, review, obligation, tender orschedule item, if you have permission to access it.Note: ProCon Support can configure the following for the Detail View:

The columns displayed can be restricted to a specific subset.Friendly display names (aliases) can be used for columns instead of the default column label.The width of each column in the Detail View can be specified.

Using the Detail View Data ExternallyThere are twomethods of accessing the data currently displayed in the Detail View for use in an externalapplication:

You can export the data to aMicrosoft Excel spreadsheet. ClickExport and open or save the file.TheOData Feed URL is displayed at the bottom of the page and can be copied for use in externalapplications such as Power BI. The URL includes all the filters applied to the data currently displayed in theDetail View.SeeAccessing ProCon Analytics from External Applications for more information.

CONFIGURING WIDGETS TO BROADCAST AND RECEIVE FILTERSTable widgets can be configured to broadcast to other widgets on the same dashboard when the data theycontain is filtered (by clicking on a row). Slicer widgets broadcast automatically when their data is filtered.Table, chart and trend widgets can be configured to receive filter events from a broadcasting table, and filter theirown data accordingly.Note: Only one broadcasting slicer or table widget is active at a time on a dashboard.

ExampleUnfilteredThe table displays the number of communications in each project/dept in the Business Unit, taken from theCommunications dataset.The pie chart displays the number of overdue communication reviews for each communication template used inthe Business Unit, taken from the CommunicationReviews dataset.


FilteredThe user has clicked on a specific project/dept (now shown in bold text) and the pie chart has been filtered toshow data for only that project/dept.Tip: This is possible because the ProjectDepartmentName column exists in both datasets.

ConfigurationTo configure a table or slicer widget to broadcast filter events:

1. If necessary, clickEdit on the title bar of the widget to open its properties.2. Select Broadcast Filter Events.3. Click Save.

Now when the table is filtered, any widgets on the same dashboard which are configured to receive filterevents will also be filtered.

To configure a table, chart or trend widget to receive filter events:

1. If necessary, clickEdit on the title bar of the widget to open its properties.2. Select Receive Filter Events.3. Click Save.

Now when a table on the same dashboard is filtered, the widget will also be filtered.

USING HISTORICAL DATAProCon Support can configure the ProCon data to use one of the followingmodes:


SnapshotNo historical data is available although the data in the widgets continues to be updated in near real time.Historical and trend widgets therefore do not show any useful values.HistoricalHistorical data is available for use in historical and trend widgets, and is updated in near real time. Calculatedvalues such as Days Overdue are recalculated once per day.

ACCESSING PROCON ANALYTICS FROM EXTERNAL APPLICATIONSThe same data displayed in ProCon dashboards and widgets can also be used in external applications such asMicrosoft Excel or Power BI. The data is accessed using the Analytics API, also referred to as the OData feed.To authenticate your user when accessing the Analytics API, you need an API key (access token). This can begenerated in ProCon on the User Settings page. It is unique for your user and is valid for 30 days from generation.The value of the API key is then used in queries from the external application.

Example - Microsoft Excel Power QueryTo avoid having to set your API key in every query you create and then update it in every query when it expires,you can create a single query which contains the API key, and then reference it in the queries which specify theAnalytics data you need.A similar method can be used for Power BI.

To set up queries in Excel which reference your ProCon API key:

1. Log in to ProCon and generate and copy your unique API key.2. Open a blank Excel workbook.3. On the Data tab of the ribbon, click Get Data and select From Other Sources > Blank Query.

Warning: Do not select From OData Feed.The Power Query editor window is displayed.

4. In the new blank query, paste the text of your API key.5. Rename the query as APIKey.

6. On the Home tab of the ribbon, click Close and Load.The query is created and can now be referenced from other queries.This allows you to easily update your API key in a single query when it expires rather than needing to edit allof them.

7. Create another blank query: on the Data tab of the ribbon, click Get Data and select From Other Sources >


Blank Query.8. Paste the following into the query:

= OData.Feed("URL", null, [Headers = [Authorization = "Bearer " & APIKey ] ])

where URL is the full REST URL of the data you want to return in your query, e.g.https://YourServer/ProConAnalyticsAPI/Contracts. SeeSpecifying URLs for more details.AnOData Feed URL can also be copied from the Detail View of a widget in ProCon - seeConfiguring theDetail View.

9. A message is displayed asking you to specify how to connect. Click Edit Credentials.10. On theOData window, ensureAnonymous is selected in the left-hand list.11. Select https://YourServer/ProConAnalyticsAPI as the level to apply the settings to.

12. Click Connect. The credentials are checked.13. Click Close and Load to save and run the query.

DATA MODELS AND COLUMNSEach widget contains information from one of the following datamodels:

ContractsBreakdownItemsLineItemsCommunicationsCommunicationReviewsCommunicationLineItemsObligationsTendersScheduleItemsTenderReviewsStageGates

ContractsThe following table lists the fields which are available in the Contracts datamodel.Any contract and contractor custom fields which have been configured by the ProCon administrator are alsoavailable and can be used according to their type. The column names for custom fields are prefixed as follows:


Contract_Custom_Field_, e.g. Contract_Custom_Field_HSSEContractor_Custom_Field_, e.g. Contractor_Custom_Field_Local

Note: The base currency of the data is configured when ProCon Analytics is installed.

Field Name Type Description ValuesContractName String The name of the contract.

ContractReference String The unique reference forthe contract.

ContractType String The type of the contract. StandardCall OffFrameworkAgreement

ContractState String The state of the contract. In progressOverdueClosed

ContractCategory String The category of thecontract.

IsDeleted String Indicates whether thecontract is in the RecycleBin.

YesNo

AwardDate DateTime

The date that the contractwas awarded.

StartDate DateTime

The start date of thecontract.

OriginalEndDate DateTime

The end date of thecontract specified whenthe contract was created.

PlannedEndDate DateTime

The current planned enddate of the contract.

ContractCurrency String The base currency of thecontract.

AwardValue Decimal The award value of thecontract in the contractcurrency.

AwardValueBase Decimal The award value of thecontract in the basecurrency of the data.

ApprovedBudgetValue Decimal The approved budget ofthe contract in the contractcurrency.

ApprovedBudgetValueBase Decimal The approved budget ofthe contract in the basecurrency of the data.

InitialNotToExceed Decimal The Initial Not to Exceedvalue of the contract in thecontract currency.


Field Name Type Description ValuesInitialNotToExceedBase Decimal The Initial Not to Exceed

value of the contract in thebase currency of the data.

NotToExceed Decimal The Not to Exceed valueof the contract in thecontract currency.

NotToExceedBase Decimal The Not to Exceed valueof the contract in the basecurrency of the data.

ApprovedExpenditure Decimal The approved expenditurevalue of the contract in thecontract currency.

ApprovedExpenditureBase Decimal The approved expenditurevalue of the contract in thebase currency of the data.

PendingExpenditure Decimal The pending expenditurevalue of the contract in thecontract currency.

PendingExpenditureBase Decimal The pending expenditurevalue of the contract in thebase currency of the data.

PotentialExpenditure Decimal The potential expenditurevalue of the contract in thecontract currency.

PotentialExpenditureBase Decimal The potential expenditurevalue of the contract in thebase currency of the data.

ApprovedFinancialCommitment Decimal The approved changevalue plus the award valueof the contract in thecontract currency.

ApprovedFinancialCommitmentBase Decimal The approved changevalue plus the award valueof the contract in the basecurrency of the data.

PendingFinancialCommitment Decimal The pending commitmentvalue of the contract in thecontract currency.

PendingFinancialCommitmentBase Decimal The pending commitmentvalue of the contract in thebase currency of the data.

PotentialFinancialCommitment Decimal The potential commitmentvalue of the contract in thecontract currency.

PotentialFinancialCommitmentBase Decimal The potential commitmentvalue of the contract in thebase currency of the data.


Field Name Type Description ValuesApprovedContractChanges Decimal The approved change

value of the contract in thecontract currency.

ApprovedContractChangesBase Decimal The approved changevalue of the contract in thebase currency of the data.

HasActiveAlerts String Indicates whether thecontract has any activealerts.

ProjectDepartmentName String The reference and name ofthe project/dept in whichthe contract is located.

BusinessUnitId Int32 The unique ID of thebusiness unit in which thecontract is located.

CountryName String The country in which thecontract operates.

ContractorRef String The unique reference forthe contractor.

ContractorName String The name of thecontractor.

ParentFrameworkAgreementName String Call off contracts only.The name of the parentframework agreement.

ParentFrameworkAgreementReference String Call off contracts only.The unique reference forthe parent frameworkagreement.

CompanyRepresentative String The name of the companyuser assigned to theCompany Representativecontract role.

ContractOwner String The name of the companyuser assigned to theContract Owner contractrole.

ContractorRepresentative String The name of the contractoruser assigned to theContractor Representativecontract role.

TotalCommitmentExposure Decimal The total commitmentvalue in the contractcurrency: AwardValue +PotentialCommitment +PendingCommitment +ApprovedCommitment


Field Name Type Description ValuesTotalCommitmentExposureBase Decimal The total commitment

value in the base currencyof the data:AwardValueBase +PotentialCommitmentBase +PendingCommitmentBase+ApprovedCommitmentBase

TotalExpenditureExposure Decimal The total expenditure inthe contract currency:PotentialExpenditure +PendingExpenditure +ApprovedExpenditure

TotalExpenditureExposureBase Decimal The total expenditure inthe base currency of thedata:PotentialExpenditureBase+PendingExpenditureBase+ApprovedExpenditureBase

ContractCreatedBy String The name of the user whocreated the contract.

ContractCreatedOn DateTime

The date and time that thecontract was created.

ContractClosedOn DateTime

The date and time that thecontract was closed.

BusinessUnitName String The name of the businessunit in which the contractis located.

ContractAdministrators String A list of users assigned tothe Contract Administratorcontract role.

BreakdownItemCommitment Decimal The sum of the approvedcommitment of allbreakdown items in thecontract, in the contractcurrency.

BreakdownItemCommitmentBase Decimal The sum of the approvedcommitment of allbreakdown items in thecontract, in the basecurrency of the data.


Field Name Type Description ValuesBreakdownItemCommitmentDifference Decimal The difference between

the approved contractcommitment and the sumof the approvedcommitment of allbreakdown items in thecontract, in the contractcurrency.

BreakdownItemCommitmentDifferenceBase

Decimal The difference betweenthe approved contractcommitment and the sumof the approvedcommitment of allbreakdown items in thecontract, in the basecurrency of the data.

ContractCommitmentFullyAllocated String Indicates whether thecontract commitment isfully allocated tobreakdown and line items:

N/A - The contractdoes not havebreakdown or lineitems.Yes - The sum of theapproved commitmentof all contract lineitems = the sum of theapproved commitmentof all breakdown items= the approvedcontract commitmentNo - The sum of theapproved commitmentof all contract lineitems, the sum of theapproved commitmentof all breakdown items,and the approvedcontract commitmentare not all equal.

N/AYesNo

LineItemCommitment Decimal The sum of the approvedcommitment of all lineitems in the contract, inthe contract currency.

LineItemCommitmentBase Decimal The sum of the approvedcommitment of all lineitems in the contract, inthe base currency of thedata.


Field Name Type Description ValuesDaysRemainingOnContract Int32 The difference between

the current date and thePlanned End date of thecontract.

MethodOfCommunication String Indicates whether thecontractor is using theProCon Contractor Portal(Contractor toCommunicate via ProConExtranet) or anothermethod of communication(Contractor toCommunicate via othermeans).

Contractor toCommunicate via ProConExtranetContractor toCommunicate via othermeans

Breakdown ItemsThe following table lists the fields which are available in the BreakdownItems datamodel.Note: The base currency of the data is configured when ProCon Analytics is installed.

Field Name Type DescriptionContractId Int32 The unique ID of the contract to which the

breakdown items belong.

ContractName String The name of the contract.

ContractReference String The unique reference for the contract.

ProjectDepartmentName String The name of the project/dept in which thecontract is located.

BusinessUnitId Int32 The unique ID of the business unit in whichthe contract is located.

CountryName String The country in which the contract operates.

ContractorReference String The unique reference for the contractor.

ContractorName String The name of the contractor.

CompanyRepresentative String The name of the company user assigned tothe Company Representative contract role.

ContractOwner String The name of the company user assigned tothe Contract Owner contract role.

ContractorRepresentative String The name of the contractor user assigned tothe Contractor Representative contractrole.

BreakdownItemName String The name of the breakdown item.

BreakdownItemReference String The reference of the breakdown item.

InitialCommitmentValueBase Decimal The initial commitment value of thebreakdown item, in the base currency of thedata.

InitialCommitmentValue Decimal The initial commitment value of thebreakdown item, in the breakdown itemcurrency.


Field Name Type DescriptionApprovedCommitmentValueBase Decimal The approved commitment value of the

breakdown item, in the base currency of thedata.

ApprovedCommitmentValue Decimal The approved commitment value of thebreakdown item, in the breakdown itemcurrency.

ApprovedExpenditureValueBase Decimal The approved expenditure value of thebreakdown item, in the base currency of thedata.

ApprovedExpenditureValue Decimal The approved expenditure value of thebreakdown item, in the breakdown itemcurrency.

PendingExpenditureValueBase Decimal The pending expenditure value of thebreakdown item, in the base currency of thedata.

PendingExpenditureValue Decimal The pending expenditure value of thebreakdown item, in the breakdown itemcurrency.

PotentialExpenditureValueBase Decimal The potential expenditure value of thebreakdown item, in the base currency of thedata.

PotentialExpenditureValue Decimal The potential expenditure value of thebreakdown item, in the breakdown itemcurrency.

PendingCommitmentValueBase Decimal The pending commitment value of thebreakdown item, in the base currency of thedata.

PendingCommitmentValue Decimal The pending commitment value of thebreakdown item, in the breakdown itemcurrency.

PotentialCommitmentValueBase Decimal The potential commitment value of thebreakdown item, in the base currency of thedata.

PotentialCommitmentValue Decimal The potential commitment value of thebreakdown item, in the breakdown itemcurrency.

CommitmentExposureValueBase Decimal The total commitment value of thebreakdown item, in the base currency of thedata:PotentialCommitmentValueBase +PendingCommitmentValueBase +ApprovedCommitmentValueBase

CommitmentExposureValue Decimal The total commitment value of thebreakdown item, in the breakdown itemcurrency:PotentialCommitmentValue +PendingCommitmentValue +ApprovedCommitmentValue


Field Name Type DescriptionExpenditureExposureValueBase Decimal The total expenditure of the breakdown

item, in the base currency of the data:PotentialExpenditureValueBase +PendingExpenditureValueBase +ApprovedExpenditureValueBase

ExpenditureExposureValue Decimal The total expenditure of the breakdownitem, in the breakdown item currency:PotentialExpenditureValue +PendingExpenditureValue +ApprovedExpenditureValue

Currency String The currency of the breakdown item.

BusinessUnitName String The name of the business unit in which thecontract is located.

ContractAdministrators String A list of users assigned to the ContractAdministrator contract role.

CreatedOnDate DateTime The date and time that the breakdown itemwas created.

OverconsumedAmount Decimal The amount by which the breakdown itemhas been overconsumed, in the breakdownitem currency:ApprovedCommitmentValue -ApprovedExpenditureValue

OverconsumedAmountBase Decimal The amount by which the breakdown itemhas been overconsumed, in the basecurrency of the data:ApprovedCommitmentValueBase -ApprovedExpenditureValueBase

BreakdownItemCommitmentFullyAllocated String Indicates whether the breakdown itemcommitment is fully allocated to line items,i.e. if the approved commitment for thecontract's line items is equal to theapproved commitment for the contract'sbreakdown items.Possible values are Yes and No.

UnallocatedBreakdownItemCommitment Decimal The amount of the breakdown item whichhas not been allocated to line items, in thebreakdown item currency:ApprovedCommitmentValue of all lineitems associated with the breakdown item(converted to the breakdown item currency)- ApprovedCommitmentValue of thebreakdown item


Field Name Type DescriptionUnallocatedBreakdownItemCommitmentBase Decimal The amount of the breakdown item which

has not been allocated to line items, in thebase currency of the data:ApprovedCommitmentValueBase of all lineitems associated with the breakdown item -ApprovedCommitmentValueBase of thebreakdown item

BreakdownItemChangePercentage Decimal The percentage of commitment changeapplied to the breakdown item:ApprovedCommitmentValue ÷InitialCommitmentValue (as a percentage)

ConsumedExpenditurePercentage Decimal The percentage of the approvedcommitment of the breakdown item that hasbeen consumed as expenditure:ApprovedExpenditureValue ÷ApprovedCommitmentValue (as apercentage)

Contract Line ItemsThe following table lists the fields which are available in the LineItems datamodel, which represents the lineitems configured for contracts.Note: The base currency of the data is configured when ProCon Analytics is installed.

Field Name Type Description ValuesLineItemCode String The code of the line item.

LineItemTitle String The name of the line item.

LineItemCurrency String The base currency of the lineitem.

LineItemType String The type of line item. Lump SumProgressivePaymentMilestonePaymentUnit RateReimbursable

SupplementaryCode String An additional code which can beused to identify the line item.

ContractId Int32 The unique ProCon identifier ofthe contract.


ContractReference String The unique reference for thecontract.

BusinessUnitId Int32 The unique ID of the BusinessUnit in which the contract islocated.


Field Name Type Description ValuesBusinessUnitName String The name of the business unit in

which the contract is located.

ContractorReference String The unique reference for thecontractor.


ContractAdministrators String A list of users assigned to theContract Administrator contractrole.

BreakdownItemName String The name of the breakdown itemthat the contract line item isassociated with.

BreakdownItemReference String The reference of the breakdownitem that the contract line item isassociated with.

ControlAccountCode String The code for the control accountthat the contract line item isassociated with.

ControlAccountName String The name of the control accountthat the contract line item isassociated with.

InitialCommitmentValue Decimal The total price as agreed in thecontract set for the line item whenit was created, in the line itemcurrency.For Unit Rate line items, this iscalculated as Unit Rate xCommitted Quantity.

InitialCommitmentValueBase Decimal The total price as agreed in thecontract set for the line item whenit was created, in the basecurrency of the data.For Unit Rate line items, this iscalculated as Unit Rate xCommitted Quantity.

InitialQuantity Decimal Unit Rate line items only.The initial maximum quantity ofthe line item that should be used.This has been negotiatedbetween the company andcontractor, and committed to inthe contract.

LineItemUnitOfMeasure String Unit Rate line items only.The unit of measure of the lineitem.

LineItemUnitRate Decimal Unit Rate line items only.The unit price of the line item inthe line item currency.


Field Name Type Description ValuesLineItemUnitRateBase Decimal Unit Rate line items only.

The unit price of the line item inthe base currency of the data.

ApprovedCommitmentValue Decimal The value of the Approvedcommitment recorded for the lineitem, in the line item currency.This is determined by thereporting categories of anycommunications the line item isused in.

ApprovedCommitmentValueBase Decimal The value of the Approvedcommitment recorded for the lineitem, in the base currency of thedata. This is determined by thereporting categories of anycommunications the line item isused in.

ApprovedQuantity Decimal Unit Rate line items only.Themaximum quantity of the lineitem that should be used, basedon communications in theApproved Commitment reportingcategory which include changesto the line item.

PendingCommitmentValue Decimal The value of the Pendingcommitment recorded for the lineitem, in the line item currency.This is determined by thereporting categories of anycommunications the line item isused in.

PendingCommitmentValueBase Decimal The value of the Pendingcommitment recorded for the lineitem, in the base currency of thedata. This is determined by thereporting categories of anycommunications the line item isused in.

PotentialCommitmentValue Decimal The value of the Potentialcommitment recorded for the lineitem, in the line item currency.This is determined by thereporting categories of anycommunications the line item isused in.


Field Name Type Description ValuesPotentialCommitmentValueBase Decimal The value of the Potential

commitment recorded for the lineitem, in the base currency of thedata. This is determined by thereporting categories of anycommunications the line item isused in.

ApprovedExpenditureValue Decimal The value of the Approvedexpenditure recorded for the lineitem, in the line item currency.This is determined by thereporting categories of anycommunications the line item isused in.

ApprovedExpenditureValueBase Decimal The value of the Approvedexpenditure commitmentrecorded for the line item, in thebase currency of the data. This isdetermined by the reportingcategories of anycommunications the line item isused in.

PendingExpenditureValue Decimal The value of the Pendingexpenditure recorded for the lineitem, in the line item currency.This is determined by thereporting categories of anycommunications the line item isused in.

PendingExpenditureValueBase Decimal The value of the Pendingexpenditure recorded for the lineitem, in the base currency of thedata. This is determined by thereporting categories of anycommunications the line item isused in.

PotentialExpenditureValue Decimal The value of the Potentialexpenditure recorded for the lineitem, in the line item currency.This is determined by thereporting categories of anycommunications the line item isused in.

PotentialExpenditureValueBase Decimal The value of the Potentialexpenditure recorded for the lineitem, in the base currency of thedata. This is determined by thereporting categories of anycommunications the line item isused in.


Field Name Type Description ValuesCreationDate DateTime The date and time that the line

item was created.

ConsumedExpenditurePercentage Decimal Progressive Payment line itemsonly.The percentage of the line itemclaimed in the contract (i.e. in aCompany to Contractorexpenditure communicationwhich has beenAgreed/Approved).

LineItemChangePercentage Decimal Progressive Payment line itemsonly.The percentage of the line itemincluded in commitment changecommunications which havebeenAgreed/Approved.

ConsumedCommitment Decimal Lump Sum, Milestone Paymentand Reimbursable line items only.The amount of the line itemclaimed in the contract (i.e. in aCompany to Contractorexpenditure communicationwhich has beenAgreed/Approved), in the line itemcurrency.

ConsumedCommitmentBase Decimal Lump Sum, Milestone Paymentand Reimbursable line items only.The amount of the line itemclaimed in the contract (i.e. in aCompany to Contractorexpenditure communicationwhich has beenAgreed/Approved), in the basecurrency of the data.

ConsumedQuantity Decimal Unit Rate line items only.The quantity of the line itemclaimed in the contract (i.e. in aCompany to Contractorexpenditure communicationwhich has beenAgreed/Approved).

TotalNumberOfRates Int32 Reimbursable line items only.The number of rates associatedwith the line item.

CommunicationsThe following table lists the fields which are available in the Communications datamodel.


Any custom fields which have been configured in the communication template are also available and can be usedaccording to their type. The column names for custom fields are prefixed withCommunication_Custom_Field_,e.g. Communication_Custom_Field_Action_Closed_Date.Tags which have been applied to communications can also be used. The column names for tag groups areprefixed withCommunication_Tag_Group_, e.g. Communication_Tag_Group_Area_Code.Note: Data is not returned for communications created by the contractor which have not been sent; i.e. Draftcommunications and communications which wereRejectedwhile inDraft.

Field Name Type Description ValuesCommunicationTitle String The title (subject) of

the communication.

CommunicationReference String The reference of thecommunication -unique in thecontract.

CommunicationRoutingPath String The routing path ofthe communication.

Company toContractorContractor toCompanyInternalCorrespondence

CommunicationTemplateTitle String The title of thecommunicationtemplate from whichthe communicationwas created.

CommunicationTemplateReportingCategory String The reportingtemplate of thecommunicationtemplate from whichthe communicationwas created.


Field Name Type Description ValuesCommunicationReportingCategory String The reporting

category to which thecommunication isassigned.

Not ApplicableApprovedContractChangePendingContractChangePotentialContractChangeApprovedContractExpenditurePendingContractExpenditurePotentialContractExpenditureNot to ExceedContract Value

CommunicationTemplateAbbreviation String The abbreviation ofthe communicationtemplate from whichthe communicationwas created.

CommunicationCurrency String The base currency ofthe communication.

TotalFinancialImpact Decimal The financial impactvalue of thecommunication in thecommunicationcurrency.If thiscommunication isdefined asExpenditure, this isthe total of allexpenditure financialvalues, including lineitems.


Field Name Type Description ValuesTotalFinancialImpactBase Decimal The financial impact

value of thecommunication in thebase currency of thedata.If thiscommunication isdefined asExpenditure, this isthe total of allexpenditure financialvalues, including lineitems.

TotalScheduleImpact Int32 The schedule impactvalue of thecommunication.

DaysTakenToApprove Int32 The number of daysbetween theOriginated On dateand the date thecommunication wasapproved/agreed.

DaysTakenToReject Int32 The number of daysbetween theOriginated On dateand the date thecommunication wasrejected.

DaysTakenToRespond Int32 The number of daysbetween the datethat thecommunication wassent/published andthe date on which aresponse wasreceived.Only applies tocommunicationswhich require aresponse.

CommunicationState String The state of thecommunication.

DraftApprovedRejectedAwaitingAgreement fromRecipientAgreedNot Agreed


Field Name Type Description ValuesRequiredResponse String Indicates if a

response is requiredfor thecommunication:agreement, reply, orboth.

NoneAgreement OnlyAgreement andReplyReply Only

IsCommunicationOverdue String Communicationswhich requireresponse only.Indicates that thecommunication isoverdue.

YesNo

CommunicationCycleTime Int32 Company toContractorcommunicationsonly.The number of daystaken for thecommunication tomove from Draft toApproved/AwaitingAgreement fromRecipient (thedifference betweenthe Created OnDateand the DateIssued).

ProcessTimeLimitDays Int32 Communicationswhich requireresponse only.The number of dayswithin which thecommunicationmustbe responded to onceit has been sent.

CommunicationProcessTimeLimitType String Communicationswhich requireresponse only.The type of due dateof thecommunication. Ifthis is Not Defined,the communicationdoes not require aresponse.

Not DefinedTargetDeadline

OriginatedOnDate DateTime The date set as thecommunication'sOriginated On date.By default, theCreatedOnDate.


Field Name Type Description ValuesCreatedOnDate DateTime The date on which

the communicationwas created.

DateIssued DateTime The date on whichthe communicationwas sent.

ResponseDueOnDate DateTime The date on whichthe communication'sresponse is due.Only applies tocommunicationswhich require aresponse.

CommunicationReviewCount Int32 The number ofreviews on thecommunication.

CommunicationReviewInProgressCount Int32 The number ofreviews on thecommunicationwhich are still inprogress.

ContractReference String The unique referencefor the contract.

ContractName String The name of thecontract.

ContractType String The type of thecontract.

StandardCall OffFrameworkAgreement

ContractorName String The name of thecontractor.

ContractCurrency String The base currency ofthe contract.

ProjectDepartmentName String The name of theproject/dept in whichthe contract islocated.

BusinessUnitId Int32 The unique ID of thebusiness unit inwhich the contract islocated.

CompanyRepresentative String The name of thecompany userassigned to theCompanyRepresentativecontract role.


Field Name Type Description ValuesContractOwner String The name of the

company userassigned to theContract Ownercontract role.

GeneralExpenditure Decimal The total of anyGeneral Expenditurefinancial values inthe communicationcurrency.

GeneralExpenditureBase Decimal The total of anyGeneral Expenditurefinancial values inthe base currency ofthe data.

RetentionExpenditure Decimal The total of anyRetentionExpenditure financialvalues in thecommunicationcurrency.

RetentionExpenditureBase Decimal The total of anyRetentionExpenditure financialvalues in the basecurrency of the data.

WithholdingTaxExpenditure Decimal The total of anyWithholding TaxExpenditure financialvalues in thecommunicationcurrency.

WithholdingTaxExpenditureBase Decimal The total of anyWithholding TaxExpenditure financialvalues in the basecurrency of the data.

CreditNoteExpenditure Decimal The total of anyCredit NoteExpenditure financialvalues in thecommunicationcurrency.

CreditNoteExpenditureBase Decimal The total of anyCredit NoteExpenditure financialvalues in the basecurrency of the data.


Field Name Type Description ValuesAdvancePaymentExpenditure Decimal The total of any

Advance PaymentExpenditure financialvalues in thecommunicationcurrency.

AdvancePaymentExpenditureBase Decimal The total of anyAdvance PaymentExpenditure financialvalues in the basecurrency of the data.

MilestoneLineItems Decimal The total of anyMilestone Paymentsline items in thecommunicationcurrency.

MilestoneLineItemsBase Decimal The total of anyMilestone Paymentsline items in the basecurrency of the data.

UnitRateLineItems Decimal The total of any UnitRate line items in thecommunicationcurrency.

UnitRateLineItemsBase Decimal The total of any UnitRate line items in thebase currency of thedata.

LumpSumLineItems Decimal The total of anyLump Sum line itemsin the communicationcurrency.

LumpSumLineItemsBase Decimal The total of anyLump Sum line itemsin the base currencyof the data.

ProgressiveLineItems Decimal The total of anyProgressivePayment line itemsin the communicationcurrency.

ProgressiveLineItemsBase Decimal The total of anyProgressivePayment line itemsin the base currencyof the data.


Field Name Type Description ValuesReimbursableLineItems Decimal The total of any

Reimbursable lineitems in thecommunicationcurrency.

ReimbursableLineItemsBase Decimal The total of anyReimbursable lineitems in the basecurrency of the data.

TotalNumberOfRates Int32 The total number ofrates associated withthe Reimbursableline items.

IsDeleted String Indicates whetherthe contract to whichthe communicationbelongs is in theRecycle Bin.

YesNo

CommunicationCreatedBy String The name of the userwho created thecommunication.

CommunicationResolvedOn DateTime The date and timethat thecommunication statewas set to one of thefollowing:

ApprovedAgreedNot AgreedRejected

IsLatestRevision String Indicates whetherthe communication isthe latest revision.

YesNo

BusinessUnitName Int32 The name of thebusiness unit inwhich the contract islocated.

DaysSinceCreated Int32 The number of dayssince thecommunication wascreated.

DaysSinceOriginated Int32 The number of dayssince the OriginatedOn date of thecommunication.


Field Name Type Description ValuesDaysSinceApproved Int32 The number of days

since thecommunication wasapproved/agreed.

DaysToResponseDueOnDate Int32 The number of daysuntil thecommunication'sresponse is due.Only applies tocommunicationswhich require aresponse.

DaysCommunicationIsOverdue Int32 Communicationswhich requireresponse only.The number of daysthat thecommunication isoverdue (thedifference betweenthe current date andthe due date).

Communication ReviewsThe following table lists the fields which are available in the CommunicationReviews datamodel.Tip: One instance of a communication review exists for each assigned reviewer. This enables you to createwidgets by reviewer (group by CommunicationReviewerID) as well as by review (group byCommunicationReviewID).

Field Name Type Description ValuesCommunicationReviewTitle String The title of the

communicationreview.

CommunicationRoutingPath String The routing path ofthe communication.

Company toContractorContractor toCompanyInternalCorrespondence

CommunicationOwner String The name of theowner of thecommunication.


Field Name Type Description ValuesCommunicationState String The state of the

communication.Note: 'Approved &AwaitingAgreement' is thealternative labelfor theAwaitingAgreement fromRecipient state.

DraftApprovedRejectedAwaitingAgreement fromRecipientAgreedNot Agreed

CommunicationProcessLimitType String The type of due dateof thecommunication. Ifthis is Not Defined,the communicationdoes not requireagreement.

Not DefinedTargetDeadline

CommunicationTemplateTitle String The title of thecommunicationtemplate from whichthe communicationwas created.

CommunicationTemplateAbbreviation String The abbreviation ofthe communicationtemplate from whichthe communicationwas created.

CommunicationTitle String The title (subject) ofthe communication.

CommunicationTemplateReportingCategory String The reportingtemplate of thecommunicationtemplate from whichthe communicationwas created.


Field Name Type Description ValuesCommunicationReportingCategory String The reporting

category of thecommunication.

Not ApplicableApprovedContractChangePendingContractChangePotentialContractChangeApprovedContractExpenditurePendingContractExpenditurePotentialContractExpenditureNot to ExceedContract Value

ContractReference String The unique referencefor the contract.

ContractName String The name of thecontract.

ContractType String The type of thecontract.

StandardCall OffFrameworkAgreement

ProjectDepartmentName String The reference andname of theProject/Dept inwhich the contract islocated.

BusinessUnitId Int32 The unique ID of theBusiness Unit inwhich the contract islocated.


Field Name Type Description ValuesReviewers String The names of the

company users,contract roles andbusiness processroles who have beenassigned asreviewers, separatedby |.e.g. |User|ContractRole|BusinessProcess Role|Use the containsfilter to search for aspecific reviewer -see Filtering theReturned Data.

DecisionSet String The decision setwhich applies to thereview.

DueDate DateTime The date which thereview is due.

DueDateType String The type of due datefor the review.

TargetDeadline

ReviewState String The state of thereview.

In progressComplete

ReviewType String The type of review. Best PracticeReviewAdHoc Review

IsReviewOverdue String Indicates whetherthe due date of thereview has passed.

YesNo

DaysOverdue Int32 The number of daysby which the reviewis overdue.

CommunicationTotalFinancialImpact Decimal The financial impactvalue of thecommunication in thecommunicationcurrency.

CommunicationTotalFinancialImpactBase Decimal The financial impactvalue of thecommunication in thebase currency of thedata.

CommunicationTotalScheduleImpact Int32 The schedule impactvalue of thecommunication.


Field Name Type Description ValuesIsDeleted String Indicates whether

the contract to whichthe communicationbelongs is in theRecycle Bin.

YesNo

CommunicationId Int32 The unique ProConID of thecommunication thatthe review belongsto.

CommunicationReviewId Int32 The unique ProConID of thecommunicationreview.

CommunicationReviewerName String The name of theassigned reviewer.

CommunicationReviewUserRole String The ProCon user roleof the reviewer.

MemberOf String The names of thecontract roles andbusiness processroles assigned asreviewers that theuser belongs to,separated by |.e.g. |ContractRole|BusinessProcess Role|Use the containsfilter to search for aspecific contract roleor business processrole - see Filteringthe Returned Data.

ReviewerProgress String The progress of thereviewer'scontribution.

Not StartedStartedCompleted

ReviewerStatus String The status of thereviewer'scontribution.

PartiallyAcceptedNot AcceptedAccepted

FinalDecision String The final decisionmade for the reviewby the reviewadministrator.


Communication Line ItemsThe following table lists the fields which are available in the CommunicationLineItems datamodel, whichrepresents line items used in communications.Note: The base currency of the data is configured when ProCon Analytics is installed.

Field Name Type Description ValuesLineItemCode String The code of the line item.

SupplementaryCode String An additional code which can beused to identify the line item.

LineItemType String The type of line item. Lump SumProgressivePaymentMilestonePaymentUnit RateReimbursable

LineItemTitle String The name of the line item.

LineItemUnitOfMeasure String Unit Rate line items only.The unit of measure of the lineitem.

QuantityClaimed Decimal Unit Rate line items only.The quantity of the line item usedin this communication.

UnitRateSubtotal Decimal Unit Rate line items only.The unit price of the line item in thecommunication currency.

UnitRateSubtotalBase Decimal Unit Rate line items only.The unit price of the line item in thebase currency of the data.

LineItemFinancialImpactBase Decimal The financial impact of the lineitem in the base currency of thedata.

LineItemFinancialImpact Decimal The financial impact of the lineitem in the communicationcurrency.



ProjectDepartmentName String The name of the Project/Dept inwhich the contract is located.

BusinessUnitId Int32 The unique ID of the Business Unitin which the contract is located.

CountryName String The country in which the contractoperates.

ContractorReference String The unique reference for thecontractor.


Field Name Type Description ValuesContractorName String The name of the contractor.

CompanyRepresentative String The name of the company userassigned to the CompanyRepresentative contract role.

ContractOwner String The name of the company userassigned to the Contract Ownercontract role.

ContractorRepresentative String The name of the contractor userassigned to the ContractorRepresentative contract role.

BreakdownItemName String The name of the breakdown itemthat the contract line item isassociated with.

BreakdownItemReference String The reference of the breakdownitem that the contract line item isassociated with.

ControlAccountCode String The code for the control accountthat the contract line item isassociated with.

ControlAccountName String The name of the control accountthat the contract line item isassociated with.

CommunicationId Int32 The unique ID of thecommunication.

CommunicationTitle String The title (subject) of thecommunication.

CommunicationReference String The reference of thecommunication - unique in thecontract.


Field Name Type Description ValuesCommunicationReportingCategory String The reporting category to which the

communication is assigned.NotApplicableApprovedContractChangePendingContractChangePotentialContractChangeApprovedContractExpenditurePendingContractExpenditurePotentialContractExpenditureNot toExceedContractValue

CommunicationState String The state of the communication. DraftApprovedRejectedAwaitingAgreementfromRecipientAgreedNot Agreed

CommunicationCurrency String The base currency of thecommunication.

IsDeleted String Indicates whether the contract towhich the communication belongsis in the Recycle Bin.

YesNo

CurrentConsumption Decimal The current consumption of the lineitem in the communicationcurrency.A line item is consumedwhen it isincluded in a Company toContractor expenditurecommunication which is ApprovedorAgreed.


Field Name Type Description ValuesCurrentConsumptionBase Decimal The current consumption of the line

item in the base currency of thedata.A line item is consumedwhen it isincluded in a Company toContractor expenditurecommunication which is ApprovedorAgreed.

ProgressiveLineItemClaims Decimal Progressive Payment line itemsonly.The percentage of the line itemclaimed for in this communication.

BusinessUnitName String The name of the business unit inwhich the contract is located.

LineItemCurrency String The currency of the line item.

ContractAdministrators String A list of users assigned to theContract Administrator contractrole.

RateCode String Reimbursable line items only.The code of the rate associatedwith the line item.

RateTitle String Reimbursable line items only.The title of the rate associated withthe line item.

RateVersionNumber Int32 The number which identifies therate version, in date order. Theearliest rate version is 1.

Contract ObligationsThe following table lists the fields which are available in the Obligations datamodel.

Field Name Type Description ValuesObligationTitle String The title of the obligation.

ObligationType String The type of obligation:

Milestone - manuallycreated for the contractCommunication -automatically initiated by acommunication

MilestoneCommunication

Owner String The owner of the obligation. CompanyContractorInternal

State String The state of the obligation. Not StartedIn ProgressCompleted


Field Name Type Description ValuesInitiatedBy String For obligations of type

Communication, the referenceof the communication whichinitiated the obligation.

DueDate DateTime The due date of the obligation,if any.

DoesTheObligationHaveADueDate String Indicates whether theobligation has a due date.

YesNo

ResponsibleParty String The name of the responsibleparty for the obligation. Can bea company user, contract roleor a business process role.

ContractObligationIsOverdue String Indicates whether theobligation is overdue.

YesNo

DaysOverdue Int32 The number of days by whichthe obligation is overdue.

DaysToDueDate Int32 The number of days until thedue date of the obligation.



CompanyRepresentative String The name of the company userassigned to the CompanyRepresentative contract role.

ContractOwner String The name of the company userassigned to the ContractOwner contract role.

ContractorRepresentative String The name of the contractoruser assigned to theContractor Representativecontract role.

ContractorRef String The unique reference for thecontractor.


ProjectDepartmentName String The reference and name of theProject/Dept in which thecontract is located.

BusinessUnitId Int32 The unique ID of the BusinessUnit in which the contract islocated.

IsDeleted String Indicates whether the contractto which the obligation belongsis in the Recycle Bin.

YesNo

TendersThe following table lists the fields which are available in the Tenders datamodel.


Any tender custom fields which have been configured by the ProCon administrator are also available and can beused according to their type. The column names for custom fields are prefixed with Tender_Custom_Field_, e.g.Tender_Custom_Field_HSSE.Note: The base currency of the data is configured when ProCon Analytics is installed.

Field Name Type Description ValuesTenderName String The name of the tender.

TenderReference String The unique reference for the tender.

TenderDescription String The description of the tender.

IsDeleted String Indicates whether the tender is in theRecycle Bin.

YesNo

PlannedStartDate DateTime The current planned start date of thetender process.

PlannedEndDate DateTime The current planned end date of thetender process.

ActualStartDate DateTime The actual start date of the tenderprocess.

ActualEndDate DateTime The actual end date of the tenderprocess.

Category String The category of the tender.

TenderTemplateName String The name of the tender template fromwhich the tender was created.

EstimatedBudgetBase Decimal The estimated budget of the contractwhich will be or has been awarded, inthe base currency of the data.

EstimatedBudget Decimal The estimated budget of the contractwhich will be or has been awarded.

ContractAwarded String Indicates if a contract has beenawarded from the tender.

YesNo

ContractReferences String The unique references of the contractswhich have been awarded from thetender, separated by |.e.g. |100044C|100045C|.Use the contains filter to search for aspecific contract - see Filtering theReturned Data.

ContractNames String The unique references of the contractswhich have been awarded from thetender, separated by |.e.g. |Contract1|Contract2|.Use the contains filter to search for aspecific contract - see Filtering theReturned Data.


Field Name Type Description ValuesContractsAwardedTo String The names of the contractors who were

awarded the contracts from this tender,separated by |.e.g. |ContractorA|ContractorB|.Use the contains filter to search for aspecific contractor - see Filtering theReturned Data.

DaysStartDateDelayed Int32 The number of days that the start of thetender process was delayed.

TenderDaysOverdue Int32 The number of days that the tenderprocess is overdue.

TenderStatus String The status of the tender. NotStartedInProgressOverdueClosed

HasActiveAlert String Indicates if the tender has any activealerts.

YesNo

TenderDaysRemaining Int32 The number of days remaining for thetender process to be completed.

ShortListedContractorNames String The names of the contractors who wereshortlisted for this tender, separated by|.e.g. |ContractorA|ContractorB|.Use the contains filter to search for aspecific contractor - see Filtering theReturned Data.

ShortListedContractorReferences String The references of the contractors whowere shortlisted for this tender,separated by |.e.g. |ContractorA|ContractorB|.Use the contains filter to search for aspecific contractor - see Filtering theReturned Data.

ProjectDepartmentName String The reference and name of theProject/Dept in which the tender islocated.

BusinessUnitId Int32 The unique ID of the Business Unit inwhich the tender is located.

Schedule ItemsThe following table lists the fields which are available in the ScheduleItems datamodel.

Field Name Type Description ValuesTenderID Int32 The unique ProCon ID of the tender

to which the schedule item belongs.


Field Name Type Description ValuesTenderReference String The unique reference for the tender to

which the schedule item belongs.

TenderName String The name of the tender to which theschedule item belongs.

IsTenderDeleted String Indicates whether the tender towhich the schedule item belongs is inthe Recycle Bin.

YesNo

TenderStatus String The status of the tender to which theschedule item belongs.

Not StartedIn ProgressOverdueClosed

TenderScheduleItemType String The type of the schedule item. Create DocumentsPublicationReviewDespatch/TrackingShortlistAwardStageGate

Category String The category of the tender to whichthe schedule item belongs.

ScheduleItemTitle String The name of the schedule item.

ScheduleItemStatus String The status of the schedule item. Not StartedIn ProgressOverdueClosed

MinimumDuration Int32 Theminimum number of days thatthe schedule item should take, asdefined in the tender template.

MaximumDuration Int32 Themaximum number of days thatthe schedule item should take, asdefined in the tender template.

PlannedDuration Int32 The planned number of days that theschedule item should take.

ActualDuration Int32 The actual number of days that theschedule item took.

PlannedStartDate DateTime The current planned start date of theschedule item.

PlannedEndDate DateTime The current planned end date of theschedule item.

ActualStartDate DateTime The actual start date of the scheduleitem.

ActualEndDate DateTime The actual end date of the scheduleitem.


Field Name Type Description ValuesOriginalStartDate DateTime The original start date of the

schedule item.

OriginalEndDate DateTime The original end date of the scheduleitem.

DaysStartDateDelayed Int32 The number of days that the start ofthe schedule item was delayed.

DaysOverdue Int32 The number of days that theschedule item is overdue.

DespatchDate DateTime Despatch/Tracking schedule itemsonly. The date that the despatch wassent.

FinalSubmissionDate DateTime Despatch/Tracking schedule itemsonly. The final submission date bywhich bidders must submit their bids.

ProjectDepartmentName String The reference and name of theProject/Dept in which the tender islocated.

BusinessUnitId Int32 The unique ID of the Business Unit inwhich the tender is located.

Tender ReviewsThe following table lists the fields which are available in the TenderReviews datamodel.Tip: One instance of a tender review exists for each assigned reviewer. This enables you to create widgets byreviewer (group by TenderReviewerID) as well as by review (group by TenderReviewID).

Field Name Type Description ValuesTenderReviewId Int32 The unique ID of the tender

review.

TenderReviewerId Int32 The unique ID of theassigned reviewer.

BusinessUnitId Int32 The unique ID of theBusiness Unit in which thetender is located.

BusinessUnitName String The name of the BusinessUnit in which the tender islocated.

ProjectDepartmentName String The reference and name ofthe Project/Dept in whichthe tender is located.

TenderName String The name of the tender.

TenderReference String The unique reference for thetender.

IsDeleted String Indicates whether the tenderis in the Recycle Bin.

YesNo


Field Name Type Description ValuesTenderStatus String The status of the tender. Not

StartedInProgressOverdueClosed


TenderId Int32 The unique ID of the tenderto which the review belongs.

ScheduleItemId Int32 The unique ID of theschedule item to which thereview belongs.

ScheduleItemTitle String The name of the scheduleitem to which the reviewbelongs.

ScheduleItemStatus String The status of the scheduleitem to which the reviewbelongs.

NotStartedInProgressOverdueClosed

TenderReviewName String The name of the tenderreview.

TenderReviewerName String The name of the assignedreviewer.

TenderReviewerUserRole String The user role of theassigned reviewer.

TenderReviewerStatus String The status of the reviewer'sreview.

NotStartedStartedCompleted

DueDate DateTimeOffset The date and time that thereview is due.

AssignedDate DateTimeOffset The date and time that thereview was assigned to thereviewers.

NumberDocumentsToReview Int32 The number of documentsattached to the review.

NumberReviewers Int32 The total number ofassigned reviewers.

NumberReviewersWithReviewDone Int32 The number of reviewerswho have completed thereview.


Field Name Type Description ValuesElapsedDurationBand Decimal The percentage of the

review duration that haselapsed, where the reviewduration is the number ofdays between theAssignedDate and theDueDate.

DaysToDueDate Int32 The number of days until thedue date of the review.

OverdueReviewDuration Int32 The number of days sincethe due date of the review.

DaysSinceReviewAssigned Int32 The number of days sincethe review was assigned.

IsTenderReviewOverdue String Indicates if the review isoverdue.

YesNo

Stage GatesThe following table lists the fields which are available in the StageGates datamodel.

Field Name Type Description ValuesProjectDepartmentName String The reference and name of the

Project/Dept in which thetender is located.

BusinessUnitName String The name of the BusinessUnit in which the tender islocated.

BusinessUnitId Int32 The unique ID of the BusinessUnit in which the tender islocated.

TenderReference String The unique reference for thetender.

TenderName String The name of the tender.

IsTenderDeleted String Indicates whether the tender isin the Recycle Bin.

YesNo

TenderStatus String The status of the tender. NotStartedInProgressOverdueClosed

TenderId Int32 The unique ProCon ID of thetender to which the stage gatebelongs.

StageGateId Int32 The unique ProCon ID of thestage gate.



Field Name Type Description ValuesScheduleItemTitle String The name of the stage gate

schedule item .

ScheduleItemStatus String The status of the stage gateschedule item.

NotStartedInProgressOverdueClosed

StageGatePackageName String The name of the stage gatepackage.

IssuedBy String The name of the user whoissued the stage gatepackage.

IssuedByUserRole String The user role of the user whoissued the stage gatepackage.

FirstIssuedDate DateTimeOffset The date and time that thestage gate package was firstissued.

BusinessProcessRole String The name of the businessprocess role to which thestage gate package isassigned.

BusinessProcessRoleMembers String Themembers of the businessprocess role to which thestage gate package isassigned.

RequestedResponseDate DateTimeOffset The date and time that thestage gate response is due.

EstimatedApprovalDate DateTimeOffset The date and time that thebusiness process role hasgiven as their estimatedapproval date.

PlannedApprovalDuration Int32 The number of days that theapproval is planned to take.

ActualApprovalDuration Int32 The number of days that theapproval actually took.

PackageRevisions String The number of revisions of thestage gate package.

LatestApprovalStatus String The latest response sent bythe business process role.

IsOverdue String Indicates if the stage gateresponse is overdue.

YesNo

OverdueDays Int32 The number of days that thestage gate response isoverdue.


Field Name Type Description ValuesDaysSincePackageIssued Int32 The number of days since the

stage gate package wasissued.

User MetricsDelete this text and replace it with your own content.

DASHBOARD EXAMPLESThe following examples are Business Unit dashboards.

Milestone Obligations SummaryThis exampleMilestoneObligation Summary dashboard shows information such as:

the number of overduemilestone obligations as a 30-day trendthe owner of overduemilestone obligationsthe names of contracts with overdue obligations, and the number of overdue obligations in each

Widgets used:

Project/Department Filter: SlicerTotal Number of Obligations: CardAverage Days MilestoneObligations Overdue: TrendNumber of Overdue Obligations (30 day trend): TrendOverdueMilestoneObligations Responsible Party: Bar ChartMilestoneObligation Status Summary: Pie ChartOverdue Milestone Obligations Owner: Pie ChartDays MilestoneObligations Overdue: Stacked Bar ChartContracts with Overdue Milestone Obligations: Bar ChartHistorical Overdue Milestone Obligations: Historical Data

Themajority of widgets provide a drill-through facility to seemore details about the data displayed.

Project/Department FilterSlicer widget


Lists the project/depts in the business unit. If a project/dept is selected (displayed in bold), widgets which are setto receive filter events will show only the data for milestone obligations in that project/dept.


https://YourServer/ProConAnalyticsApi/Obligations?$filter=ObligationTypeeq 'Milestone'

Returns data from theObligationsdatamodel.Filters by:

ObligationType is Milestone(i.e. returned data does notinclude project/depts whichonly have Communicationobligations)

GroupBy

ProjectDepartmentName Groups the data by the name of theproject/dept, i.e. each row of thetable is a project/dept.

DisplayName

Project/Department Filter Optional display name.

Total Number of ObligationsCard widgetDisplays the total number of contract milestone obligations. Data is shown for either the business unit or theproject/dept selected in the Project/Department Filter widget.Click the number to drill through to details of the obligations.


/ProConAnalyticsApi/Obligations?$filter=ObligationTypeeq 'Milestone' and State ne 'Completed'


ObligationType isMilestone (i.e. returneddata does not includeCommunicationobligations)State is not Completed


Field Value NotesPrefix (leave blank)

Suffix (leave blank)

Aggregation- Type

Count Counts the number of recordsreturned.


-

ReceiveFilterEvents

Yes If a project/dept is selected inthe Project/Department Filterwidget (displayed as bold),this widget shows only thedata for that project/dept.

Number of Overdue Obligations (30 day trend)Trend widgetDisplays the total number of overduemilestone obligations. A trend arrow and the percentage increase/decreaseshows indicates a change in the number of records compared to 30 days before. Data is shown for either thebusiness unit or the project/dept selected in the Project/Department Filter widget.Click the number to drill through to details of the overdue obligations.

Field Value NotesUseRelativeDates

Yes Use relativedates for thecomparisonperiod.If not selected,exact dates mustbe supplied.


Field Value NotesBaseline -Rest URL

https://YourServer/ProConAnalyticsApi/Obligations?$filter=ObligationType eq 'Milestone' and State ne 'Completed' andContractObligationIsOverdue eq 'Yes'

Returns data fromtheObligationsdatamodel.Filters by:

ObligationType is Milestone(i.e. returneddata does notincludeCommunicationobligations)State is notCompletedobligation isoverdue

Comparison -CompareWith

30 Days The comparisonperiod for thetrend arrow andpercentageincrease/decrease.

Aggregation - Type

Count Counts thenumber of recordsreturned.


-

TrendHighlighting -RepresentUpwardTrend as

Negative An increase in thenumber of recordsis shown as anegative trend(red arrow).

ReceiveFilterEvents

Yes If a project/dept isselected in theProject/Department Filter widget(displayed asbold), this widgetshows only thedata for thatproject/dept.

Overdue Milestone Obligations OwnerPie Chart widgetDisplays the total number of overduemilestone obligations for each obligation owner (Company, Contractor orInternal). Data is shown for either the business unit or the project/dept selected in the Project/Department Filterwidget.


Click a segment of the chart to drill through to details of the overdue obligations with that owner.


/ProConAnalyticsApi/Obligations?$filter=ObligationTypeeq 'Milestone' and State ne 'Completed' andContractObligationIsOverdue eq 'Yes'


ObligationType isMilestone (i.e. returneddata does not includeCommunicationobligations)State is not Completedobligation is overdue

Group By Owner Groups the data by theobligation owner - i.e. eachsegment of the pie chart is adifferent owner.

Aggregation- Type

Count Counts the number of recordsreturned for each obligationowner.


-

LimitRecords

Optional Used to specify themaximumnumber of records you wantto include in the data shown.

Legend Title Obligation Owner Optional display name.

ReceiveFilterEvents


Contracts with Overdue Milestone ObligationsBar Chart widget


Displays the total number of overduemilestone obligations for each contract. Data is shown for either thebusiness unit or the project/dept selected in the Project/Department Filter widget.Click a bar to drill through to details of the obligations in that contract.





Group By ContractName Groups the data by the nameof the contract - i.e. each barof the chart is a contract.

Aggregation- Type

Count Counts the number of recordsreturned for each contract.


-

LimitRecords

Optional Used to specify themaximumnumber of records you wantto include in the data shown.


Contract Name Optional display name.


Field Value NotesAxis Titles -Y Axis Title

# of OverdueMilestoneObligations Optional display name.

ReceiveFilterEvents


Historical Overdue Milestone ObligationsHistorical Data widgetDisplays the total number of overduemilestone obligations, for eachmonth for the previous 12months. Data isshown for either the business unit or the project/dept selected in the Project/Department Filter widget.Click a bar to drill through to details of the obligations which became overdue in that month.Note: Historical data widgets cannot receive filter events, e.g. from the Project/Department Filter slicerwidget.





Interval Months

UseRelativeDates

Yes Use relative dates for thecomparison period.If not selected, exact datesmust be supplied.


Field Value NotesComparisonPeriod

12 Data will be displayed for theprevious 12months(Interval).

X Axis Title Month Optional display name.

Y Axis Title # of Obligations Optional display name.

Tender SummaryThis example Tender Summary dashboard shows information such as:

a summary of the status of tendersthe number of overdue schedule itemsthe number of tenders which fall into predefined ranges, for example of days remaining and estimated budget

Widgets used:

Project/Department Filter: SlicerTender Category Filter: TableOverdue Tender Schedule Items by Type: Pie ChartSchedule Item Summary (Active Tenders): TableTender Summary by Status: TableTender Avg Days Overdue: TrendAvg Days Delay Start Date: TrendActive Tenders by Template: Bar ChartActive Tenders - Days Remaining to Complete: Stacked Bar ChartNum. Active Tenders by Value Budget Range: Stacked Bar ChartNum. of Active Tender Schedule Item by Status: Bar Chart

Themajority of widgets provide a drill-through facility to seemore details about the data displayed.

Project/Department FilterSlicer widgetLists the project/depts in the business unit. If a project/dept is selected (displayed in bold), widgets which are setto receive filter events will show only the data for tenders in that project/dept.



https://YourServer/ProConAnalyticsApi/Tenders

Returns data from the Tenders datamodel.

GroupBy

ProjectDepartmentName Groups the data by the name of the project/dept, i.e. eachrow of the table is a project/dept.

DisplayName

Project/Department Filter Optional display name.

Tender Category FilterTable widgetLists the categories of the tenders in the business unit. If a category is selected (displayed in bold), widgetswhich are set to receive filter events will show only the data for that tenders in that category.



/ProConAnalyticsApi/Tenders?$filter=TenderStatusne 'Closed'

Returns data from the Tendersdatamodel.Filters by:

TenderStatus is not Closed(i.e. returned data onlyincludes Not Started, InProgress andOverduetenders)

Group By Category Groups the data by the name ofthe tender category, i.e. each rowof the table is a category.


Count Counts the number of recordsreturned for each tender category.


-


Field Value NotesLimitRecords

Optional Used to specify themaximumnumber of records you want toinclude in the data shown.

TableColumns toDisplay

(leave as defaults)


No


Yes If a tender is selected (displayedin bold), widgets which are set toreceive filter events will showonly the data for that tender.

Overdue Tender Schedule Items by TypePie Chart widgetDisplays the total number of overdue schedule items for each schedule item type. Data is shown for either thebusiness unit or the project/dept or tender category selected in the appropriate filter widget.Click a segment of the chart to drill through to details of the schedule items of that type.



/ProConAnalyticsApi/ScheduleItems?$filter=TenderStatusne 'Closed' and ScheduleItemStatus eq 'Overdue' andTenderScheduleItemType ne 'Group heading'

Returns data from theScheduleItems datamodel.Filters by:

TenderStatus is notClosed (i.e. returneddata only includes NotStarted, In ProgressandOverdue tenders)schedule item isoverdueschedule item type isnot Group Heading

Group By TenderScheduleItemType Groups the data by the typeof schedule item, i.e. eachsegment of the pie chart isa schedule item type.

Aggregation- Type

Count Counts the number ofrecords returned for eachschedule item type.


-

LimitRecords

Optional Used to specify themaximum number ofrecords you want to includein the data shown.

Legend Title Schedule Item Type Optional display name.

ReceiveFilterEvents

Yes If a project/dept is selectedin the Project/DepartmentFilter widget (displayed asbold) or a tender is selectedin the Tender Category filterwidget, this widget showsonly the data for thatproject/dept or tender.

Schedule Item Summary (Active Tenders)Table widgetDisplays the number of schedule items and the sum of the planned and actual durations for each schedule itemtype. Data is shown for either the business unit or the project/dept or tender category selected in the appropriatefilter widget.Click a row to drill through to details of the schedule items of that type.



/ProConAnalyticsApi/ScheduleItems?$filter=TenderStatusne 'Closed' and TenderScheduleItemType ne 'Groupheading'

Returns data from theScheduleItems datamodel.Filters by:

TenderStatus is notClosed (i.e. returneddata only includes NotStarted, In Progress andOverdue tenders)schedule item type is notGroup Heading

Group By TenderScheduleItemType Groups the data by the typeof schedule item, i.e. eachrow of the table is aschedule item type.


1. Count2. Sum3. Sum

1. Counts the number ofrecords returned for eachschedule item type.

2. Sums the values of thePlannedDuration foreach schedule itemtype.

3. Sums the values of theActualDuration for eachschedule item type.


Field Value NotesAggregatedColumns -ColumnName

1. -2. PlannedDuration3. ActualDuration

LimitRecords

Optional Used to specify themaximum number of recordsyou want to include in thedata shown.

TableColumnsto Display -ColumnName

- The selectedAggregatedColumns.

TableColumnsto Display -DisplayName

1. Schedule Item Type2. #3. Planned Duration4. Actual Duration


ReceiveFilterEvents

Yes If a project/dept is selectedin the Project/DepartmentFilter widget (displayed asbold) or a tender is selectedin the Tender Category filterwidget, this widget showsonly the data for thatproject/dept or tender.


No

Tender Summary by StatusTable widgetDisplays the number of tenders and the total estimated budget for each tender status. Data is shown for eitherthe business unit or the project/dept or tender category selected in the appropriate filter widget.Click a segment of the chart to drill through to details of the tenders of that status.



/ProConAnalyticsApi/Tenders?$filter=TenderStatusne 'Closed'

Returns data from the Tenders datamodel.Filters by:

TenderStatus is not Closed (i.e.returned data only includes NotStarted, In Progress andOverdue tenders)

Group By TenderStatus Groups the data by the status of thetender, i.e. each row of the table isa status.


1. Count2. Sum

1. Counts the number of recordsreturned for each tender status.

2. Sums the values of theEstimateBudgetBase for eachtender status.


1. -2. EstimatedBudgetBase

LimitRecords

Optional Used to specify themaximumnumber of records you want toinclude in the data shown.

TableColumnsto Display -ColumnName

- The selectedAggregatedColumns.

TableColumnsto Display -DisplayName

1. Tender Status2. # of Tenders3. Estimated Budget ($)


ReceiveFilterEvents

Yes If a project/dept is selected in theProject/Department Filter widget(displayed as bold) or a tender isselected in the Tender Categoryfilter widget, this widget shows onlythe data for that project/dept ortender.


No

Active Tenders - Days Remaining to CompleteStacked Bar Chart widgetDisplays the number of tenders for each defined band of the number of days until the planned end date. Data isshown for either the business unit or the project/dept or tender category selected in the appropriate filter widget.Click a band of the chart to drill through to details of the tenders which fall into that band.



https://YourServer/ProConAnalyticsApi/Tenders?$filter=TenderStatusne 'Closed'


TenderStatus is not Closed (i.e.returned data only includes NotStarted, In Progress andOverduetenders)

BandedColumn-ColumnName

TenderDaysRemaining The data in the TenderDaysRemainingcolumn is used to build the stacked barchart.

BandedColumn-DisplayName

Days to the Planned End Date Optional display name.

Bands - to 1011 to 2021 to 3031 to -

Groups the values ofTenderDaysRemaining into thespecified bands, and displays thenumber of records in each band.Note: - indicates that the valueshould be left blank.

ReceiveFilterEvents

Yes If a project/dept is selected in theProject/Department Filter widget(displayed as bold) or a tender isselected in the Tender Category filterwidget, this widget shows only thedata for that project/dept or tender.

Num. Active Tenders by Value Budget RangeStacked Bar Chart widget


Displays the number of tenders for each defined band of the tender value (based on the estimated budget). Datais shown for either the business unit or the project/dept or tender category selected in the appropriate filter widget.Click a band of the chart to drill through to details of the tenders which fall into that band.


https://YourServer/ProConAnalyticsApi/Tenders?$filter=TenderStatusne 'Closed'


TenderStatus is not Closed (i.e.returned data only includes NotStarted, In Progress andOverduetenders)

BandedColumn-ColumnName

EstimatedBudgetBase The data in the EstimatedBudgetBasecolumn is used to build the stacked barchart.

BandedColumn-DisplayName

Tender Value ($) Optional display name.

Bands - to 10000001000001 to 20000002000001 to 30000003000001 to 40000004000001 to -

Groups the values ofEstimatedBudgetBase into thespecified bands, and displays thenumber of records in each band.Note: - indicates that the valueshould be left blank.

ReceiveFilterEvents

Yes If a project/dept is selected in theProject/Department Filter widget(displayed as bold) or a tender isselected in the Tender Category filterwidget, this widget shows only thedata for that project/dept or tender.


TROUBLESHOOTING DASHBOARDWIDGETSNote: These troubleshooting scenarios apply to the embedded dashboard widgets only, and are not relevant toProCon Analytics when in use in third-party solutions.

"Error in Configuration"This error is displayed when the REST URL ;is not correctly formed. Possible problems in the URL include:

http instead of httpswrong server name, e.g. procon.aveva.comwrong or misspelled datamodel, e.g. Contracts instead of Communicationsan invalid or misspelled filter or select

SeeSpecifying URLs for more information.

"REST URL Returned No Data"This message is displayed when the specified REST URL has nomatching data. Check that your URL iscorrectly formed, especially filters and selects.SeeSpecifying URLs for more information.

Errors in Band, Limit and Group By ColumnsPossible errors include:

"Columns with Negative Values Returned""Columns With Non-Numeric Values Returned""Column to Band Contains Non-Numeric Values""Column to Band Does Not Exist""Limit ColumnContains Non-Numeric Values""Error in Group By"

Check that the correct column name has been entered, and that the column has, for example, numeric values.

Table Missing Expected DataIf a table is displaying no data for a column, check that the column name has been correctly entered. SeeDataModels and Columns for column names.

ProCon 7 Embedded Dashboards andWidgets of 132

INDEX

A

adding See also creatingpersonal dashboards 15standard dashboards 15widgets to dashboards 7, 10, 15-16

Analytics API 71API key 71

B

bar chart widgets 35broadcasting widget filters 69business unitsdashboard templates 6standard dashboards 6

C

card widgets 33charts 24communication line items 81, 99communication reviews 94communications 85contract breakdown items 78contracts 72obligations 102tenders 103, 105

communication line itemswidget data 81, 99

communication reviewswidget data 94

communicationsreviews See also communication reviewswidgets 85

configurationdashboard templates 7, 10personal dashboards 16

contract breakdown itemswidget data 78

contractsbreakdown 78communications See also communications

dashboards 19obligations See obligationswidget data 72

creating See also addingdashboard templates 6, 9widgets 12

D

dashboard templates 6-11dashboards 14, 24, See also widgetsbusiness unit 6, 14, 16-17contract 9, 19dashboard templates 6-11deleting 14layouts See also layoutsmaintenance 5personal dashboards 15-16standard dashboards 15

deleting See also removingdashboards 8, 11personal dashboards 14, 17widgets 13

deploying widgets 12Detail View 69

E

editingdashboard templates 7, 10dashboard widgets 7, 10, 16personal dashboards 16widgets 12

F

filterswidget data 66widgets 69

H

historical data 70historical data widgets 57

L

layouts 6-7, 9-10, 15-16line chart widgets 41


M

Microsoft Excel 71modifying See also editing

O

obligationswidgets 102

P

personal dashboards 14-16deleting 17editing 16

pie chart widgets 45ProCon Analytics 5publishingdashboard templates 8

R

receiving widget filters 69refreshing dashboards 14removing See also deletingdashboard widgets 7, 10, 16

REST URL 66

S

schedule itemswidget data 105

slicer widgets 30stacked bar chart widgets 51stacked bar with limit chart widget 53standard dashboards 14-15

T

table widgets 24tables 24communication line items 81, 99communication reviews 94communications 85contract breakdown items 78contracts 72obligations 102tenders 103, 105

tenderswidget data 103, 105

text widgets 65trend widgets 60troubleshooting 128

U

updating See also editing; modifying

W

widgets 14-16, 24, 72, 78, 81, 94, 99, 103, 105adding to dashboards 7, 10, 15-16bar chart 35broadcasting filters 69card 33communication line items 81, 99communication reviews 94communications 85contract breakdown items 78contracts 72creating 12dashboardmaintenance 5dashboard templates 6-11datamodels 72deleting 13deploying 12Detail View 69editing 12editing on dashboards 7, 10, 16filtering data 66historical 57, 70line chart 41obligations 102pie chart 45receiving filters 69removing from dashboards 7, 10, 16slicer 30sorting data 66stacked bar chart 51stacked bar with limit chart 53table 24templates 12tenders 103, 105


text 65trend 60troubleshooting 128types 24URLs 66

© 2019 AVEVASOLUTIONSLIMITED. ALL RIGHTSRESERVED.AVEVASOLUTIONSLIMITED ISOWNED BYAVEVAGROUPPLC. AVEVA, THEAVEVALOGOSAND AVEVAPRODUCT NAMESARETRADEMARKSORREGISTEREDTRADEMARKSOF AVEVAGROUPPLCOR ITSSUBSIDIARIES IN THEUNITEDKINGDOMANDOTHER COUNTRIES. OTHER BRANDSAND PRODUCTSNAMESARETHETRADEMARKSOF THEIR RESPECTIVECOMPANIES.© 2019 AVEVAGROUPPLC AND ITSSUBSIDIARIES. ALL RIGHTSRESERVED.AVEVA, THEAVEVALOGOSAND AVEVAPRODUCT NAMESARETRADEMARKSORREGISTEREDTRADEMARKSOF AVEVAGROUPPLCOR ITSSUBSIDIARIES IN THEUNITEDKINGDOMANDOTHER COUNTRIES. OTHER BRANDSAND PRODUCTSNAMESARETHETRADEMARKSOF THEIR RESPECTIVECOMPANIES.