Access dashboards with preset parameter values

Introduction

When working with data in a Decision Insight dashboard, you may need to see different views of the data, using different sets of parameters to filter the dashboard content.  For easier access, you can create dashboard URLs which contain preset entity parameters values. These parameter-led URLs enable you to access a dashboard with the correct filtering parameters already specified. 

Internal and external hyperlinks

 A hyperlink to a dashboard can be internal or external:

  • An internal hyperlink is a link that you click from within a deployment and that brings you to a dashboard in that deployment.
  • An external hyperlink is a link that you click from within a deployment or an external site to access a dashboard on a different deployment. 


The format of a URL to access a dashboard with preset parameter values is as follows:

<adi url>/app#/dashboards/<dashboard UUID>;<param1 URL identifier>=<value>@<resolutionTime>;<param2 URL identifier>=<value>@<resolutionTime>...

Rules for creating a dashboard URL

To create a dashboard URL that you can access externally, make sure that: 

  • The parameters used in the URL are only Entity type parameters.
  • The value corresponds to the UUID or the key value of an instance of the same entity type as the parameter. The instance must be live at the specified resolutionTime
  • The value shouldn't contain the following characters : '@' (except if used as delimiter before the resolution time) or '%'.
  • The key value works only for entities with simple String or Integer keys. If the entity has multiple simple String/Integer keys, the right key is chosen searching in a loop for all keys values.
  • The following rules apply for the resolutionTime:
    • it is optional; If it is not specified, the current time machine date is used.
    • It follows the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
    • the milliseconds are optional.
    • the time zone offset can be either 'Z' for zero (UTC time), or of the form '+/-HH:mm' for non-zero.

Examples

Payment search for clearing house in Paris and currency in USD using a key

Payment search with Clearing House set to Paris and Currency set to USD using key

Payment search for clearing house in Paris and currency in USD using a UUID

Payment search for dead payments

This example requires adjusting with a valid payment UUID and a resolutionTime at which it was still alive.

Payment details for a dead payment

http://localhost:8080/app#/dashboards/2-1-E6_p8hFwAAE;param1=00000000-F348-0000-1545-84C6D8100001@2016-04-27T07:54:50.231+03:00

Set the time machine state

You can also set a specific time configuration on the target dashboard. When creating your URL, use the tm URL identifier.

If you don't specify a value for this parameter, clicking the URL opens the dashboard with the time machine in live mode.

If you do specify this parameter, clicking the URL opens the dashboard with the time machine paused to the time that matches your tm parameter settings.

The value of the tm parameter should follow one of these three formats:

  • <VT> - a date in UTC format, which will be set as the time to display; the knowledge time is set to With latest knowledge.

    Example: Payment search with Clearing House set to Paris, displayed at 10:54 AM (UTC time) on the 27th of April 2016, with the latest knowledge available

    http://localhost:8080/app#/dashboards/2-1-E7CGxSjQAAE;param3=00000002-0001-0001-13A9-323B8AB01801;tm=2016-04-27T10:54:00Z

  • <VT>@RealTime - see description above for <VT>; the knowledge time will be set to With real time offset.

    Example: Payment search with no search criteria configured, displayed at 10:54 AM (UTC time) on the 27th of April 2016, with the knowledge available at that time

    http://localhost:8080/app#/dashboards/2-1-E7CGxSjQAAE;tm=2016-04-27T10:54:00Z@RealTime

  • <VT>@<TT> - see description above for <VT>; the time machine will use the specific knowledge time represented by the <TT> value, which is a UTC date as well.

    Example: Payment search with Clearing House set to Paris, displayed at 10:54 AM (UTC time) on the 27th of April 2016, with the knowledge available at 10:00 AM

    http://localhost:8080/app#/dashboards/2-1-E7CGxSjQAAE;param3=00000002-0001-0001-13A9-323B8AB01801;tm=2016-04-27T10:54:00Z@2016-04-27T10:00:00Z

Troubleshooting issues

If the parameter value is not set as expected, make sure that:

  • The parameter is of type Entity.
  • If the parameter value is not a UUID, also make sure a simple key (with only 1 attribute) of type Integer or String is specified on the entity.
  • The URL identifier is the configured one for the given parameter.
  • The value is a valid UUID for an instance of the same type as the parameter, and that particular instance was alive at the given resolution time.
  • The resolution time (if specified) has the correct format.
  • The parameter value doesn't contain one of the following characters:'@' or '%'.


Related Links