Apply the Add-In

Installing and Configuring the Connector with CA Clarity PPM › How CA Clarity PPM is Set Up › CA Clarity PPM Setup Procedures › Setup for CA Clarity PPM 13.0, 12.0, or CA Clarity 8.1 › Apply the Add-In

Apply the Add-In

You can review changes to installed add-in items and review new add-in items using the Add-In Details page in Studio. If you have configured views when you install the add-in, these configurations remain and are not overwritten. You can decide which views to apply. If you are upgrading to the current add-in version, use this page to choose which new or modified items you want to apply and apply them. Applying a view overwrites the configuration of the view.

This page lists all of the items that are included with the add-in. The following columns display on this page:

Status

Indicates if the add-in item is applied or not in CA Clarity PPM.

Values:

Not Installed. New items that are new to this add-in version or that you did not apply from a previous add-in version.
Upgrade Ready. Modified items that you applied from a previous add-in version and then configured. An update to the item is included in the current add-in version.
Important! Consider the configurations you have made to items before applying them. Applying modified items overwrites your configurations.
Installed. Items that are installed.

Type

Indicates the item type.

Values: Object, Lookup, Tab, Query, Portlet, Page, Custom View, Group, Menu, Project, Process, Role, and Report/Job

ID

Displays the add-in item's code, which becomes the ID of the applied add-in item.

To apply add-in items

Log in to CA Clarity PPM, and open the Administration Tool.
The Administration Home page appears.
Select Add-Ins from the CA Clarity Studio menu.
The Add-Ins page appears.
Click the name of the add-in from which you want to apply items.
The Add-In Details page appears.
Review the items in the list and select only those you want to apply.
Note: By default, when you upgrade to the current add-in version, only the items that are new or modified are selected.
(Upgrade Only) For all active process instances that have a status of "Upgrade Ready", cancel and delete the process instance, and put the process definition in Draft mode.
Note: See the CA Clarity PPM Administration Guide for more information on how to manage processes and process instances.
Click Apply.
Note: If a selected item has dependencies on other items, these dependencies are also updated.

A list of updated items displays in the Confirm Add-In Update or Install page.
Click Yes to update or install the items.
If a user has previously changed an item listed on the Confirm Add-In Update or Install page, you must publish the item before the update is displayed for users.

Note: See the Studio Developer's Guide for more information on how to publish configured items, such as portlets, pages, and views.

Setup for CA Clarity 8.0 and 7.5.3

For these releases, use the Niku System Administration (NSA) application to install the Connector: Unicenter Service Desk/Harvest add-in. The Clarity application is used to set administrative configurations, such as Clarity resource names and IDs.

Note: If you are installing the add-in for the first time on CA Clarity 7.5.3, first install 7.5.3, and then apply the appropriate fix pack (FP01 or higher). The fix pack installation instructions are included in the fix pack‘s readme file.

If you deployed the add-in prior to applying the 7.5.3_FP01 or higher fix pack, then you will need to re-install the add-in.

Step 1: Log In to CA Clarity System Administration

You must log in to NSA to deploy the Connector: Unicenter Service Desk/Harvest add-in.

To log in to NSA

Enter the URL for NSA in a web browser.
Enter your administrator password.
Click Login.
The Overview page appears.

Step 2: Install the Add-In

You must stop the Niku Application (app) service prior to deploying the add-in, and re-start the service after the add-in is deployed. Do this from NSA.

To install the add-in

Log in to NSA and stop the Niku Application (app) service:
1. Click All Services from the Overview menu.
  The All Services page appears.
2. Next to Niku Application, select the box for this service type and click Stop.
Install the Connector: Unicenter Service Desk/Harvest add-in from NSA:
1. Select Install and Upgrade from the Installation menu.
  The Install and Upgrade: Pre-Upgrade page appears.
2. Select Add-Ins under Installation Tasks from the content menu.
  The Install: Add-Ins page appears.
3. Complete the Connector: Unicenter Service Desk/Harvest field.
  By default, this add-in check box is cleared. Select the check box.
4. Click Install.
Start the Niku Application service:
1. Select All Services from the Home menu.
  The All Services page appears.
2. Select the check box for this service type.
3. Click Start.

How to Configure the Connector for CA Clarity PPM

The following steps show you how to configure the connector for CA Clarity PPM. You will use the Administration Tool to configure the connector in CA Clarity PPM, such as resource names and IDs.

Step 1: Log In to CA Clarity PPM as the CA Clarity PPM Administrator

You must log in to CA Clarity PPM as the CA Clarity PPM administrator. This resource has the access rights to the Administration Tool, which includes the rights to install and configure the connector.

To log in to CA Clarity PPM as the CA Clarity PPM administrator

Enter the URL for CA Clarity PPM in a web browser.
Enter your CA Clarity PPM administrator username and password.
Open the Administration Tool.
The Administration Home page appears.

Step 2: Change the password for the CAIAdmin User

