Dashboard Configuration

Dashboards are used for a variety of different purposes. Most commonly they are used to present information that is relevant to the end user. Dashboards can also serve as a launchpad to access other parts of the system. A single dashboard can serve both purposes, presenting information to users and also acting as a navigation aid.

• Details on how to create a dashboard, share it, publish it or add it to the library can be found in the Dashboards Overview 

• Steps to create a dashboard can be found in Dashboards Overview - Creating a dashboard 

• Steps to share a dashboard can be found in Dashboards Overview - Sharing a dashboard 

• Steps to publish a dashboard can be found in Dashboards Overview - Publishing a dashboard 

• To make a dashboard an entity page, navigate to the dashboard in question and put it in edit mode. The user must have edit rights to the dashboard to be able to do this.

• Once the dashboard is in edit mode, click on 'Open Settings' at the top of the dashboard.

• Click on the 'Properties' tab

• Change the attribute 'Page URL' from the default value to one that is meaningful, for example 'myentityoverview'.

• Save your changes and then navigate to the dashboard using the entity page name just provided (for example #DASH/myentitypagename)

• To make a dashboard a landing page, navigate to the dashboard in question and put it in edit mode. The user must have edit rights to the dashboard to be able to do this.

• Once the dashboard is in edit mode, click on 'Open Settings' at the top of the dashboard.

• Click on the 'Properties' tab

• Check the box 'Landing'

• Check the access tab to make sure that the correct groups are defined with view access. This is still required even if the user record specifies this as the landing page.

• Save the changes and then test by navigating to a user record (via the Administration workbench) and confirming that the page now appears in the list when setting a user's landing page.

• When calling a dashboard parameters can be passed in to control the information and contents displayed on the page.

• A good example of  such a parameter is the project ID being passed into the project overview page. 

• Once passed in, the parameter can be referenced by the following:

  1. Datasources linked to content areas. These will query data for the value passed in.

  2. The content of content area definitions. If, for example, a content area should display the ID passed in as a parameter this can be referenced in the content section of the content area definition.

• Parameters should be passed in as token/value pairs following a '?' to the end of the URL. Multiple token/value pairs can be passed, separated by an '&' character. Examples are shown below:

#DASH/myentitypage?MYENTITYID=1                        

#DASH/myentitypage?MYENTITYID=1&START_DATE=01-Jan-2019 

<div id=page_level_filter_dropdown[D.CA_ID]></div>                                     

<script>                                                                               

  var my_comp = component_factory.getStandAloneComponent(                              

    {                                                                                  

      "VALIDATION_UUID": "30e4161e-cc1f-11ee-a3eb-02ccbe37a24b"                        

      , "COMPONENT_TYPE":"dropdownsql"                                                 

      , "PROMPT": "Fiscal Year"                                                        

      , "SHOW_PROMPT": "Y"                                                             

    }                                                                                  

    , function(element, params, attachment_params)                                     

    {                                                                                  

      console.log(params);                                                             

      var sel_id = element.options[element.selectedIndex].value;                       

      location.href="#DASH/entitypagename?FY="+sel_id;                                 

    });                                                                                

  document.getElementById('page_level_filter_dropdown[D.CA_ID]').appendChild(my_comp); 

</script>                                                                              

• Every time a dashboard is changed, a snapshot of it is taken beforehand so that changes can be reverted, if required.

• To do this, click on the pencil icon to edit the dashboard and then click on the ‘Settings’ icon to select the settings page.

• Click on the ‘History’ tab to see the history of changes.

• Identify the version you wish to restore to and then click on the ‘Restore’ button to restore that version.

• Click on the pencil icon for the dashboard.

• Click on Settings and then select the ‘Properties’ tab.

• Check the ‘Template’ box.

• Check who has access to the dashboard via the ‘Access’ tab.