Previous Topic: CA Clarity PPM Connector Configuration

Next Topic: Configure Multiple CA Clarity PPM Connector Instances on One Server

Configure the CA Clarity PPM Connector

After installing the CA Clarity PPM connector, you can change the properties you defined during installation and edit other properties. Configure the CA Clarity PPM connector to refine the behavior or adjust to changes in the integrated product. Use this procedure to configure the parameters specific to CA Clarity PPM.

Connector controls are common properties that control how the connector operates.

See the CA Spectrum SA Connector Guide or click the Help button to access the Online Help for more information about the function of each connector control.

Important! Do not perform rapid start and stop operations on the CA Clarity PPM connector. Each stop and start sends the corresponding command to the CA Clarity PPM connector. Rapid start and stop operations can cause these commands to queue on the CA Clarity PPM connector and cause the connector to start and stop repeatedly until all commands in the queue are processed.

Follow these steps:

  1. Open the CA Spectrum SA Administration interface, and click Administration.

    The administration page appears.

    See the Administration Guide for more information.

  2. Expand Connector Configuration and the connector server name, and click the entry for the CA Clarity PPM connector.

    A page opens for editing the CA Clarity PPM connector.

  3. (Optional) Change any properties in the Connector Controls table, and click Save.

    The control changes are saved.

  4. In the Connection Details table, change any of the following properties:
    RetryCount

    Specifies the number of times the CA Clarity PPM connector tries to reconnect to CA Clarity PPM when the connection fails.

    Default: 20

    RetryInterval

    Specifies the interval (in seconds) between connection attempts when connection to CA Clarity PPM is lost.

    Example: You set the RetryInterval to 30 and the RetryCount to 20. When the connection to CA Clarity PPM is dropped, the CA Clarity PPM connector attempts to reconnect. If the reconnection attempt fails, the CA Clarity PPM connector waits 30 seconds before attempting another connection. The CA Clarity PPM connector repeats the process of attempting to reconnect until the connection is reestablished or until 20 unsuccessful attempts have been made. Then the process stops.

    Default: 30

    HistoryFolder

    Specifies the location of the folder where the CI synchronization change history is stored.

    See the "Change History Folder" section for more information.

    Default: <install folder>/clarity

    MappingConfigFile

    Specifies the location of the mapping configuration file that defines the workflow required to transform a CA Clarity PPM object to a USM CI and back to a CA Clarity PPM object.

    See the "Mapping Configuration Files" section for more information.

    Default: clarity/clarity_mappings.xml

    AlertConfigFile

    Specifies the location of the mapping configuration file that specifies the alerts that the CA Clarity PPM connector supports.

    See the "Alerts" section for more information.

    Default: clarity/clarity_alerts.xml

    TemplateConfigFile

    Specifies the location of the mapping configuration file that contains the scripts that are used to drive the XOG input/output and transformation to key/value pairs.

    See the "Mapping Configuration Files" section for more information.

    Default: clarity/clarity_templates.xml

    host

    Specifies the name of the server running CA Clarity PPM.

    Default: The value entered during installation.

    hostPort

    Specifies the port number that CA Clarity PPM uses for its standard web interface.

    See the Administration Guide for more information.

    Default: The value entered during installation.

    clientPort

    Specifies the CA Clarity PPM clientPort property used (with host) to identify a unique CA Clarity PPM instance.

    See the Administration Guide for more information.

    Default: The value entered during installation.

    username

    Defines the name of the dedicated CA Clarity PPM user for the purpose of reading and writing data to and from CA Clarity PPM.

    password

    Defines the password for the dedicated CA Clarity PPM user. This property is encrypted in the CA Clarity PPM connector configuration file.

    Default: Encrypted version of the value entered during installation.

    PollInterval

    Specifies the amount of time (in seconds) that the CA Clarity PPM connector pauses between synchronization actions. Set the value to 0 to disable data collection.

    See the "CI Synchronization" section for more information.

    Default: 60

    TemplateFolder

    Specifies the folder containing mapping resources for the CA Clarity PPM connector. The TemplateFolder can be a fully-qualified path or one relative to the standard CA Spectrum SA resource directory.

    Default: clarity/xogtemplates

    Important! Do not change any other properties in the Connection Details table.

  5. Save your changes.

    The property changes are saved.

  6. (Optional) If you changed the values of the host or port properties in the Connection Details table, then change the values in the host and port properties in the Launch in Context Details table.

    Important! Do not change any other properties in the Launch in Context Details tables.

  7. Click Stop.

    The connector status changes to "Offline".

  8. Click Start.

    The connector status changes to "Online". The connector restarts. Depending on the type of connector, a delay can occur while the connector status displays "Online".