Passing POV in the report URL
- Matija Lukic (Deactivated)
Starting with version 21.1.0, when opening the report, it is possible to pass the initial POV values, by adding more parameters to the URL.
This will enable you to pass POV context (e.g., from another solution) to a CXO report, thus ensuring a better user experience when users need to navigate between multiple reporting solutions.
Summary
Normally, the URL to open a report is <hostname>/report/<report-number>.
For example https://company.training.cxosoftware.com/report/93
To pass a POV in the report URL, add i URL query parameter initialPov=<dimension>:<value>;<dimension>:<value>.
For example https://company.training.cxosoftware.com/report/93?initialPov=YER:2010;PER:Jan
Opening this URL will show the data from the desired year and period.
Format of the POV in the URL
The standard format of the URL parameter is initialPov=<dimension>:<value>;<dimension>:<value>
Example: https://company.training.cxosoftware.com/report/93?initialPov=YER:2010;PER:Jan
Dimension: corresponds to the CXO dimension code, such as YER, PER, ENT, CAT, or ACC. List of all dimension codes can be seen, for example, in CXO Designer > Tools > Source system defaults
Value: corresponds either to desired POV member name or member description
Delimiters: by default a colon (:) and semicolon (;). If your member names or member descriptions contain these delimiters, it’s a good idea to change them CXO Configurator > Settings panel
POV overrides in URL: Array delimiter separates initial values for different POV dimension. Default value: semicolon (;)
POV overrides in URL: POV value delimiter separates a POV dimension from its value. Default value: colon (:)
Matching POV values
In a CXO report, each member has name and a description. When searching or changing POV, member descriptions are shown.
Member names are unique within that dimension, member descriptions don’t have to be unique.
The POV values in the URL are matched exactly either to a member name or a member description.
What is being matched is controlled with another URL parameter: initialPovValueSearchType.
Possible values:
description: member with the description equal to passed POV value is selected. If no members match this condition, then a member with the name equal to the passed POV is selected. If multiple members match this condition, the first one is selected.
Example: https://company.training.cxosoftware.com/report/93?initialPov=ENT:Europe&initialPovValueSearchType=description
first looks for a member with description “Europe“ in Entity dimension, and if not found, member with name “Europe“
name:
Example: https://company.training.cxosoftware.com/report/93?initialPov=ENT:EU;YER:2020&initialPovValueSearchType=name
looks for a member with name “EU“ in Entity dimension, and member with name “2020“ in Year dimension
If this parameter omitted, the behavior is the same as when value is description.
FAQ
On which pages can this feature be used?
Passing POV via URL parameters is only possible for URLs to reports (i.e., /report/<report-number/). For storyboards or conversations that is not possible.
On which dimension can this feature be used?
Dimensions that are in the report’s POV and that have default value set to Central.
Why is the passed POV value ignored when I set it in the URL?
The passed POV value is ignored, i.e., report is being opened as if the POV for that dimension was not passed via URL, when:
the initial POV value for a certain dimension doesn’t match any members.
the initial POV value for a certain dimension matches a member that user cannot view (i.e, the member is not in the users POV filters)
the dimension is not in the report’s POV
the dimension is in the report’s POV but it’s default value is set to something else than Central
What if I have URL reserved characters (such as space or ampersand) in my member name or description?
Try changing the delimiters using the CXO Configurator
Characters to be encoded (e.g., & to
%26and space to%20) - see this link for more info on URL reserved characters and their encoded values.