Previous Topic: CA Technologies Clarity Service Connect OverviewNext Topic: Start the Services Using Apache Tomcat (Single Server)


Setup and Installation

This section contains the following topics:

How to Set up the CA Technologies Clarity Service Connect Add-in

How to Set up Remedy for Connection to CA Clarity PPM

Install the CA Technologies Clarity Service Connect Add-in

The Default Remedy Clarity Integration Process

How to Set up the CA Technologies Clarity Service Connect Add-in

The following steps describe the overall process of setting up the CA Technologies Clarity Service Connect add-in:

  1. Set up Remedy.
  2. Install the add-in.
  3. Configure the process.
  4. Run the process or schedule the process to run on a schedule.

How to Set up Remedy for Connection to CA Clarity PPM

You must install Remedy on top of the basic BMC Remedy Action Request system. CA Clarity PPM connects with Remedy using Web Services, which means that you must also install the Remedy Mid-Tier application.

See the Remedy documentation for more information on BMC Remedy Action Request and the Mid-Tier application.

Use the following process to set up Remedy for connection to CA Clarity PPM:

  1. Create a new Remedy Web Service query operation.
  2. Define the required query filter criteria.
  3. Select the data fields returned by Remedy Web Service.

Create New Remedy Web Service Query Operations

Remedy includes some default Web Services. However, these are basic services meant to be configured to include the filter criteria and data required by the client application.

For example, CA Clarity PPM must filter using Remedy's Status field, which is not possible using stock Remedy Web Services. To accomplish the task of filtering, create a new Web Service query operation that can take a generic filter argument, and output all the fields required by CA Clarity PPM.

Follow these steps:

  1. Open the Remedy Administrator.
  2. In the object tree, click the Web Services node.
  3. Double-click HelpDesk_Query_Service.
  4. Under Operations, click New.
  5. Complete the following fields:
    Name

    Enter GetFilteredList.

    Type

    Select Get.

  6. When prompted to map object changes, select Replace current mappings.

Define the Web Service Query Filter Criteria

Follow these steps:

  1. Open the Remedy Administrator.
  2. Click Input Mapping.
  3. On the right panel, click on the root node, select New, and then Element.

    A new node called element appears.

  4. Click the element node.

    The node opens.

  5. In the Name field, enter Filter.
  6. Look in the Object Properties window to make sure that the data type for this element is string (the default value).
  7. Right-click the Case_ID element and select Cut to remove it.
  8. Click OK.

    The input mapping window opens.

  9. On the Operations List, define the following field:
    Qualification

    Enter XPATH(/ROOT/Filter), where XPATH(/ROOT/Filter) is a fully dynamic qualification filter that allows the service client (CA Clarity PPM) to filter on any field.

Select the Data Fields Returned by Remedy Web Service

Follow these steps:

  1. In the Remedy Administrator, click Output Mapping.
  2. On the right panel, under ROOT, create the following elements:
    Estimated_Total_Time

    Type: int

    Mapped to (left panel): Estimated Total Time

  3. Continue to create the following additional elements:
    Total_Time_Spent

    The element on right panel.

    Type: int

    Mapped to (left panel): Total Time Spent

    Resolved_Time

    The element on right panel.

    Type: dateTime

    Mapped to (left panel): Resolved Time

    Request_Impact

    The element on right panel.

    Type: string

    Mapped to (left panel): Request Impact

    Modified_Time

    The element on right panel.

    Type: dateTime

    Mapped to (left panel): Modified Time

  4. Click Map.

    The elements are linked.

  5. Click OK.
  6. Save the changes.

    The Web Service is now ready for CA Clarity PPM.

rem:timestamp - Generating Remedy Web Service Time Values

Remedy Web Service takes some data in its own format; use the rem:timestamp tag to simplify date conversions.

mode

Required. This can be "DATE_TO_LONG" or "FORMAT_TIMEZONE".

In Remedy, when a date, including time, is to be used as a query condition, instead of: date > to_date("2005-01-2 12:23:12")

Remedy uses: date > 10234420304

This provides the number of seconds since midnight of Jan. 1st, 1970. Use mode="DATE_TO_LONG" to get a number that is based upon a date.

In Remedy, when a date is obtained from a web service, it exists in the following format: 2005-04-01T13:44:12-08:00, where "-08:00" at the end specifies the time zone and can only be understood by SimpleDateFormat (which is used in the <gel:parseDate> tag). Use mode=" FORMAT_TIMEZONE" to generate a date string that is understandable by <gel:parseDate>.

Type: String

var

Required. The variable referred by this name contains the result:

Type: String

value

Required. The value to be converted:

Type: Expression

Example

<rem:timestamp var="LastRemedyIncidentTime1" value="${LastRemedyIncidentTime}" mode="FORMAT_TIMEZONE"/>
      <gel:parseDate dateVar="RDate" stringVar="LastRemedyIncidentTime1" format="yyyy-MM-dd'T'HH:mm:ssZ"/>
      <rem:timestamp var="RemedyTime" value="${RDate}" mode="DATE_TO_LONG"/>

Install the CA Technologies Clarity Service Connect Add-in

Prerequisites

For instructions on how to install an add-in, see the Installation Guide.

Installation Prerequisites

Before installing the add-in, read the following requirements for new and existing customers:

See the Installation Guide for more information.

How to Install Add-Ins

