Previous Topic: CA Clarity PPM Data Providers Used for CA Clarity PPM Web PartsNext Topic: Configuring CA Clarity PPM Web Parts in Non-CA Clarity PPM Project Sites


CA Clarity PPM Web Parts in CA Clarity PPM Project Sites

This section contains the following topics:

About CA Clarity PPM Web Parts

About CA Clarity PPM List Web Parts

About CA Clarity PPM Chart Web Parts

About CA Clarity PPM Web Parts

Microsoft SharePoint Connector includes custom Web Parts that enable you to access and display CA Clarity PPM project information in your SharePoint sites. You can use these customized Web Parts to access predefined (stock) and customized data providers in a CA Clarity PPM project. You can add one of the following CA Clarity PPM Web Parts:

You can configure more than one Web Part to access the same CA Clarity PPM project information. You can add CA Clarity PPM Web Parts to more than one Web Part zone or site and configure them to display the same CA Clarity PPM project information concurrently. For example, you can add two CA Clarity PPM List Web Parts: one Web Part to a CA Clarity PPM project site and another Web Part to a non-CA Clarity PPM project site. You can then configure both Web Parts to access the same data provider and the same CA Clarity PPM project. Similarly, you can configure two or more CA Clarity PPM List Web Parts in the same CA Clarity PPM project site, or in the same non-CA Clarity PPM project site, to access the same data provider.

Add CA Clarity PPM Web Parts to Project Sites

After creating a CA Clarity PPM project site, you can add CA Clarity PPM Web Parts to the site and configure the Web Parts to view data from a selected CA Clarity PPM data provider.

To manage CA Clarity PPM Web Parts, you require a Microsoft SharePoint permission level of Design or Full Control.

Follow these steps:

  1. On the Web Part page to add a CA Clarity PPM Web Part, click Site Actions, and then click Edit Page.

    You can edit the web part page.

  2. In the Web Part zone to add a Web Part, click Add a Web Part.

    The add web parts page appears.

  3. In the All Web Parts list, select the CA Clarity PPM Web Part, and click Add.

    The CA Clarity PPM Web Part is added to the Web Part zone.

Integrate Lists with Microsoft Outlook 2010

Some CA Clarity PPM data providers, such as the Tasks project sub-object, lay emphasis on attributes such as dates and milestones. After you configure a CA Clarity PPM List Web Part to display such a list, to track the list regularly, you can integrate the list with Microsoft Outlook 2010 and track the list from Microsoft Outlook.

Note: You can write and use NSQL queries that filter major milestones, such as phase gates, or common tasks, such as quarterly project review meetings. You can then use the Connect to Outlook command in a CA Clarity PPM List Web Part to get this information on everyone's task list in Microsoft Outlook.

You can integrate a list that is contained in a CA Clarity PPM List Web Part with Microsoft Outlook 2010 only if you selected the Task List check box while you configured the CA Clarity PPM List Web Part.

Follow these steps:

  1. In CA Clarity PPM List Web Part, click Actions, and then click Connect to Outlook.
  2. At the prompt, click Yes.

    The contents of the list appear in a new task folder that is created automatically in Other Tasks in Microsoft Outlook 2010.

Note: After you integrate the list with Microsoft Outlook, do not modify list items from the task folder that was automatically created in Microsoft Outlook. To modify any of the list items from within Outlook, first create a new task folder in Microsoft Outlook, move the list to the new task folder, and then modify list items from the new task folder.

Open List Items in CA Clarity PPM from Microsoft SharePoint

The list displayed in a CA Clarity PPM List Web Part may have to be updated regularly. The existing list items can be modified and new items require to be added. However, because you cannot modify the list in a CA Clarity PPM List Web Part directly, but from within CA Clarity PPM.

You can use the Link to Clarity feature that is provided on the list item menu to open the CA Clarity PPM properties page. The item CA Clarity PPM properties page opens in a new browser window to make the required changes.