After you have installed the add-in from CA Clarity System Administration, you must change the CAIAdmin user password. The CAIAdmin user is the CA Clarity PPM resource used by the CAI processes included with the Connector: Unicenter Service Desk/Harvest add-in, it is not the CA Clarity PPM administrator user.

Note: If you decide to change the password to something other than caiadmin, make sure you use the changed password throughout the connector's configuration and setup.

To change the password for the CA Clarity PPM administrator

Open the Administration Tool.
The Administration Home page appears.
Select Resources from the Organization and Access menu.
The Resources page appears.
Complete the following fields in the Resource Filter, and click Filter:

First Name

Enter cai.
Click the name of the CAIAdmin user.
The Resource: Properties page for that resource appears.
Complete the following fields:

Password

caiadmin.

Confirm Password

caiadmin.

Force Password

Verify that this check box is cleared.
Click Save and Exit.
The Resources page appears.

Step 3: Grant Harvest Project Access Rights to CA Clarity PPM Resources

If you are integrating CA Clarity PPM with AllFusion Harvest Change Manager, you must grant Harvest Project global access rights to each CA Clarity PPM resource that will be creating Harvest Projects in CA Clarity PPM. There are four global access rights that you must grant to CA Clarity PPM resources for the resource to view the Harvest Project custom object in CA Clarity PPM, and to create Harvest Projects in CA Clarity PPM.

Note: If the CA Clarity PPM user is not associated to a CA Clarity PPM resource, first create the resource.

Note: Contact your CA Clarity PPM administrator or see the Administration Guide for more information..

To grant Harvest Project global access rights to resources

Open the Administration Tool.
Click Resources from the Organization and Access menu.
The Resources page appears.
Click the name of the resource to which you want to grant Harvest Project global access rights.
The Resource: Properties page appears.
From the content menu, under Resource Access Rights, select Global.
The Resource: Global Access Rights page appears.
Click Add.
The Select Access Rights page appears.
Filter the global access rights:
- Enter harvest at Access Right in the Access Right Filter section.
- Click Filter.
Click the Select All icon to select all four access rights in the list, and click Add.
The Resource: Global Access Rights page appears.
Click Exit.
The Resources page appears.

Step 4: Create Harvest Project in CA Clarity PPM

If you are integrating CA Clarity PPM with AllFusion Harvest Change Manager and Unicenter Service Desk, you must do the following:

Create a Harvest Project in CA Clarity PPM for each Harvest project in Harvest before integrating. The Harvest Project in CA Clarity PPM provides the mapping between CA Clarity PPM and Harvest.
Create a Harvest Project in CA Clarity PPM for each Unicenter Service Desk project CI that has a Harvest project defined.
Note: If Service Desk was not installed in the ITIL mode, Service Desk users will see assets instead of project CIs.
After Harvest administrators add projects to AllFusion Harvest Change Manager, you will need to create related/corresponding Harvest Project in CA Clarity PPM.
After creating the Harvest project in CA Clarity PPM, define the Harvest Project field in the Service Desk project CI.

To create the Harvest Project in CA Clarity PPM

Important! Before creating the Harvest Project in CA Clarity PPM, make sure the Harvest project exists in Harvest. Gather information on the Harvest project-such as the project name, ID, and description-from the Harvest administrator.

Open CA Clarity PPM.
Click Harvest Project List from the Custom Objects menu.
Note: To see the Custom Objects menu, it may be necessary for you to use the scroll bar to navigate to this area of the main menu.
Click New.
The Create Harvest Project page appears.
Complete the following fields:

Name

Enter the name of the Harvest project. This value must be the same as the name of the associated project in Harvest.

Note: This value is case-sensitive when matched with the Service Desk project CI.

ID

Enter the name of the Harvest project in Harvest. This value must be the same as the name of the associated project in Harvest.

Note: This value is case-sensitive when matched with the Service Desk project CI.

Description

Enter the description for the Harvest Project in CA Clarity PPM.
Click Submit.
The Harvest Project List page appears listing the newly created Harvest project.

Step 5: Edit the Grid Execution Language (GEL) Script Parameters for the Processes

Several CA Clarity PPM processes are included with the Connector: Unicenter Service Desk/Harvest add-in. These CAI processes are the connection processes included with the connector.

Note: Contact your CA Clarity PPM administrator or see the Administration Guide for more information.

You must edit the GEL script parameters for each of the process steps to set the values for user names, passwords, and URLs. Edit the process step scripts, and not the custom script parameters listed on the Custom Script Parameters page. The Custom Script page contains a text box where you can configure the parameters.

Note: After editing the GEL scripts for each of the process steps, you must validate and activate the CAI processes before they can be used.

The Process Steps

The following table lists the process steps for the connector. You must configure the process steps based on the products you have installed for your integrated systems. Use the table to determine which process step you need to configure. After you have made the configurations, validate and activate the CAI process.

Note: You only need to activate the processes associated with the product(s) you have installed and connected.

