SetDefaultDashboard

Syntax

SetDefaultDashboard()

Description

Use the SetDefaultDashboard built-in PeopleCode API to initialize the context variables that PeopleTools uses for dashboard switching.

Call this API before invoking SwitchInsightsDashboard. Without this initialization, the session can continue to use a previously switched dashboard when the same configured dashboard is used elsewhere without a switch.

Call this API only once in the application page Activate event before invoking the dashboard switch API.

Parameters

None.

Returns

None.

Example

SetDefaultDashboard(); SwitchInsightsDashboard( "Bills by Bills Status", "Billing Analysis", "BI_EMBED_INSIGHT_FILTERS:BillingEmbedInsightFilter", "FV" );

In this example, SetDefaultDashboard initializes the switch context. PeopleTools then switches the configured Bills by Bills Status dashboard to Billing Analysis in Full View mode and applies filters from the specified application class.