Setting up Interactive Portlets

This section contains the following topics:

How to Set up an Interactive Portlet for Real-time Data

Set up the CA Clarity PPM Web Service Connection to Xcelsius Visualizations

Add a Web Connection Definition

Add Flash Variable Definitions

Test the Data Connection at Design-time

Create the Interactive Portlet

Create Object or Global Parameters

How to Set up an Interactive Portlet for Real-time Data

The following process provides the basic steps on how to set up an interactive portlet that displays real-time CA Clarity PPM data. These instructions assume that you have installed the required tools for an Xcelsius implementation and have the appropriate access rights.

To get optimal performance from your Xcelsius visualizations, follow the guidelines outlined in the BusinessObjects Xcelsius 2008 User Guide. For example, set up complex calculations in the database queries.

In Xcelsius, create the visualization.
Best Practice: Create a mockup of the visualization and create a static visualization in Xcelsius when you first build an interactive portlet.

See the BusinessObjects Xcelsius 2008 User Guide for more information.
Set up the web services used to transfer data between CA Clarity PPM and Xcelsius. Do the following:
- Set up a CA Clarity PPM Web Service connection.
In Xcelsius, export the visualization to the Flash (SWF) file format and save this file to your local drive.
See the BusinessObjects Xcelsius 2008 User Guide for more information.
In CA Clarity PPM, create the interactive portlet.
For more information, see the Studio Developer’s Guide.
Create global and object parameters.
These interactive portlet parameters are used to define the CA Clarity PPM information that is sent to the Xcelsius visualization. Use these parameters to map to the Flash variables created in Xcelsius to establish the real-time data connection between CA Clarity PPM and Xcelsius.

For more information, see the Studio Developer’s Guide.

More Information:

Example: Interactive Portlet using Web Services Connection Method

Set up the CA Clarity PPM Web Service Connection to Xcelsius Visualizations

Use these steps to do the following:

Set up CA Clarity PPM Web Service as the data source
Establish real-time data transfers between CA Clarity PPM and the Xcelsius visualization

Follow these steps:

In CA Clarity PPM, create a query.
- Write a SELECT statement to transfer CA Clarity PPM data to Xcelsius.
- Add the SECURITY in the WHERE clause. You can include access rights information in NSQL statement to add advanced security to interactive portlets.
For more information, see the Studio Developer’s Guide.
Complete the following steps:
1. Navigate to CA Clarity PPM Web Services using the following URL.
```
http://<servername:port>/niku/wsdl/
```
2. View the web query WDSL associated with the query you created for your interactive portlet.
3. Make note of the URL of the query.
For more information, see the XML Open Gateway Developer Guide.
In Xcelsius, open the Data Manager and set up the web service to establish the connection with CA Clarity PPM.
See the BusinessObjects Xcelsius 2008 User Guide for more information.
1. Complete the following fields:
  
  WSDL URL
  
  Defines the URL of the web service to import the URL.
  
  Method
  
  Defines the Web service connection.
  
  Value: Query
  
  Web Service URL
  
  Defines the mapping for an output value of the Web service to a cell in the embedded spreadsheet.
  
  Query Code
  
  Defines the mapping for an output value of the Web service to a cell in the embedded spreadsheet.
  
  Records
  
  Defines the mapping for an output value of the Web service to a cell in the embedded spreadsheet.
2. Click the Usage tab and select Options to refresh the connection.
3. Click the Advanced tab and define the mapping for SOAP header to a cell in the embedded spreadsheet.
4. Create the following Flash variables. The names used to define these Flash variables are mapped to the interactive portlet as global and object parameters:
  - Session ID. Required to receive the Session ID of the CA Clarity PPM user accessing the Xcelsius visualization in CA Clarity PPM. This named Flash variable is mapped to the interactive portlet as the Clarity Session ID in SOAP Header global parameter.
  - (Optional) Web Service URL. Optional. Define if you want to use the same Xcelsius visualization as is on multiple CA Clarity PPM servers. This named Flash variable is mapped to the interactive portlet as the Clarity Web Service URL global parameter.
  - (Optional) Other CA Clarity PPM information, such as user name, user internal ID, or language. These named Flash variables are mapped to the interactive portlet as the Clarity User Name, Clarity User Internal ID, or Language global parameters, respectively.
  - (Optional) CA Clarity PPM object-related information to change the behavior based on where the interactive portlet is located in CA Clarity PPM. These named Flash variables are mapped to the interactive portlet as the object parameters that you create.

Add a Web Connection Definition

Create a connection definition in Xcelsius using the Data Manager. The approach to connecting real-time data from CA Clarity PPM to an Xcelsius visualization can vary depending on the following:

Your level of experience with Xcelsius and Microsoft Excel spreadsheets (basic as opposed to advanced)
Connection choices you make, such as dynamically connecting to multiple Web Service URLs or displaying a visualization in another language
The complexity of the visualization you are designing in Xcelsius

To allow real-time CA Clarity PPM data transfers, you must bind elements to cells in the embedded Excel spreadsheet of a visualization. The series of steps enable the components of the visualization to retrieve data from the cells to which they are bound. The external data connection must be configured to insert data into the embedded spreadsheet. Components that use the data from the external source are then bound to the cells updated by the external connection.

The following figure shows the Data Manager with a basic external data connection setup:

Illustrates the set up for a Web Service Connection

The following figure illustrates the corresponding, embedded spreadsheet for the web service connection:

