Configuring the Program Dashboard

This section describes the process for configuring the Program Dashboard.

Refer to the Using the Program Dashboard section of the Business User Guide for more information on this functionality.

This dashboard leverages a method of pre-staging data known as Statistics Snapshots. See Understanding Statistics for more information on statistics snapshots.

Configuring the Program Dashboard includes the following:

Master Configuration

To access the Master Configuration portal select Admin, select General, then select Master Configuration.

Select the Program Dashboard Configuration master configuration.

Use the Add button beside the record to configure for the first time. If a record has already been added, then click the Edit button instead. Use the embedded help to guide you through the meaning of each configuration field.

This master configuration includes the following options:

  • Color Options: Allows configuration of the colors used for Enrolled, Unenrolled, and Active data on the graph.

  • Chart Options: The Stacked Bars option specifies if bar graphs for enrollments and unenrollments should display as stacked bars (checked) or as a part of side by side bars (unchecked).

Configure Statistic Control and Statistic Snapshots

Statistic controls are the source for capturing the numbers of enrolllments, unenrollments, and active program subscriptions.

Statistic snapshots capture the numbers for each metric. Statistic controls are configuration records that define the specific types of metrics to capture.

Statistic snapshots are captured periodically via the F1-STATS (Statistics Control Monitor) batch program.

Configure the following Statistics Control records:

Statistics Control

Description

Category

Status

Snapshot Frequency Hours

Retention Mode

Snapshot Business Object

MONTHLY

Program Dashboard Statistics Control - Monthly

Operational

Active

24.00

Retain All Snapshots

Subscription Trend Snapshot - Monthly (X1-SubscriptionTrendMonthly)

WEEKLY

Program Dashboard Statistics Control - Weekly

Operational

Active

24.00

Retain All Snapshots

Subscription Trend Snapshot - Weekly (X1-SubscriptionTrendWeekly)

See Capturing Statistics for more information about statistics.

Configure Subscription Trend Snapshot Business Objects and Algorithms (Optional)

By default, the Subscription Trend Snapshot business objects are configured to capture 13 months of data per snapshot. This can be changed by adjusting the value of the “Period Bucket Limit” parameters on the Create Subscription Trend Snapshot algorithms (defined as Enter algorithms on the Complete state of the snapshot business objects).

The table below lists the snapshot business objects and their respective algorithms.

Snapshot Business Object

Create Subscription Trend Snapshot Algorithm

Subscription Trend Snapshot - Monthly (X1-SubscriptionTrendMonthly)

Create Subscription Trend Snapshot - Monthly (X1-CRESTS)

Subscription Trend Snapshot - Weekly (X1-SubscriptionTrendWeekly)

Create Subscription Trend Snapshot - Weekly (X1-CRESTSWKY)

Configure Statistics Control Business Object

The Statistics Control (F1-Statistics) business object should be configured to specify the "Statistics Control Monitor"  batch control in the Monitor Process drop-down list on the "Active" state.

To configure this business object, do the following:

  1. Open the Statistics Control (F1-Statistics) business object in the Business Object portal.

  2. Navigate to the Lifecycle tab, and expand the "Active" state.

  3. Select "Statistics Control Monitor" from the Monitor Process drop-down list.

  4. Click Save.

Batch Processing

The Program Dashboard dashboard is configured to be refreshed regularly (as frequently as daily). To refresh the data used in the dashboard, the F1-STATS batch process should be processed in sequence after other regularly schedule batch processing is complete to generate statistic snapshots based on statistic controls.

Use the following parameters when running this batch process:

  • Maintenance Object (maintenanceObject): F1-STATS

  • Restrict by Business Object (restrictToBusinessObject): F1-Statistics

  • Restrict by Status Code (restrictToBOStatus): ACTIVE