This section describes the steps required to install add-ins from a .jar file so that the content is available to users. Complete the steps on your CA Clarity application server. Before installing an add-in, verify that the relevant CA Clarity PPM version is installed.

Important! If you upgrade from a previous version of the add-in, verify the compatibility chart in the add-in release notes to see if an upgrade for the add-in is required, or is optional.

The following process details how to install add-ins on your CA Clarity PPM server:

  1. Download the .iso image file.
  2. Extract the .jar file.
  3. Stop the services.
  4. Install the add-in.
  5. Start the services.
  6. Apply the add-in.

    Perform the step if the add-in is installed, or CA Clarity PPM view is modified by installing the add-in.

Download the .iso Image File

All add-ins are .iso image files. The .iso image file includes a .jar file. The .jar file contains the files to install the add-in. The installer updates the existing CA Clarity PPM installation with the newly downloaded files.

To download the .iso image file, go to support.ca.com and download the .iso image to your computer, or an accessible network location.

More information:

Start the Services Using Apache Tomcat (Single Server)

Mount .iso Image Files Using Unix

On UNIX platforms, use the .iso image file directly through the DVD emulation provided with some of the operating environment DVD device drivers. For Linux systems, you can use the .iso image by mounting it on the .iso file system driver.

To mount the .iso image file using Unix, open a command prompt and issue a command similar to the following:

mount -t .iso9660 -o ro,loop,dev filename.iso /mnt/CAcd

The command mounts the .iso image file (filename.iso) at the /mnt/CAcd mount point. Hence, the DVD contents are accessible through the /mnt/CAcd directory.

Write .iso Image Files to DVDs

The .iso image files are DVD images containing exact binary copies of the original DVDs. Depending on the operating environment, you can use the files to create product DVDs, or you can use them in their original format.

A DVD writer and mastering software are required to recreate product DVDs. Most DVD authoring applications accept a preformatted .iso image file and write the contents of the ISO image to a DVD. This step generates an exact copy of the product DVD.

See the documentation on your DVD writer for more information about how to write .iso image files to DVDs.

Note: Neither Windows nor WinZip recognizes the .iso file format. To access the installation files in Windows, create a DVD with the .iso image file using a DVD Writer. Or, use a third-party software program like IsoBuster or Undisker as an .iso image file extractor. If you prefer not to create a DVD, use an .iso extractor program to extract .iso image files to a local file system.

Extract the .jar File

Once you access the .iso image file, extract the .jar file to a temporary directory location on the CA Clarity application server to complete the installation process.

The .jar file includes the following files:

install.sh

The UNIX installation script.

install.bat

The Windows installation script.

install.xml

The Ant installation script.

package

The directory of updated files.

tools

The directory of supporting files.

Follow these steps:

  1. Open a command prompt, and issue the following command:
    jar -xvf <filename>
    

    The command extracts the contents of the .jar file to the same location where the .jar file resides.

  2. For a UNIX environment, issue the following command:
    chmod +x install.sh
    

    This grants execution privileges for the install script.

Stop the Services

Before applying the add-ins, stop the CA Clarity Application (app) and CA Clarity Background (bg) services. Restart them from Clarity System Administration after having applied the add-in to CA Clarity PPM.

The following sections explain how to stop the services in different server configurations.

Important! If deployed on the server, do not stop the Clarity System Administration (nsa), the Database (db), the Beacon, and the Reports (reports) services.

Stop Services Using Apache Tomcat

Do the following to stop the CA Clarity Application (app) service and CA Clarity Background (bg) services that use Apache Tomcat as your CA Clarity application server.

Follow these steps:

  1. Log in to CA Clarity System Administration.
  2. Open Home, and click All Services.
  3. Select the CA Clarity Application (app) and the CA Clarity Background (bg) service check boxes.
  4. Click Stop.

Stop Services Using Oracle WebLogic/IBM WebSphere

Do the following to stop the application and background services in a configuration that uses the Oracle WebLogic, or IBM WebSphere as your CA Clarity application server.

Follow these steps:

  1. Log in to CA Clarity System Administration.
  2. Open Home, and click All Services.
  3. Select the CA Clarity Application (app), and the CA Clarity Background (bg) check boxes.
  4. Click Stop.
  5. Stop CA Clarity System Administration and applications using the application server administration console.

    For more information, see the J2EE vendor documentation.

Install the Add-In

The following procedure installs the updates to objects, reports, and the database.

Important! Back up your CA Clarity PPM installation before installing this add-in so that you can restore the application to the prior version, if necessary. When you install an add-in, you can overwrite your customized views for out-of-the-box CA Clarity PPM objects, such as projects. If your organization has customized views, consider installing in a test environment before installing this add-in into your production environment. Once you have installed the add-in, you cannot uninstall it.

Follow these steps:

  1. Open a Command Prompt window at the directory location where you extracted the .jar files, and issue the following command:
    install
    
  2. Press Enter.

    The installation process begins.

  3. Follow the on-screen directions to complete the add-in installation.

Start the Services

Stop the CA Clarity Application (app) and CA Clarity Background (bg) services before applying the add-in. Restart them after applying the add-in. Use CA Clarity System Administration to stop the application.

The following sections explain how to start the services in different server configurations.

More information:

Start the Services Using Apache Tomcat (Single Server)

Start the Services Using Apache Tomcat (Multiple Servers)

Start the Services Using Oracle WebLogic/IBM WebSphere