Process	Step	Configure and Activate CA Clarity PPM - Service Desk only	Configure and Activate CA Clarity PPM - Harvest only	Configure and Activate all
CAI Harvest	Create	No	Yes	Yes
CAI Harvest Status	Update Status	No	Yes	Yes
CAI Project Post Create		Yes	No	Yes
CAI Project Update		Yes	No	Yes
CAI SDCO Task Update		Yes	No	Yes
CAI Service Desk Create		Yes	No	Yes
CAI Service Desk Task Create Post		Activate only	No	Activate only
CAI Harvest Status ED		No	No	No

To edit the process step GEL script parameter

Open the Administration Tool. This icon is at the top right on the Harvest Project List page.
The Administration Home page appears.
Select Processes from the Data Administration menu.
The Available Processes page appears.
Filter the list to view only the processes related to the connector, the CAI processes. At Process Name, enter cai, and click Filter.
Select the name of the process you want to edit from the list of processes. See the table preceding this procedure to determine which process to edit.
The Process Definition: Properties page appears.
Select Steps from the content menu.
The Process Definition: Steps page appears.
Click the name of the step you want to edit. See the table to determine which step to edit.
Click Edit Custom Script in the Actions section.
The Custom Script page appears. Following is an example of the custom scripts:
Replace the default value with the attributes relevant to your integration in the Custom Script text box. See the following tables for variable changes for the process steps.
Click Save.
Click Validate to verify that the process contains no errors, then click Cancel.
Click Cancel to return to the Processes list page.

The following table lists the variables, their default settings and descriptions for the CAI Harvest Feature Create process for Create Harvest Feature step:

Variable Name	Default Setting	Description/Action
pbroker	harvest	Enter the name of the Harvest broker.
pusername	harvest	Enter the name of the Harvest user.
ppassword	harvest	Enter the password of the Harvest user.
pcreatePkgProc	Create RFC	Enter the name of the Harvest process associated to the Service Desk Clarity Connector lifecycle template. Note: The default process is Create RFC. If the name of this process is changed in Harvest, this parameter must be changed to match that new name.
pdevState	Plan	Enter the first default state of the Harvest package. It should be Plan.
clarity_dbId	niku	Enter the CA Clarity PPM data source.
SDURL	http://localhost:8080/axis/services/USD_R11_WebService	Enter your Service Desk server name and port.
SDUserName	ServiceDesk	Enter the name of the Service Desk user. CA recommends entering a Service Desk user other than ServiceDesk, as this user is typically the administrator.
SDPassword	ServiceDesk	Enter your Service Desk password.
locale	en	Enter the locale value of your Service Desk server.

The following table lists the variables and their default settings for CAI Harvest Status process for Update Status step:

Variable Name	Default Setting	Description/Action
clarityAdminId	caiadmin	Enter the username of the CAI administrator.
clarity_dbId	niku	Enter the CA Clarity PPM data source.
csvStates	Plan, Development, Test, Production	Enter all four states.
csvWeights	0.25, 0.5, 0.75, 1.0	Enter the values of the weights associated with the four Harvest lifecycle states that are included with CA Clarity PPM out-of-the-box. The weights you assign to each state are the weights used to calculate the Overall % Complete field.
dateFormat	yyy-MM-dd HH:mm:ss	Enter the format for the date and timestamp. It should be the default.
pbroker	harvest	Enter the name of the Harvest broker.
pusername	harvest	Enter the name of the Harvest user.
ppassword	harvest	Enter the password for the Harvest user.

The following table lists the variables and their default settings for the CAI Project Post Create process for Set SD CO InProgress Status step:

Variable Name	Default Setting	Description/Action
clarity_dbId	niku	Enter the CA Clarity PPM data source.
SDURL	http://localhost:8080/axis/services/USD_R11_WebService	Enter the URL-including the name and port-of the Service Desk server.
SDUserName	ServiceDesk	Enter the name of the Service Desk user. CA recommends entering a Service Desk user other than ServiceDesk, as this user is typically the administrator.
SDPassword	ServiceDesk	Enter the password for the Service Desk user.
locale	en	Enter the locale for the Service Desk server.

The following table lists the variables and their default settings for the CAI Project Update process for Send Project Complete Message step:

Variable Name	Default Setting	Description/Action
clarity_dbId	niku	Enter the CA Clarity PPM data source.
SDURL	http://localhost:8080/axis/services/USD_R11_WebService	Enter the URL-including the name and port-of the Service Desk server.
SDUserName	ServiceDesk	Enter the name of the Service Desk user. CA recommends entering a Service Desk user other than ServiceDesk, as this user is typically the administrator.
SDPassword	ServiceDesk	Enter the password for the Service Desk user.
locale	en	Enter the locale for the Service Desk server.

The following table lists the variables and their default settings for the CAI SDCO Task Update process for Update Service Desk step:

Variable Name	Default Setting	Description/Action
clarity_dbId	niku	Enter the CA Clarity PPM data source.
SDURL	http://localhost:8080/axis/services/USD_R11_WebService	Enter the URL-including the name and port-of the Service Desk server.
SDUserName	ServiceDesk	Enter the name of the Service Desk user. CA recommends entering a Service Desk user other than ServiceDesk, as this user is typically the administrator.
SDPassword	ServiceDesk	Enter the password for the Service Desk user.
Locale	en	Enter the locale for the Service Desk server.

The following table lists the variables and their default settings for the CAI Service Desk Create process for Create Object step:

Variable Name	Default Setting	Description/Action
XOGUsername	caiadmin	Enter the CAI administrator username, or the username of a user with XOG rights.
XOGPassword	caiadmin	Enter the CAI administrator password or the password of a user with XOG rights.
XOGURL	http://localhost:80	Enter the URL-including the name and port-of the CA Clarity PPM server.
clarity_dbId	niku	Enter the CA Clarity PPM data source.
clarity_sd_resource	caiadmin	Enter the ID of the Service Desk user who can create or update an idea, incident, or project.
SDURL	http://localhost:8080/axis/services/USD_R11_WebService	Enter the URL-including the name and port-of the Service Desk server.
sDUserName	ServiceDesk	Enter the name of the Service Desk user. CA recommends entering a Service Desk user other than ServiceDesk, as this user is typically the administrator.
sDPassword	ServiceDesk	Enter the password for the Service Desk server.
locale	en	Enter the locale for the Service Desk server.

Step 6: Validate and Activate the Processes

After you finish editing the GEL script parameters for the processes included with the Connector: Unicenter Service Desk/Harvest add-in, you must activate all of the processes for your integrated product except the CAI Harvest Status ED process, and not just the ones that you configured.

Before you can start a process, it must be valid and active.

Note: Contact your CA Clarity PPM administrator or see the Administration Guide for more information.

To validate a process

Select the name of the process you want to validate from the list of processes.
The Process Definition: Properties page appears.
Click Validation from the content menu.
The Process Definition: Validation page appears.
Select all of the steps and click Validate Process.
Note: If errors display, correct them and validate the process again.
Click Process Flow Diagram from the content menu to see a high-level view of the process.
Click Properties on the content menu.
The Process Definition: Properties page appears.

To activate a process

In the General section of the Process Definition: Properties page, at Mode, select Active.
Click Save and Exit.

Step 7: Schedule the CAI Harvest Status Process

After you set up CA Clarity PPM and Harvest, schedule the CAI Harvest Status process to run at regular intervals. You do this by running the Execute a Process job in CA Clarity PPM. While running the CAI Harvest status process, if the process fails with error message ‘Could not initialize class com.harvest.JCAHarvest’ do the following : Copy the jar file JHSDK.jar from the %HARVESTHOME% directory to %CLARITY-HOME%\lib folder and restart the CA Clarity Application (app) and CA Clarity Background (bg) service.

Note: Contact your CA Clarity PPM administrator or see the Administration Guide for more information.

How Service Desk is Set Up

This section describes the steps required to integrate CA Clarity PPM with Service Desk. You must complete these steps on your Service Desk application server.

In addition to completing the steps discussed in the following sections, the Service Desk Administrator must complete the steps discussed in the chapter "Installing and Configuring the Connector with Harvest." The steps described in the chapter are needed for integrating Service Desk with both CA Clarity PPM and Harvest.

Download the XOG Client from CA Clarity PPM

For Windows, UNIX servers, and LINUX servers, you must download the CA Technologies Clarity XML Open Gateway (XOG) client from CA Clarity PPM before setting XOG up on the Service Desk application server. You must download the XOG even when Service Desk is installed on the same server as CA Clarity PPM.

XOG is the CA Clarity PPM's Web service interface. Using XOG, you can read and write data objects from CA Clarity PPM. You can also use this interface to import data from external systems in to CA Clarity PPM.

Note: Contact your CA Clarity PPM administrator or see the Integration Guide for more information.

To download the XOG client from CA Clarity PPM

From the Service Desk application server, log in to CA Clarity PPM as the CA Clarity PPM administrator, and open the Administration Tool.
The Administration Home page appears.
Click Client Downloads from the General Settings menu.
The Client Downloads page appears.

Note: To see the General Settings section, you may need to use the scroll bar to navigate to this area.
Click the Download link next to Cross-platform ZIP.
The File Download window opens. The cross-platform ZIP file contains the XOG client.
Click Save.
The xogclient.zip file is saved to a local folder on the Service Desk application server.

How to Set Up XOG Client on Windows Service Desk Application Servers

The following steps show you how to set up the XML Open Gateway (XOG) when Service Desk is installed on a Windows application server.

Step 1: Extract the ZIP file

After you have downloaded the XOG client from CA Clarity PPM, extract the XOG files on the Windows Service Desk application server. To extract the ZIP file, open any file compression utility and extract the xogclient.zip file to a folder (for e.g., C:\CA Clarity PPM\XOG) on your Windows Service Desk application server.

