OverrideConfiguredValues Class
This section provides an overview of the OverrideConfiguredValues class and discusses: OverrideConfiguredValues class methods.
Use the OverrideConfiguredValues class to override the configured Interactive Insights dashboard values. This class supports dashboard switching for use cases that are not dependent on page context. Applications can use this class to specify the replacement dashboard and optional filter application class for Tile View and Full View.
Use this class when you do not want to call the dashboard switch API from page Activate PeopleCode. During dashboard load, PeopleTools checks whether override values are available from the configured application class. If override values are provided, PeopleTools uses them to replace the configured dashboard values.
The GetOverriddenValues method returns an OverrideConfiguredValues object to PeopleTools when an application class provides dashboard override values.
The class includes properties for both Tile View and Full View dashboards.
| Property | Description |
|---|---|
|
DashboardName |
Specifies the replacement dashboard name for Tile View. |
|
AppClassName |
Specifies the application class that applies filters for the Tile View dashboard. |
|
fvDashboardName |
Specifies the replacement dashboard name for Full View. |
|
fvAppClassName |
Specifies the application class that applies filters for the Full View dashboard. |
Example
This example creates an OverrideConfiguredValues object and sets replacement dashboard names for Tile View and Full View.
import PTSF_INSIGHTS:OverrideConfiguredValues;
Local PTSF_INSIGHTS:OverrideConfiguredValues &overrideValues;
&overrideValues = create PTSF_INSIGHTS:OverrideConfiguredValues();
&overrideValues.DashboardName = "Billing Analysis Tile";
&overrideValues.AppClassName = "";
&overrideValues.fvDashboardName = "Billing Analysis";
&overrideValues.fvAppClassName = "";This example defines the GetOverriddenValues() method and returns an OverrideConfiguredValues object with replacement dashboard names for Tile View and Full View.
import PTSF_INSIGHTS:OverrideConfiguredValues;
method GetOverriddenValues
/+ Returns PTSF_INSIGHTS:OverrideConfiguredValues +/
Local PTSF_INSIGHTS:OverrideConfiguredValues &overrideValues;
&overrideValues = create PTSF_INSIGHTS:OverrideConfiguredValues();
&overrideValues.DashboardName = "Billing Analysis Tile";
&overrideValues.AppClassName = "";
&overrideValues.fvDashboardName = "Billing Analysis";
&overrideValues.fvAppClassName = "";
Return &overrideValues;
end-method;