You can change the list item in CA Clarity PPM. However, any changes you make in CA Clarity PPM are not reflected in Microsoft SharePoint on the CA Clarity PPM List Web Part. If you modify or delete a list item in CA Clarity PPM, synchronize the list with CA Clarity PPM before the changes display in the CA Clarity PPM List Web Part.

Follow these steps:

  1. Point to the title of the list item, click the arrow that appears, and click Link to Clarity.

    If you are logged into CA Clarity PPM, the CA Clarity PPM properties page appears in a new browser window.

  2. If you are not logged into CA Clarity PPM, on the CA Clarity PPM login page that appears, enter your CA Clarity PPM user name and password, and then click Login.

    The CA Clarity PPM properties page for the list item appears.

Configure CA Clarity PPM Web Part to Display CA Clarity PPM Documents

You can configure a CA Clarity PPM Web Part to display documents from a CA Clarity PPM project Document Manager repository.

Note: A CA Clarity PPM List Web Part displays a nonhierarchical list of the documents that are contained in all the folders in the CA Clarity PPM project Document Manager. Additional information about the documents, such as a document parent can be displayed in columns in the Web Part.

Follow these steps:

  1. In the Web Part menu of the CA Clarity PPM List Web Part, click Edit, and click Modify Shared Web Part.

    The tool pane appears.

  2. In the CA Clarity PPM section of the tool pane, from the CA Clarity PPM Data Provider list, select Documents, and wait for the page to refresh.
  3. (Optional) Customize the Web Part by providing details in the Appearance, Layout, and Advanced sections.

    Note: For more information about customizing the Web Part, see the Microsoft Windows SharePoint documentation.

  4. Click OK.

    The CA Clarity PPM List Web Part displays all the documents that are stored in the CA Clarity PPM project Document Manager repository.

View the Contents of a CA Clarity PPM Project Document from Microsoft SharePoint

You can configure a CA Clarity PPM List Web Part to display a list of documents that are stored in the CA Clarity PPM project Document Manager repository. In this case, you can view the contents of any document from within Microsoft SharePoint without having to log into CA Clarity PPM.

Follow these steps:

Point to the title of the document, click the arrow that appears, and then click Open from Clarity. The CA Clarity PPM project document opens in a new browser window or in the associated application.

Note: You can edit a document that the associated application opens, but you cannot save the changes into CA Clarity PPM. To modify the document, do so from within CA Clarity PPM.

About CA Clarity PPM List Web Parts

Use CA Clarity PPM List Web Parts to view and share lists of project sub-object instances or the results from Studio queries. After you add and configure a CA Clarity PPM List Web Part, you can use Microsoft SharePoint to manage the list retrieved from CA Clarity PPM.

CA Clarity PPM List Web Part Compatibility with Microsoft SharePoint Features

After you add and configure a CA Clarity PPM Web Part to a CA Clarity PPM project site, you can use the various Microsoft SharePoint features provided in the Web Part or the associated list, with the exception of a few features that you use to modify information in the list.

CA Clarity PPM List Web Parts are compatible with the following Microsoft SharePoint features:

CA Clarity PPM List Web Part Model

Every CA Clarity PPM List Web Part is associated with the following:

Essentially, a CA Clarity PPM List Web Part and the SharePoint list that is automatically created provide the same set of features. The CA Clarity PPM List Web Part acts as a container for the list and provides the features that are available in SharePoint lists. You cannot modify or delete list items or add and delete columns on CA Clarity PPM List Web Parts or their underlying lists, thus ensuring that data is not lost when you synchronize the list with CA Clarity PPM.

When you reconfigure the CA Clarity PPM List Web Part to access a different CA Clarity PPM provider, a new list is not created. When you reconfigure a CA Clarity PPM List Web Part to display information from a different data provider or a data provider on a different CA Clarity PPM server, the associated list is updated with information from the new data provider.

Note: You can use the list that is associated with a CA Clarity PPM Web Part even after you delete the List Web Part; the associated list is not deleted from the site. However, when you delete the List Web Part, the synchronize functionality no longer works on the list.

Configure CA Clarity PPM List Web Parts