Step 2: (CA Clarity PPM 12.0 or CA Clarity 8.1 only) Copy Files to the XOG Client

If you are setting up the add-in on CA Clarity PPM 12.0 or CA Clarity 8.1, copy the files shown in the following table to the XOG client. The <cai add-in> value in the table represents the location of the extracted Clarity Connector: Unicenter Service Desk/Harvest add-in files.

Extracted file	Copy to this location
<cai add-in>\package\xogclient\bin\*	<xogclient>\bin
<cai add-in>\package\xogclient\lib\cai-client.jar	<xogclient>\lib\

Step 3: Edit the test.properties file

Edit the test.properties file to specify the CA Clarity PPM server name, port number, CAIAdmin user, and password information. This information must be defined for each Service Desk Server that will be connecting to a CA Clarity PPM server instance. The XOG client uses this information to send the Service Desk change order information to the predefined CAIAdmin user on the CA Clarity PPM server.

To edit the test.properties file

Using a text editor, open the test.properties file located in the folder containing the extracted XOG files (for e.g., C:\Clarity\XOG \bin\test.properties file).
Change the following settings:
- Set the servername to the CA Clarity PPM server name.
- Set the port to the CA Clarity PPM server port number.
- Set the username to caiadmin.
- Set the password to caiadmin.
Note: If you changed the default caiadmin password to something other than caiadmin, set this value to the new password setting.
Save and close the test.properties file.

Step 4: Create the XOG_HOME System Environment Variable

Create a Windows operating system environment variable-XOG_HOME-and define it to point to the home directory of the XOG client. After you have added the new XOG_HOME system environment variable, you must reboot the Service Desk server for it to be registered to the new system environment variable.

To create the XOG_HOME system environment variable

Go to Settings, Control Panel, and System.
The System Properties window opens.
Select the Advanced tab and click Environment Variables.
The Environment Variables window appears.
Click New in the System Variables section of the window.
The New System Variable window appears.
Complete the following fields:
- Enter XOG_HOME as the Variable name.
- Enter the full path pointing the XOG folder (e.g. C:\Clarity\XOG) as the Variable value.
Click OK.
The new variable is saved.
Reboot the Service Desk server.

How to Set Up XOG Client on UNIX Service Desk Application Servers

The following steps show how to set up the XML Open Gateway (XOG) on UNIX, Sun Solaris, IBM AIX, and HPUX Service Desk application servers.

Step 1: Extract the ZIP file

Make sure you download the XOG client from CA Clarity PPM before extracting XOG on the UNIX Service Desk application server.

To extract the ZIP file

Login as the root user in UNIX.
Create /<path>/Clarity/XOG folder structure.
Copy xogclient.zip to /<path>/Clarity/XOG.
Unzip the contents to /<path>/Clarity/XOG.
Change directory to /<path>/Clarity/XOG/bin.
Grant read and execute rights for cai.sh file by executing the following at the command prompt:
```
chmod 555 cai.sh
```

Step 2: (CA Clarity PPM 12.0 or CA Clarity 8.1 only) Copy Files to the XOG Client

If you are setting up the add-in on CA Clarity PPM or CA Clarity 8.1, copy the files shown in the following table to the XOG client. The <cai add-in> value in the table represents the location of the extracted Clarity Connector: Unicenter Service Desk/Harvest add-in files.