This illustrates the spreadsheet for the web services connection

Create an external data connection for each query associated with the visualization. In addition, create one for the Flash variables that map to the global and object parameters.

Query external data connection. Enables you to link data connection and query elements to cells in the embedded spreadsheet. For example, you might link the following to spreadsheet cells: the WSDL URL, connection method, web service URL, and each query data element.
Flash Variable external data connection. Enables you to create named Flash variables used in global and object parameters of an interactive portlet, such as the required global parameter, session ID.

For complete information about how to set up a data connection definition, see the following:

SAP BusinessObjects Xcelsius 2008 User Guide.
The following section in this guide: Example: Interactive Portlet Using Web Services Connection.
The sample file Resource Dashboard.xlf. This file is provided as part of the Design Files for Xcelsius Visualizations download available from CA Clarity PPM. You can open the file in Xcelsius to view the Data Manager and the embedded Excel spreadsheet.

Add Flash Variable Definitions

Flash variables are defined in Xcelsius. For each Flash variable, create a corresponding global or object parameter for the interactive portlet in CA Clarity PPM. At runtime, the Web Service URL passes a value from CA Clarity PPM using the parameter to the Flash variable. The Flash variable saves the value to a linked (bound) cell in the embedded spreadsheet. Components in the visualization are also bound to spreadsheet cells and the visualization data is generated from the embedded spreadsheet.

Test the Data Connection at Design-time

After you set up the run-time connection, test the data connection from Xcelsius. Do the test before you export the Xcelsius visualization to a SWF file.

Important! Cross-domain must be enabled if you are logged in to CA Clarity PPM through a different URL than your Web Services URL.

Follow these steps:

Log in to CA Clarity PPM, and click the About.
The about page appears.
In the User information section, make note of your current session ID.
In Xcelsius, do the following:
1. Create a row in the embedded spreadsheet and complete the following actions:
  - In cell a, add a label, such as Design-time Session ID.
  - In cell b, enter the following:
```
<n0:Auth><n0:SessionID>0000000__-0z11111:22y222222x2:-3a3b3333333333333</n0:SessionID></n0:Auth>
```
    where 0000000__-0z11111:22y222222x2:-3a3b3333333333333 is your current session ID
    
    Note: If you close your CA Clarity PPM session, update this cell with your latest session ID.
2. Create a second new row in the embedded spreadsheet and complete the following actions:
  - In cell a, add a label, such as Design-time URL.
  - In cell b, enter the web service URL.
In Xcelsius, save the visualization and preview it to test the connection.
If the connection is successful, you are ready to export to a .SWF file. If the connection is not successful recheck your data connection settings.

Create the Interactive Portlet

Use the following procedure to create an interactive portlet and import the Xcelsius visualization.

Before you start, create the Xcelsius visualization and export it to the Flash (.SWF) format.

Follow these steps:

In CA Clarity PPM, open Administration, and from Studio, click Portlets.
The portlet list appears.
Click New Portlet and select Interactive Portlet.
The create page appears.
Complete the following fields:

Portlet Name

Defines the name of the portlet. This name appears on the title bar of the portlet and in the list of available portlets.

Portlet ID

Defines a unique alphanumeric identifier for the portlet.

Content Source

Specifies where the data that appears in the portlet originates.

Category

Specifies the general area on which the portlet reports data.

Description

Defines the purpose of the portlet and provides any relevant information.

Active

Indicates the portlet is active and is visible to users. You can edit inactive portlets and activate them later.

Default: Selected

Instance Type

Specifies the type of page the portlet can be placed on. If you select General, the portlet can be added to any CA Clarity PPM page. If you select an Object, the portlet can only be added to CA Clarity PPM pages associated with that Object.

Visualization File (.swf)

Specifies the .SWF file used for the interactive portlet content.

Click the Browse icon to select the .SWF file. Do not enter or copy the file path.
Save the changes.
The Xcelsius visualization is imported into the interactive portlet.

Create Object or Global Parameters

Interactive portlet object or global parameters define the data that is exchanged between CA Clarity PPM and the Xcelsius visualization. Your CA Clarity PPM administrator defines the Flash variables in Xcelsius while designing the visualization. The Flash variables allow the visualization to accept information from CA Clarity PPM. You use the Flash variable name when you create parameters in the interactive portlet.

Your CA Clarity PPM administrator must first create the Xcelsius visualization and the required Flash variables before you can create object or global parameters.

Important! You can delete object and global parameters from the parameters list page. Use care when deleting global and object parameters. Deleting these parameters can cause data instability in the Xcelsius visualization.

Follow these steps:

In CA Clarity PPM, open the interactive portlet.
Click Parameters.
The interactive portlet parameters list page appears.
Click New and select either Object Parameter, or Global Parameter from the drop-down.
The properties page appears for the selected parameter type.
Complete the following fields:

Global Parameter

(Global Parameter only) Displays the selected global parameter.

Required: Yes

Object

(Object Parameter only) Displays the name of the object to which this object parameter is associated.

Field

(Object Parameter only) Specifies the field name. The values displayed are associated with the selected object.

Required: Yes

Flash Variable Name

Defines the name for the flash variable. This name must be the same as the Flash Variable Name associated with the visualization.

For Global Parameter, BusinessObjects Session ID, displays the required value: CELogonToken

Required: Yes

Description

Defines the description for the parameter.

Limits: 240 characters

Required: No
Save the changes.

More information:

Object Parameters (Interactive Portlets)