Setting Up the Dashboard

This chapter provides an overview of dashboard setup and discusses how to:

Define system settings.
Initiate a batch data load.

See Also

Understanding the Messaging Framework

Understanding Security Integration

Understanding Dashboard Setup

This section discusses:

General settings.
Currency settings.
Security settings.
Batch data loads.

General Settings

Dashboard installation options include the following general settings:

A source system ID that is sent to the dashboard system with every row of data.

Although this ID is not used in the dashboard reports, it is stored in the dashboard system for informational and troubleshooting purposes.
The part of your PeopleSoft URL that is common to all pages in the PeopleSoft system.

This is sent to the dashboard system and used to generate links back to the PeopleSoft system.
The amount of time that the Change Notification process rests after finding an empty message queue and before checking for new message queue arrivals.
The maximum size of the messages that the Change Notification process sends to the dashboard.
Whether to validate the data type (string, integer, and so forth) of any parameters that are included in action requests that PeopleSoft receives from the dashboard system.
Whether you set up parallel processing at installation time.

See The Messaging Framework.

Currency Settings

The currency architecture for PeopleSoft CRM dashboard applications requires that you select a default currency. This is the currency that is used in all delivered dashboard reports. You can use Oracle Business Activity Monitoring (Oracle BAM) to create additional reports that display information using currencies other than the default.

PeopleSoft CRM also provides a daily process for sending currency exchange rates to the dashboard so that the financial data in transactions, which can be in any currency, can be converted to the default currency. Because the PeopleSoft system can store several different exchange rate types, the process that sends the exchange rates to the dashboard system requires you to select which rate type to use.

For detailed information about how PeopleSoft CRM dashboard applications handle currencies, refer to your application documentation.

Security Settings

When you set up dashboard installation options, you select the three PeopleTools roles to be used for assigning users to the three dashboard roles that the initial data load process creates: User, Implementer, and Administrator. Then, to run the security synchronization process, you click the Send Security button on the Installation Options page.

See Security Synchronization.

Batch Data Loads

The dashboard integration framework provides a generic batch data load process to move specified subsets of your data into the dashboard system. When you request a batch data load, you can enter parameters to filter which applications or which objects you want to load.

PeopleSoft CRM provides an additional process to use for the initial load of CRM data into the dashboard system. PeopleSoft CRM implementers should load the dashboard system using the CRM process rather than the generic batch data load. The CRM process offers the performance benefits of parallel processing to help handle the high volume of the initial data load.

Note. The dashboard integration framework does not facilitate the deletion of expired data from the dashboard system. Instead, use Enterprise Link plans to handle deletions. PeopleSoft dashboard applications are all delivered with deletion plans; the deletion criteria is documented in your dashboard application documentation. Use Enterprise Link to modify the deletion criteria in those plans.

See Also

PeopleSoft Enterprise 9 Dashboard Applications PeopleBook

Defining System Settings

This section lists prerequisites and discusses how to:

Set up installation options.
Verify messaging connections.

Prerequisites

If you prefer not to use the delivered dashboard security roles, use PeopleTools to establish your own dashboard security roles.

Pages Used to Define System Settings

Page Name	Object Name	Navigation	Usage
Installation Options	PT_CDB_INSTALL	Set Up CRM, Product Related, Dashboard, Installation Options, Installation Options	Set up system-wide settings for messaging, security, currency handling, and transfers from the dashboard to the PeopleSoft system.
Message Setup	PT_CDB_EMS_SETUP	Set Up CRM, Product Related, Dashboard, Message Setup, Message Setup	Verify messaging connections by checking whether the dashboard Enterprise Message Sources (EMS) are listening to the correct JMS. Correct the EMS settings if necessary.

Setting Up Installation Options

Access the Installation Options page.

Setting Options