Extracted file	Copy to this location
<cai add-in>/package/xogclient/bin/*	<xogclient>/bin
<cai add-in>/package/xogclient/lib/cai-client.jar	<xogclient>/lib/

Step 3: Edit the test.properties file

Edit the test.properties file to specify the CA Clarity PPM server name, port number, CAIAdmin user, and password information. This information needs to be defined for each Service Desk Server that will connect to a CA Clarity PPM server instance. The XOG client uses this information to send the Service Desk change order information to the predefined CAIAdmin user on the CA Clarity PPM server.

To edit the test.properties file

Log in as the root user in UNIX.
Open the test.properties file located in the folder containing the extracted XOG files.
- Navigate to the bin folder (for e.g., /<path>/Clarity/XOG/bin).
- Open test properties file (for e.g., /<path>/Clarity/XOG/bin/test.properties).
Change the following settings:
- Set the servername to the CA Clarity PPM server name.
- Set the port to the CA Clarity PPM server port number.
- Set the username to caiadmin.
- Set the password to caiadmin.
Note: If you changed the default caiadmin password to something other than caiadmin, set this value to your new password setting.
Save and close the test.properties file.

Step 4: Create the XOG_HOME System Environment Variable

Create a UNIX operating system environment variable-XOG_HOME-and define it to point to the home directory of the XOG client. After you have added the new XOG_HOME system environment variable, you must restart the Service Desk daemons for it to be registered to the Service Desk application.

To create the XOG_HOME System Environment Variable

Log in as the root user in UNIX.
As the root user, stop Service Desk daemons. At the command prompt, execute the following command:
```
pdm_halt
```
Identify the shell running on UNIX.
- For Solaris, edit the /etc/profile and the /etc/.login accordingly.
- For AIX or HPUX, edit the /etc/profile and the /etc/csh.login accordingly.
Add the following lines to the beginning of the identified file:
- For /etc/profile:
  XOG_HOME =/<path>/Clarity/XOG
  
  export XOG_HOME
  
  JAVA_HOME=<java installed path up to, but not including, /bin>
  
  export JAVA_HOME
- For /etc/.login or /etc/csh.login:
  setenv XOG_HOME <path>/Clarity/XOG
  
  setenv JAVA_HOME <java installed path up to, but not including, /bin>
If the Service Desk privileged user is running the C or Trusted C shells, add the following line to the /etc/.login:
```
setenv XOG_HOME <path>/Clarity/XOG
```
Exit your UNIX session.
Log in to UNIX again as the Service Desk privileged user.
Verify that the XOG_HOME environment variable and JAVA_HOME are set correctly. At the command prompt, execute the following command:
```
env
```
Restart the Service Desk daemons as the Service Desk privileged user. At the command prompt, execute the following command:
```
pdm_init
```

How to Set Up XOG Client on LINUX Service Desk Application Servers

The following steps show you how to set up XOG on LINUX Service Desk application servers. CA Clarity PPM XOG allows you to export data from CA Clarity PPM into external systems (in this case, Service Desk or Harvest) as well as import data from these external systems into CA Clarity PPM.

Step 1: Extract the ZIP file

Make sure you download the XML Open Gateway (XOG) client from CA Clarity PPM before extracting XOG on the LINUX Service Desk application server.

To extract the ZIP file

Log in as the root user in LINUX.
Create /<path>/Clarity/XOG folder structure.
Copy xogclient.zip to /<path>/Clarity/XOG.
Unzip the contents to /<path>/Clarity/XOG.
Change directory to /<path>/Clarity/XOG/bin.
Assign read and execute rights for cai.sh file by executing the following at the command prompt:
```
chmod 555 cai.sh
```

Step 2: (CA Clarity PPM 12.0 or CA Clarity 8.1 only) Copy Files to the XOG Client

Extracted file	Copy to this location
<cai add-in>/package/xogclient/bin/*	<xogclient>/bin
<cai add-in>/package/xogclient/lib/cai-client.jar	<xogclient>/lib/

Step 3: Edit the test.properties file

Edit the test.properties file to specify the CA Clarity PPM server name, port number, CAIAdmin user, and password information. This information needs to be defined for each Service Desk server that will be connecting to a CA Clarity PPM server instance. The XOG client uses this information to send the Service Desk change order information to the predefined CAIAdmin user on the CA Clarity PPM server.

To edit the test.properties file

Log in as the root user in LINUX.
Open the test.properties file located in the folder containing the extracted XOG files.
Navigate to the bin folder (for e.g., /<path>/Clarity/XOG/bin).
Open test properties file (for e.g., /<path>/Clarity/XOG/bin/test.properties).
Change the following settings:
- Set the servername to the CA Clarity PPM server name.
- Set the port to the CA Clarity PPM server port number.
- Set the username to caiadmin.
- Set the password to caiadmin.
Note: If you changed the default caiadmin password to something other than caiadmin, set this value to your new password setting.
Save and close the test.properties file.

Step 4: Create the XOG_HOME System Environment Variable

Create a LINUX operating system environment variable-XOG_HOME-and define it to point to the home directory of the XOG client. After you have added the new XOG_HOME system environment variable, you must restart the Service Desk daemons for it to be registered to the Service Desk application.

To create the XOG_HOME System Environment Variable

Log in as the root user in LINUX.
As the root user, stop Service Desk daemons. At the command prompt, execute the following command:
```
pdm_halt
```

Add the following lines to the beginning of /etc/profile:

XOG_HOME=/<path>/Clarity/XOG;
export XOG_HOME;
JAVA_HOME=<java installed path up to, but not including, /bin>;
export JAVA_HOME;

If the Service Desk privileged user is running the C or Trusted C shells, add the following line to the /etc/.login as well:
```
setenv XOG_HOME /<path>/Clarity/XOG
```
Exit your LINUX session.
Log in to LINUX again as the Service Desk privileged user.
Verify if XOG_HOME environment variable and JAVA_HOME are set correctly. At the command prompt, execute the following command:
```
env
```
As the Service Desk privileged user, restart the Service Desk daemons by executing the following at the command prompt:
```
pdm_init
```

How Harvest is Set Up

This section describes the steps required to integrate CA Clarity PPM with Harvest. You must have operating system user skills to install the Harvest server and client (Command Line Utilities). If necessary, consult your Harvest administrator for assistance.

Installation Prerequisites

Before completing the following procedures, make sure you have installed and configured Harvest r7.1 on the Harvest server as described in the AllFusion Harvest Change Manager r7.1 Installation Guide.

Important! Before completing the steps in this section, check the Harvest Readme (especially the Installation Considerations section) for any last-minute information that you may need to install and use Harvest successfully.

How to Install and Configure CA Clarity PPM on Windows

The following steps show you how to install and configure the connector when CA Clarity PPM is installed on a Windows server.

Step 1: Create a Harvest Project from Lifecycle Template

Create a Harvest project using the Service Desk Clarity Connector lifecycle template on the Harvest-Windows server. This project template provides the necessary forms and processes to integrate Harvest with Service Desk and CA Clarity PPM.

More information:

Installing and Configuring the Connector with Harvest

Step 2: Install the Harvest Client

If the CA Clarity PPM and Harvest are installed on different servers, install the Harvest client on the CA Clarity PPM server. The Harvest client software provides the required command line utilities used by the connector.

Note: For detailed information about installing the Harvest client on the CA Clarity PPM server that is running on Windows, see the Harvest 7.1 Installation Guide.

Step 3: Verify the PATH Environment Variable

Verify that the following entries are in the PATH environment variable:

Program Files\CA\AllFusion Harvest Change Manager
Program Files\CA\Cryptography
Program Files\CA\PEC\bin or Program Files\CA\SharedComponents\PEC\bin

Note: Some versions of Windows will truncate the PATH value if there are more than 1023 characters in the total length of the PATH variable. If your PATH is too long, you can either move the Harvest-related PATH entries to the front of the PATH or you can use 8.3 file naming notation to shorten the overall length of the PATH variable.

Note: If you modify Windows environment variables, you must reboot the server for the Service Desk service to recognize your changes.

Step 4: Extract the ZIP file and copy files to Forms folder

Extract the CMI_WINDOWS_B7.0.zip file on the CA Clarity PPM application server. Then, copy the following files from the extract folder to the %HARVESTHOME%\FORMS folder (for e.g., C:\Program Files\CA\AllFusion Harvest Change Manager\Forms) on your CA Clarity PPM application server:

SD-Clarity Connector.htm
SD-Clarity Connector.hfd
castylesr1.css
cssimages folder

Step 5: Make the SD-Clarity Connector form available to Harvest CM Workbench users

Harvest administrators must make the SD-Clarity Connector form files available to all Harvest CM Workbench users through email, a shared network location, or some other method. Users can then copy the files to their local folders.

To use the Service Desk Clarity Connector lifecycle template and the Service Desk Clarity Connector Request for Change form, Harvest CM Workbench users must copy the following files to the Harvest Forms folder on their local computer:

SD-Clarity Connector.htm
SD-Clarity Connector.hfd
castylesr1.css
cssimages folder

Note: By default, the Harvest Forms folder is C:\Program Files\CA\AllFusion Harvest Change Manager\Forms.

How to Install and Configure CA Clarity PPM on UNIX or LINUX

The following steps tell you how to install and configure the connector when CA Clarity PPM is on a UNIX or LINUX server.

Step 1: Create a Harvest Project from Lifecycle Template

Create a Harvest project using the Service Desk Clarity Connector lifecycle template. This project template provides the necessary forms and processes to integrate Harvest with Service Desk and CA Clarity PPM.

For more information on how to create a Harvest project in Harvest, see the chapter “Installing and Configuring the Connector with Harvest.” Select the section for your environment-specific installation and configuration procedures.

Step 2: Install the Harvest Client

If the CA Clarity PPM and Harvest are installed on different servers, install the Harvest command line utilities on the CA Clarity PPM server. The Harvest client software provides the required command line utilities used by the connector.

Note: For detailed information about installing the Harvest client on the CA Clarity PPM server that is running on UNIX or LINUX, see the Harvest 7.1 Installation Guide.

Step 3: Set the Harvest Environment Variables

The following environment variables must be set in the .profile file of the user who installed the CA Clarity PPM server:

#Set HARVESTHOME environment variable
#Add HARVESTHOME/bin to PATH
HARVESTHOME=/home/harvest/R71GA/harvest
PATH="${HARVESTHOME}"/bin:"${PATH}"

# Update CA shared component path for harvest
#library variable varies depending on OS. For example:LD_LIBRARY_PATH for Linux/Solaris, and LIBPATH for AIX.
LD_LIBRARY_PATH=$HARVESTHOME/lib:"${LD_LIBRARY_PATH}"

# Update CA shared component path for CAcrypto
LD_LIBRARY_PATH=/home/harvest/R71GA/CAcrypto:"${LD_LIBRARY_PATH}" 
CACRYPTINI=/home/harvest/R71GA/CAcrypto/cacrypt.ini

# Update CA shared component path for lic 
LD_LIBRARY_PATH=/opt/CA/CAlib:"${LD_LIBRARY_PATH}"

#Set RTHOME 
RTHOME=/home/harvest/R71GA/pec
. $RTHOME/bin/rtinit.sh

CLASSPATH=/home/harvest/R71GA/harvest/JHSDK/lib/jhsdk.jar:$CLASSPATH

export HARVESTHOME PATH LD_LIBRARY_PATH CACRYPTINI CLASSPATH

Note: The values of all the above environment variables are just examples; your values will vary according to the installation path. Another way to accomplish this task is to add all the above environment variables into file.sh and execute the file.sh command from the .profile file.

Step 4: Register the Harvest Environment Variables

Log out and log in to register the environment variables. If the CA Clarity PPM server is already running, restart the CA Technologies Clarity Application (app) and the CA Technologies Clarity Background (bg) services. Do this from CA Clarity System Administration.

Step 5: Make the SD-Clarity Connector form available to Harvest CM Workbench users

You must make the SD-Clarity Connector form files available to all Harvest CM Workbench users through email, a shared network location, or some other method. Users can then copy the files to their local folders.

SD-Clarity Connector.htm
SD-Clarity Connector.hfd
castylesr1.css
cssimages folder

Note: By default, the Harvest Forms folder is C:\Program Files\CA\AllFusion Harvest Change Manager\Forms.

Additional Setup Considerations

In addition to these Harvest setup procedures, complete the following tasks on Harvest:

Define a Harvest project using the Harvest Administrator application.
Create the Harvest project in CA Clarity PPM.

How to Execute CA Clarity PPM Administrative Tasks

Following are the administrative tasks in CA Clarity PPM that you need to complete to integrate CA Clarity PPM with Harvest and Service Desk.

Grant Harvest Project Access Rights to CA Clarity PPM Resources

If you are integrating CA Clarity PPM with AllFusion Harvest Change Manager, you must grant Harvest Project global access rights to each CA Clarity PPM resource that will be creating Harvest projects in CA Clarity PPM. There are four global access rights that you must grant to CA Clarity PPM resources for the resource to view the Harvest Project custom object in CA Clarity PPM, and to create Harvest projects in CA Clarity PPM.

You have already granted the necessary access rights for the initial CA Clarity PPM resources. As you add new CA Clarity PPM resources to CA Clarity PPM, you must grant them access rights to the Harvest Project custom object in CA Clarity PPM.

Note: If the CA Clarity PPM user is not associated to a CA Clarity PPM resource, first create the resource.

Note: Contact your CA Clarity PPM administrator or see the Administration Guide for more information.

To grant Harvest Project global access rights to resources

Enter the URL for CA Clarity PPM in a web browser.
Enter your CA Clarity PPM administrator username and password, and click Login.
The Home page appears.
Click the Administration Tool icon at the top right.
The Administration Home page appears.
Click Resources from the Organization and Access menu.
The Resources page appears.
Click the name of the resource to which you want to grant Harvest Project global access rights to resources.
The Resource: Properties page appears.
Click Global from the content menu, under Resource Access Rights.
The Resource: Global Access Rights page appears.
Click Add.
The Select Access Rights page appears.
Filter for the global access rights to grant to the resource:
1. In the Access Right Filter section, at Access Right, enter harvest.
2. Click Filter.
In the list, click the Select All icon to select all four access rights, and click Add.
The Resource: Global Access Rights page appears.
Click Exit.

Adding Incident Categories to CA Clarity PPM

If you add new change order categories associated with the Create Clarity Work Request workflow to Service Desk, you must also add a matching incident category in CA Clarity PPM. The name of the CA Clarity PPM incident category must be the same as the name of the change order category in Service Desk.

Creating CA Clarity PPM incident categories is basic CA Clarity PPM administration functionality.

Note: There is no intended association between CA Clarity PPM incidents and Service Desk incidents.

Note: Contact your CA Clarity PPM administrator or see the Administration Guide for more information.

Adding Resources to CA Clarity PPM

As resources are added to Service Desk and Harvest that need to be used by all products in the connector, you must add a matching resource in CA Clarity PPM. The CA Clarity PPM resource identification code (ID) must be the same as the ID of the resource in Service Desk and Harvest.

Note: For each CA Technologies product that you have connected using the connector, the resource and user IDs controlled by each product must use the same values. These values allow the products to correctly pass resource and user information. Consult with CA Technology Services if you require an automated synchronization process for resource and user IDs.

Note: Contact your CA Clarity PPM administrator or see the Administration Guide for more information.

About the CA Clarity PPM Process Engine and Job Scheduler

The following CA Clarity PPM add-ins both interface to Unicenter Service Desk as part of their functionality:

Accelerator: Business Relationship Manager
Connector: Unicenter Service Desk/Harvest

The interface depends on the CA Clarity PPM process engine and/or job scheduler. If you are using either of the add-ins and CA Clarity PPM is being run as a J2EE packaged application on WebLogic or WebSphere servers, configure both the CA Clarity PPM process engine and the job scheduler to run on the CA Clarity PPM background server.

Tell Technical Publications how we can improve this information