Previous Topic: Interactive Portlet ParametersNext Topic: Object Parameters (Interactive Portlets)


Global Parameters (Interactive Portlets)

Global parameters represent information that is available at the global level in CA Clarity PPM. By including an interactive portlet, you make the data part of any CA Clarity PPM page, including an object page, such as the Project object.

You create global parameters from the interactive portlet in CA Clarity PPM using Studio. The data for the global parameter is made available to the Xcelsius visualization as a Flash variable. You define the mapping between the Flash variable in Xcelsius and the global parameter in the Global Parameter field. This data is available regardless of where the interactive portlet appears on CA Clarity PPM pages.

Example

Suppose you create the Language global parameter in your interactive portlet, assigning to the Flash variable the name "Lang". The language preference of the logged-in CA Clarity PPM user is available to the Xcelsius visualization in this Flash variable "Lang". As a global parameter, this parameter applies regardless of which CA Clarity PPM page includes the interactive portlet.

When configuring either of the web service connection methods in the Xcelsius Data Manager, specify the URL where the web service is hosted. You can explicitly specify the server where your web services are hosted. Alternatively, you can use the same Xcelsius visualization as-is on multiple CA Clarity PPM servers. Create either the Clarity Web Service URL global parameter or the Business Objects Web Service URL global parameter. Then enter the web service URL corresponding to the CA Clarity PPM server on which you view the Xcelsius visualization.

Download the Design Files for Stock Xcelsius Visualizations from the software downloads page. From this download, review the stock Xcelsius visualizations and better understand how these parameters are used.

Parameters

The following global parameters are available:

Business Objects Session ID

Authenticates the user.

Connection Method: Query as a Web Service

Required: When using the Query as a Web Service connection method.

Flash Variable Name: Must match the CELogonToken Flash variable name defined in Xcelsius.

Business Objects Web Service URL

Maps to the Web Service URL for the CA Clarity PPM server from which the Xcelsius visualization is viewed.

Connection Method: Query as a Web Service

Required: When using the same Xcelsius visualization as-is on multiple CA Clarity PPM servers. Provide either the Web Service URL or the name of the server which hosts your web services.

Flash Variable Name: Must match the Flash variable name defined in Xcelsius.

Example:

http://<BO_servername>/dswsbobje/qaawsservices/
Clarity Session ID in SOAP Header

Authenticates users.

The SessionID is used to authenticate with the web service.

Connection Method: CA Clarity PPM Web Service

Required: When using the CA Clarity PPM Web Service connection method.

Flash Variable Name: Must match the Flash variable name defined in Xcelsius.

Example:

<n0:Auth><n0:SessionID><CLARITY_SESSION_ID>
</n0:SessionID></n0:Auth>
Clarity User Internal ID

Identifies the Internal ID associated with the logged in CA Clarity PPM user.

You can use this global parameter to filter data by the internal ID to allow users to view global, user-specific information from the Xcelsius visualization.

Connection Method: CA Clarity PPM Web Service and Query as a Web Service (QaaWS)

Required: No

Flash Variable Name: Must match the Flash variable name defined in Xcelsius.

Clarity User Name

Identifies the user name of the logged in CA Clarity PPM user.

You can use this parameter to filter data by the user name to allow users to view global, user-specific information from the Xcelsius visualization.

Connection Method: Web Service Connection and QaaWS

Required: No

Flash Variable Name: Must match the Flash Variable name defined in Xcelsius.

Clarity Web Service URL

Maps the Web Service URL when you use the CA Clarity PPM Web Service connection method to access CA Clarity PPM web services.

Connection Method: CA Clarity PPM Web Service Connection

Required: When using the same Xcelsius visualization as-is on multiple CA Clarity PPM servers. Provide either the Web Service URL or the name of the server which hosts your web services.

Flash Variable Name: Must match the Flash variable name defined in Xcelsius.

Example:

http://<servername>/niku/xog
Language

Identifies the language preference of the logged in CA Clarity PPM user. The user can determine the language associated with the Xcelsius visualizations using the account settings page.

Connection Method: CA Clarity PPM Web Service Connection and Query as a Web Service

Required: No

Flash Variable Name: Must match the Flash variable name defined in Xcelsius.

More Information:

Tools and Resources for an Xcelsius Implementation