Configure the CA Clarity PPM List Web Part to display the list of items that you want to view. You configure the CA Clarity PPM List Web Part to access CA Clarity PPM project data by selecting the desired CA Clarity PPM data provider.

You can configure a CA Clarity PPM List Web Part by using its tool pane. The CA Clarity PPM Data Provider list in the tool pane displays all the data providers that are available for the configured binding parameters.

Follow these steps:

  1. Open the Web Part menu of the CA Clarity PPM List Web Part, and from Edit, click Modify Shared Web Part.

    The tool pane appears.

  2. In the CA Clarity PPM section of the tool pane, from the CA Clarity PPM Data Provider list, select the data provider.

    The page refreshes.

  3. (Optional) To configure this Web Part as a list that can be integrated with Microsoft Outlook, do the following:
    Task List

    Select the Task List check box.

    Start Date Attribute

    Select the start date attribute.

    Required: No

    Due Date Attribute

    Select the finish date attribute.

    Required: No

    Priority Attribute

    Select the attribute that indicates the priority.

    Required: No

    % Complete Attribute

    Select the attribute that indicates the percentage of completion.

    Required: No

    If you do not select the Task List check box, the Actions menu does not display the Connect to Outlook command, which enables the integration of the list with Microsoft Outlook. Selecting an attribute from the Start Date Attribute, Due Date Attribute, Priority Attribute, and % Complete Attribute lists ensures that these attributes are included in the list in Microsoft Outlook.

  4. (Optional) Customize the Web Part by providing details in the Appearance, Layout, and Advanced sections.

    Note: For more information about customizing the Web Part, see the Microsoft Windows SharePoint documentation.

  5. Click OK.

    The CA Clarity PPM List Web Part displays a list of items retrieved from the data provider.

If you do not select the Task List check box, you can reconfigure the CA Clarity List Web Part to integrate the list with Microsoft Outlook. To integrate the list with Outlook, access the tool pane of the CA Clarity List Web Part and select the Task List check box. Optionally, select the start date, due date, priority, and percentage complete attributes to include the fields in Microsoft Outlook.

Modify Columns in CA Clarity PPM List Web Parts

CA Clarity PPM Web Parts display certain columns by default. However, additional columns are retrieved from CA Clarity PPM but are not displayed by default. You can change the columns that are displayed.

You can:

Follow these steps:

  1. Open the View menu from Web Part.
  2. Click Modify this View.
  3. In the Columns section, do the following:
    Column Name

    Select the check boxes against the columns for the Web Part to display.

    (Optional) Position from Left

    Select the positions for displaying the columns.

  4. Click OK.

    The selected columns are displayed in CA Clarity PPM List Web Part.

Synchronize CA Clarity PPM List Web Parts with CA Clarity PPM

The data you retrieve from a data provider may undergo periodic changes in CA Clarity PPM. Some of the existing items may be deleted or modified in CA Clarity PPM, and new items may be added. If you want to update the list in the CA Clarity PPM Web Part to reflect the changes, synchronize the list in the Web Part with CA Clarity PPM.

Follow this step:

In the menu bar of the Web Part, Click Synchronize with Clarity. The list in the CA Clarity PPM List Web Part is updated with the latest information in CA Clarity PPM.

Note: Without the Design or Full Control permission, the list appears to synchronize with CA Clarity PPM because the Web page refreshes. However, the list continues to display the information that was retrieved when it was last synchronized by a user having Design or Full Control permissions.

About CA Clarity PPM Chart Web Parts

The CA Clarity PPM Chart Web Part is based on standard Microsoft Office Excel charting features. You can use CA Clarity PPM Chart Web Parts to view pictorial representations of data from a CA Clarity PPM data provider. You can refresh charts displayed in CA Clarity PPM Chart Web Parts periodically to display charts based on the updated data in CA Clarity PPM.

A CA Clarity PPM Chart Web Part can represent CA Clarity PPM data that are of the following data types:

Note: If two or more records retrieved by the project data provider have the same category attribute values, only the first instance is plotted on the chart. Therefore, ensure that the CA Clarity PPM project data provider for retrieving data for display in CA Clarity PPM Chart Web Parts contains unique values for the attributes to plot on the horizontal (category) axis. This frequently means a Studio query that does aggregation by the selected category attribute.

CA Clarity PPM Chart Web Part Compatibility with Microsoft SharePoint Features

CA Clarity PPM Chart Web Parts are restricted to displaying charts based on CA Clarity PPM project data. Therefore, CA Clarity PPM Chart Web Parts do not have the standard Web Part menu. You cannot use SharePoint features with this Web Part. You can, however, customize the appearance and layout of the Web Part by using the tool pane that is associated with the CA Clarity PPM Chart Web Part.

How to Set Up CA Clarity PPM Web Parts To Connect CA Clarity PPM with Microsoft SharePoint

Use the following process to set up CA Clarity PPM Web Parts to connect CA Clarity PPM with Microsoft SharePoint:

Use the following process to manage CA Clarity PPM Project Information in Microsoft SharePoint Sites:

Supported Chart Types

You can configure CA Clarity PPM Chart Web Parts to display various types of charts, such as area charts, bar charts, line charts, and pie charts.

Note: Some chart types, such as pie charts and doughnut charts, do not support multiple series. Therefore, select only one series attribute for such chart types. Also, the colors used in the charts are system-generated. So, you cannot specify the colors to represent the elements of the chart with.

Configure CA Clarity PPM Chart Web Parts

After adding a CA Clarity PPM Chart Web Part to a CA Clarity PPM project site, configure it to create the chart to view. You configure a CA Clarity PPM Chart Web Part by using the tool pane associated with the Web Part. The CA Clarity PPM Data Provider list in the tool pane displays all the available data providers.

The CA Clarity PPM Chart Web Part also displays a legend that identifies each series in the chart.

Note: If two or more records with the same category value are retrieved for the selected data provider, only the first is included in the chart. For example, if you select Task as the data provider for the chart and the task name as the category attribute. If the same task name appears for multiple tasks, only the first task is included in the chart. Therefore, ensure that the selected attributes display as categories on the chart have unique values.

Follow these steps:

  1. In the CA Clarity PPM Chart Web Part, click Edit, and then click Modify Shared Web Part.

    The tool pane appears.

  2. In the CA Clarity PPM section of the tool pane, do the following:
    CA Clarity PPM Data Provider

    Specifies the data provider. After you select a data provider from the CA Clarity PPM Data Provider list, the Category Attribute and Series Attributes fields are automatically populated with the attributes contained in the data provider.

    Chart Type

    Select the type of chart.

    Chart Title

    Enter a title for the chart.

    Category Attribute

    Select the attribute for plotting on the category axis.

    Series Attributes

    Select the attributes for plotting on the series axis. You can select multiple series attributes. However, certain chart types, such as pie charts and doughnut charts, do not support multiple series attributes.

    Value (Y) Axis Label

    Enter a name for the set of series attributes selected.

  3. (Optional) Customize the Web Part by providing details in the Appearance, Layout, and Advanced sections.

    Note: For more information about customizing the Web Part, see the Microsoft Windows SharePoint documentation.

  4. Click OK.

    The CA Clarity PPM Chart Web Part displays the chart.

Refresh Charts Displayed in CA Clarity PPM Chart Web Parts with CA Clarity PPM

The chart displayed in a CA Clarity PPM Chart Web Part is based on values of attributes that can change in CA Clarity PPM. Refresh the chart periodically so that the chart is based on the latest values in the CA Clarity PPM data provider. When you refresh the chart, the chart is re-created based on the new values in CA Clarity PPM.

Follow this step:

Click the Refresh Chart button that is provided above the chart area in the CA Clarity PPM Chart Web Part. The chart is refreshed. If the category and series attribute values have changed in CA Clarity PPM, they are plotted using the new values in the CA Clarity PPM data provider.

Note: Without the Design or Full Control permission, the chart appears to refresh because the Web Page refreshes. However, the chart continues to display the graph as last refreshed by a user having Design or Full Control permissions.