Source System ID	Enter an identifier of up to five characters. The Change Notification process embeds this identifier in each record that is sent to the dashboard system. Although the dashboard reports do not use the source system ID, your dashboard administrator can use this to identify the source of particular data if the dashboard is receiving data from multiple sources. The delivered value is ECRM, which indicates that data originates from the PeopleSoft Enterprise CRM system.
Transfer to PIA URI (transfer to PIA uniform resource identifier)	When a dashboard report displays an action form, the list of individual transactions includes links that the dashboard user can click to navigate to the specific transaction in PIA. For the link to work, the dashboard needs to construct a URL that is made up of two parts: The URI (uniform resource identifier) is the subset of the URL that points to the location of the resource, but does not include any parameters passed to that resource. This is the value that you must enter in the Transfer to PIA URI field. The query string includes the parameters (such as the page name and values for the transaction's key fields) that are specific to the transaction. For example, consider the following URL: http://someserver/psp/CRM89/EMPLOYEE/CRM/c/CALLCENTER.RC_CASE_SEARCH.GBL?DISP_TMPL_ID=RC_SUPPORT. The URI portion of this URL is: http://someserver/psp/CRM89.
Validate Action Parameter Type	Select this check box to make the system validate the data type of all parameters that are included in action requests that are received from the dashboard. Each action definition in the PeopleSoft system includes a list of parameters and their data types; this list is used to validate the action message. See Identifying Action Application Classes and Parameters.
Parallel Processing Enabled	Select this check box if your system has multiple Process Scheduler servers for parallel processing. The change notification process uses this setting to determine whether to process change queue entries from different applications in parallel. If multiple dashboard applications are installed and parallel processing capabilities are available, then selecting this check box improves performance. Note. Although the CRM initial data load can perform parallel processing on one Process Scheduler server with multiple AESRV process instances, the change notification framework offers parallel processing only if there are multiple Process Scheduler servers. Refer to your installation documentation for information on setting up Process Scheduler servers for parallel processing. See PeopleSoft Enterprise Customer Relationship Management 9 Supplemental Installation Guide
Maximum Message Size (Byte)	Enter the maximum size in bytes of the XML messages that the Change Notification process creates. Although larger messages can take longer to transmit, they also result in fewer messages and reduced messaging traffic. As delivered, the maximum message size is 200,000 bytes. Regardless of the maximum message size you enter, the Change Notification process never splits a single record into multiple messages. Important! The value here must be the less than or equal to the maximum message size that is defined in the Java Messaging Service (JMS) system. The system discards the messages that exceed the size defined in JMS.
Maximum Inactivity Time	Enter the number of minutes that the Change Notification process idles before going dormant. Once the process goes dormant, the daemon that you set up during installation must awaken the process before it begins processing more entries.
Default Currency Code	Select the currency to be used in all delivered currency-related dashboard reports. This does not have to be the same as the base currency for the PeopleSoft system. Note. Currency handling is part of the dashboard application, not part of the dashboard integration framework. For more information, refer to the dashboard application documentation.
Default Exchange Rate Type	Enter the type of exchange rate to be used by the process that loads currency conversion rates into the dashboard system. The rate type that you select is used to convert transaction currencies to the default currency. Although this field does not support prompting, you must enter a value that exists in the currency exchange rate table (PS_CUR_RT_TYPE_TBL). Delivered values are ASK, (Asked Rate) AVG, (Average) BID, (Bid Rate) CLOSE, (Closing Rate) COMM, (Commercial Rate) CRRNT, (Current Rate) FINAN, (Financial Rate) FLOAT, (Floating Rate) FMKT, (Free Market Rate) HIST, (Historical Rate) HST1A, (Historical Rate - Issue 1A) HST1B, (Historical Rate - Issue 1B) HSTRE, (Historical - Retained Earnings) MID, (Mid Rate) OFFIC, (Official Rate) SPOT, (Spot Market Rate) and VOL (Volatility). Refer to your application documentation for more information about currencies.

Security

This section explains how to use the role fields to implement security for your dashboard applications.

Note. To change the administrator role, implementer role or user role, you must start the PTCDB process scheduler deamon using the PTCDBADMIN user ID. You also need to update the PT_CDB_WEB_SERVICE node with a valid user ID that is not PTCDBADMIN. For example, you could use VP1 as your non-PTCDBADMIN user ID.

Administrator Role	Select a PeopleTools role that gives its members administrator privileges in Oracle BAM. As delivered, users with administrator privileges have access to all Oracle BAM functionality.
Implementer Role	Select a PeopleTools role that gives its members implementer privileges in Oracle BAM. As delivered, users with implementer privileges have access to all Oracle BAM functionality except access to the Administrator application, which is used to administer users and their permissions.
User Role	Select a PeopleTools role that gives its members viewer access to dashboards.
Send Security	Click this button to run the security synchronization process. The first time this process runs, it loads complete user information into the dashboard system. Subsequent synchronizations send only changes to the dashboard system. Important! You need to run the security synchronization process frequently. It is not possible to set up a Process Scheduler request to do this because of Process Scheduler limitations in PeopleTools 8.48.

JMS Connectivity

The display-only fields in this group box display settings for the PT_CBD_UPDATE PeopleTools Integration Broker node—the node with information about the JMS server where dashboard messages are sent.

Note. Integration Broker does not communicate directly with the JMS server. Integration between the PeopleSoft system and the dashboard system bypasses the Integration Broker gateway and instead uses a JMS sender on the application server. Therefore, you cannot use the Integration Broker ping feature or message monitor as a troubleshooting tool for JMS messaging.

Ping

Click this button to ping the JMS server to verify JMS connectivity. You cannot use the ping feature in Integration Broker because Integration Broker is not connecting directly to the JMS server.

See Also

PeopleSoft Enterprise Customer Relationship Management 9 Supplemental Installation Guide

Verifying Messaging Connections

Access the Message Setup page.

Properties for IB Node PT_CDB_UPDATE

The fields in this group box display settings for the PT_CBD_UPDATE PeopleTools Integration Broker node—the node for the JMS server where the system sends dashboard messages.

Buttons for Retrieving and Fixing EMS Information

Retrieve Message Sources

Click this button to populate the Dashboard Enterprise Message Sources grid on this page with a list of every EMS in the dashboard system.

This button uses information from the PT_CDB_WEB_SERVICE IB Integration Broker node definition to access the dashboard system and pull the information into PeopleSoft. Both the PT_CDB_WEB_SERVICE, and PT_CDB_UPDATE IB nodes must be set up before you can use the button.

See PeopleSoft Enterprise Customer Relationship Management 9 Supplemental Installation Guide

Fix All EMS (fix all enterprise message sources)

Click to correct every EMS that listens to a JMS other than the one that is specified in the PT_CBD_UPDATE IB node definition.

Dashboard Enterprise Message Sources

This grid displays information about the Enterprise Link enterprise message sources that receive data from the PeopleSoft system.

Fix EMS (fix enterprise message service)	Click to fix a single EMS when the EMS is not listening to the correct JMS.
Difference Found	This check box is selected if the EMS listens to the wrong JMS and needs to be fixed.
Message Source Name	Displays the name of the EMS in the Oracle BAM Enterprise Link.
JMS URL, JMS Provider, Initial Context Factory, JMS Topic, and Connection Factory	These fields display information about the JMS to which the EMS is listening.

See Also

Integration Setup

Oracle BAM Enterprise Link Administrator's Guide

Initiating a Batch Data Load

This section discusses how to initiate batch data loads.

Note. For the PeopleSoft CRM initial data load, use the process that PeopleSoft provides for that specific purpose.

See PeopleSoft Enterprise 9 Dashboard Applications PeopleBook

Page Used to Initiate a Batch Data Load

Page Name	Object Name	Navigation	Usage
Batch Data Load	RBD_BATCH_LOAD	Set Up CRM, Product Related, Dashboard, Batch Data Load, Batch Data Load	Schedule the loading of data into the active data cache (ADC) for all installed objects, for a specific application, or for another subset of objects.

Initiating Batch Data Loads

Access the Batch Data Load page.

Run Now and Advance Schedule

Click one of these buttons to run the Batch Data Load (PT_CDB_BATCH) Application Engine process. This process generates message queue entries for the objects that you specify using the run control parameters on this page.

Initial Load

Select this check box if you want to invoke any application-specific processing that is associated with an initial data load. Refer to your dashboard application documentation for more details.

There is a different data load process to use for the CRM dashboard applications initial data load, so you will not normally select this check box.

Load All

Select this option to load all data for all dashboard applications.

Load by Application

Select this option to load all data for selected dashboard applications, and then select the objects for which you want to load data. For PeopleSoft CRM 9, your choices are:

Common Dashboard

Contact Center Dashboards

This includes the dashboards for PeopleSoft Support, HelpDesk, and HelpDesk for Human Resources.

Order Capture Dashboard

Sales Dashboard

Load by Object

Select the Load by Object option to load all data for selected dashboard objects. If you select this option, the system loads the objects that are listed in the Dashboard Message Objects grid.

Load Grid Options and Prefill Grid

If you selected Load by Object, you can generate a list of objects in the Dashboard Message Objects grid by selecting one of the Load Grid Options values and clicking the Prefill Grid button. After the Prefill Grid button has added objects to the grid, you can manually modify the grid contents before running the initial load process.

All Installed Objects

Select to make the Prefill Grid button add all objects for all dashboard applications to the Dashboard Message Objects grid.

Unless you then manually delete objects from the grid, this is the same as selecting the overall Load All option.

For a Specific Application and Application Code

Select For a Specific Application to make the Application Code drop-down list box appear. Then select a specific application whose objects the Prefill Grid button will add to the Dashboard Message Objects grid.

The values in the Application Code drop-down list box are the same as the list of applications for the overall Load by Application option.

Unless you then manually add or delete objects from the grid, this is the same as selecting the Load by Application option for the initial data load except that you can't select multiple applications as you can with the Load by Application option.

For a Specific Group and Object Group ID

Select For a Specific Group to select specific subsets of dashboard objects to load. When you select this option, the Object Group ID drop-down list box appear and you can select specific object groups.

Note. Load dimensions before facts.

See Dashboard Data.

Dashboard Message Objects

When you select the Load by Object option, the batch data load process loads only the dashboard objects that appear in this grid and that have the Include in Batch check box selected.

The system populates this grid when you click the Prefill Grid button, but you can also modify the grid contents manually. Rather than deleting rows, however, you can clear the Include in Batch check box. Clearing the check box ensures that the associated object will not be included when you run the batch data load process, but it leaves the object name in the grid where you can see it and easily reselect it if necessary.

Run Now and Advance Schedule	Click one of these buttons to run the Batch Data Load (PT_CDB_BATCH) Application Engine process. This process generates message queue entries for the objects that you specify using the run control parameters on this page.
Initial Load	Select this check box if you want to invoke any application-specific processing that is associated with an initial data load. Refer to your dashboard application documentation for more details. There is a different data load process to use for the CRM dashboard applications initial data load, so you will not normally select this check box.
Load All	Select this option to load all data for all dashboard applications.
Load by Application	Select this option to load all data for selected dashboard applications, and then select the objects for which you want to load data. For PeopleSoft CRM 9, your choices are: Common Dashboard Contact Center Dashboards This includes the dashboards for PeopleSoft Support, HelpDesk, and HelpDesk for Human Resources. Order Capture Dashboard Sales Dashboard
Load by Object	Select the Load by Object option to load all data for selected dashboard objects. If you select this option, the system loads the objects that are listed in the Dashboard Message Objects grid.
Load Grid Options and Prefill Grid	If you selected Load by Object, you can generate a list of objects in the Dashboard Message Objects grid by selecting one of the Load Grid Options values and clicking the Prefill Grid button. After the Prefill Grid button has added objects to the grid, you can manually modify the grid contents before running the initial load process.
All Installed Objects	Select to make the Prefill Grid button add all objects for all dashboard applications to the Dashboard Message Objects grid. Unless you then manually delete objects from the grid, this is the same as selecting the overall Load All option.
For a Specific Application and Application Code	Select For a Specific Application to make the Application Code drop-down list box appear. Then select a specific application whose objects the Prefill Grid button will add to the Dashboard Message Objects grid. The values in the Application Code drop-down list box are the same as the list of applications for the overall Load by Application option. Unless you then manually add or delete objects from the grid, this is the same as selecting the Load by Application option for the initial data load except that you can't select multiple applications as you can with the Load by Application option.
For a Specific Group and Object Group ID	Select For a Specific Group to select specific subsets of dashboard objects to load. When you select this option, the Object Group ID drop-down list box appear and you can select specific object groups. Note. Load dimensions before facts. See Dashboard Data.
Dashboard Message Objects	When you select the Load by Object option, the batch data load process loads only the dashboard objects that appear in this grid and that have the Include in Batch check box selected. The system populates this grid when you click the Prefill Grid button, but you can also modify the grid contents manually. Rather than deleting rows, however, you can clear the Include in Batch check box. Clearing the check box ensures that the associated object will not be included when you run the batch data load process, but it leaves the object name in the grid where you can see it and easily reselect it if necessary.