Previous Topic: Installing and Configuring the Connector with Service Desk

Next Topic: Service Desk User Tasks

Installing and Configuring the Connector with Harvest

You can install and configure AllFusion Harvest Change Manager to support the connector among Service Desk, CA Clarity PPM, and Harvest. You can install the connector on Windows, UNIX, and Linux servers.

Important! All UNIX references refer to both UNIX and Linux, unless noted otherwise.

This section contains the following topics:

Choose the Section for Your Environment

How to Install and Configure Harvest and Service Desk on Windows

How to Install and Configure Harvest and Service Desk on UNIX

How to Install and Configure Harvest on Windows and Service Desk on UNIX

How to Install and Configure Harvest on UNIX and Service Desk on Windows

Create a Key File

Add Entries to the Key File

Customize the bso.xml File

How to Create the Harvest Project from Lifecycle Template

How to Load the Form in to the Harvest Database

How the Form is Loaded in to Harweb

hcrypt, the Harvest Encryption Utility

hidmgr, the Harvest ID File Manager Utility

The bso.xml File

Choose the Section for Your Environment

For instructions on how to install the connector, see the section for your environment:

How to Install and Configure Harvest and Service Desk on Windows

The following process describes how to install and configure the connector when Harvest and Service Desk are installed on Windows servers.

Each step specifies whether the task applies to the Harvest‑Windows server only or to the Service Desk‑Windows server only. When a task mentions neither server specifically, the task applies to both servers.

  1. Install and configure the connector's files.
  2. Create a Harvest Project from Lifecycle Template.
  3. Load the SD-Clarity Connector form into Harvest.
  4. Load the SD-Clarity Connector form on each Harvest client.
  5. If you are using the Harvest web interface (Harweb), in Harweb, load the SD-Clarity Connector form.

Before you start, complete the installation prerequisites for your environment.

Installation Prerequisites

Before you install the connector on Harvest, be sure to complete the following installation prerequisites.

  1. Ensure that the following are installed and running:
  2. Ensure that following are included in Windows PATH environment variable:

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

Note: For information about Harvest and Service Desk installation requirements, including third party components, see your Harvest and Service Desk documentation.

Step 1: How to Install and Configure the Files

Note: If Service Desk is on a Windows server separate from the Harvest server, then perform this step on both servers.

Perform the following to install and configure the connector's files:

  1. Extract the connector's files.
  2. Create a Windows system environment variable.
  3. Update the CA Change Management Integration Windows PATH environment variable.
  4. Delete the hid.dfo file.
  5. Using hcrypt, create the connector's key file.

    Important! When Harvest and Service Desk are installed on two different Windows servers, ensure that you specify the same name for the connector's key file on both servers.

  6. Use the hidmgr utility to add entries for Harvest and Service Desk to the connector's key file.
  7. Customize the bso.xml file.

Extract the files

Extract the connector's files from the CMI_WINDOWS.zip file to your server program files\CA folder, for example, C: \Program Files\CA).

Create a Windows System Environment Variable

After creating the connector's Windows system environment variable, you must reboot the Service Desk-Windows server for the Service Desk service to recognize your changes.

To create the connector's Windows system environment variable

  1. Create a Windows system environment variable named SD_CL_CNCTR_HOME.

    Note: For instructions on how to create a Windows system environment variable, see your Windows documentation.

  2. Ensure that this variable points to the directory in which you extracted the CMI_WINDOWS.zip file.

    For example, if you extracted the CMI_WINDOWS.zip file in C:\Program Files\CA, then the value of SD_CL_CNCTR_HOME is C:\Program Files\CA\CMI.

  3. Add %SD_CL_CNCTR_HOME%\bin to the PATH environment variable.

Delete the hid.dfo File

Important! Perform this step every time you re-install or reconfigure CA Change Management Integration.

Search %HARVESTHOME% for the hid.dfo file. If this file exists, delete it.

Key File

Use the hcrypt utility to create the connector's key file. This utility encrypts and decrypts information.

More information:

Create a Key File

Add Entries to the Key File

Use the hidmgr to add, read, modify, and delete entries in the connector's key file. After you create this key file, add the required entries for Harvest and Service Desk to the file, once for Harvest and once for Service Desk.

More information:

Add Entries to the Key File

Customize the bso.xml File

The bso.xml file is the connector's configuration file. Customize this file for your environment on both the Harvest-Windows and Service Desk-Windows servers.

More information:

Customize the bso.xml File

Step 2: Create a Harvest Project from Lifecycle Template

Important! This section applies to the Harvest-Windows server only.

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.

More information:

How to Create the Harvest Project from Lifecycle Template

Step 3: Load the Form into the Harvest Database

Load the SD-Clarity Connector form into the Harvest database and verify that it appears in the list of available forms in the Harvest Administrator application.

More information:

How to Load the Form in to the Harvest Database

Step 4: Make the Form Available to Harvest CM Workbench Users

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:

Note: The Harvest CM Workbench is provided for Harvest clients on Windows servers only.

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

Harvest administrators must make these 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.

Step 5: Load the Form into Harweb

Important! If your environment uses Harweb, do the following on the Harweb server; otherwise, skip this step.

To use the Service Desk Clarity Connector lifecycle template and the Service Desk Clarity Connector Request for Change form, you must load the SD-Clarity Connector form into Harweb.

More information:

How the Form is Loaded in to Harweb

How to Install and Configure Harvest and Service Desk on UNIX

The following procedures show you how to install and configure the connector when Harvest and Service Desk are on UNIX servers. This section applies whether Harvest and Service Desk are installed on the same UNIX server or on two different UNIX servers; differences between the two procedures are explained when necessary.

Each step specifies whether the task applies to the Harvest‑UNIX server only or to the Service Desk‑UNIX server only. When a task mentions neither server specifically, the task applies to both servers.

  1. Install and configure the files.
  2. Create a Harvest Project from Lifecycle Template.
  3. Load the form into the Harvest database.
  4. Load the form onto each Harvest client.
  5. If you are using the Harvest web interface (Harweb), in Harweb, load the form.

Before you start, complete the installation prerequisites for your environment.

Installation Prerequisites

Before you install the connector on Harvest, be sure to complete the following installation prerequisites.

  1. Ensure that the following are installed and running:
  2. Ensure that JAVA_HOME/bin is included in the PATH.

Note: For information about Harvest and Service Desk installation requirements, including third party components, see your Harvest and Service Desk documentation.

Step 1: How to Install and Configure the Files

Perform the following to install and configure the connector's files:

  1. Extract the connector's files.
  2. On the Service Desk-UNIX server, update the system profile (/etc/profile).
  3. On the Service Desk-UNIX server, set the environment variables.
  4. On the Service Desk-UNIX server, restart the Service Desk daemons.
  5. On the Harvest-UNIX server, update the user profile (.profile file).
  6. On the Harvest-UNIX server, restart the Harvest broker.
  7. Delete the hid.dfo file.
  8. Use hcrypt to create the connector's key file.
  9. Use the hidmgr utility to add entries for Harvest and Service Desk to the key file.
  10. Customize the bso.xml file.

Extract the Files

To extract the connector files

  1. Extract the connector from the CMI_UNIX.tar file to an accessible location, for example, /home.

    The CMI directory is created in that location.

  2. Change to the /home directory in the shell. Issue the following at the command prompt:
    chmod -R 755 CMI
    

Update the System Profile

Important! If Harvest and Service Desk are installed on the same UNIX server, perform these steps. However, if Harvest and Service Desk are installed on two different UNIX servers, perform these steps on the Service Desk-UNIX server only.

To update the system profile (/etc/profile)

  1. Add the following lines to the system profile:
    SD_CL_CNCTR_HOME=<complete path name of the CMI directory>
    Add $SD_CL_CNCTR_HOME/bin to the PATH environment variable
    Export PATH, SD_CL_CNCTR_HOME
    

    For example, if you installed CMI_UNIX.tar to the /home directory, add the following lines to the system profile:

    SD_CL_CNCTR_HOME= /home/CMI
    PATH=”${PATH}”:$SD_CL_CNCTR_HOME/bin
    export PATH SD_CL_CNCTR_HOME
    
  2. If the Service Desk privileged user is running the C or Trusted C shells, make the corresponding changes to /etc/.login as well:
    setenv SD_CL_CNCTR_HOME <complete path name of the CMI directory>
    
  3. Ensure that /etc/profile is executed. If you use su, run /etc/profile explicitly as follows:
    . /etc/profile
    

Set the Environment Variables

Important! If Harvest and Service Desk are installed on the same UNIX server, perform these steps. However, if Harvest and Service Desk are installed on two different UNIX servers, perform these steps on the Service Desk-UNIX server only.

Set the environment variables that are described in $SD_CL_CNCTR_HOME/bin/env.sh. For help, see the $SD_CL_CNCTR_HOME/bin/env_template.sh file.

Restart the Service Desk Daemons

Important! If Harvest and Service Desk are installed on the same UNIX server, perform these steps. However, if Harvest and Service Desk are installed on two different UNIX servers, perform these steps on the Service Desk-UNIX server only.

You must restart the Service Desk daemons for the Service Desk service to recognize your environment variable changes.

To restart the Service Desk daemons on the Service Desk-UNIX server

  1. Exit your UNIX session.
  2. Log in to UNIX again as the Service Desk privileged user.
  3. Verify if SD_CL_CNCTR_HOME is set correctly by executing the following at the command prompt:
    env SD_CL_CNCTR_HOME.
    
  4. As the root user, stop the Service Desk daemons by executing the following at the command prompt:
    pdm_halt
    
  5. As the Service Desk privileged user, start the Service Desk daemons by executing the following at the command prompt:
    pdm_init
    

Update the User Profile

Important! If Harvest and Service Desk are installed on the same UNIX server, perform this step. However, if Harvest and Service Desk are installed on two different UNIX servers, perform these steps on the Harvest-UNIX server only.

To update the user profile (.profile file)

  1. Add the following lines to the user profile (.profile file) where the Harvest broker is running:

    Note: If Harvest and Service Desk are running on the same server and the Harvest broker is running in root, then skip this step.

    SD_CL_CNCTR_HOME=<complete path name of the CMI directory>
    Add $SD_CL_CNCTR_HOME/bin to the PATH environment variable
    Export PATH,SD_CL_CNCTR_HOME
    

    For example, if you installed CMI_UNIX.tar to the /home directory, add the following lines to the system profile:

    SD_CL_CNCTR_HOME= /home/CMI
    PATH=”${PATH}”:$SD_CL_CNCTR_HOME/bin
    export PATH SD_CL_CNCTR_HOME
    
  2. Ensure that system profile is executed. If you use su, run .profile explicitly as follows:
     . ~/.profile
    

Restart the Harvest Broker

Important! If Harvest and Service Desk are installed on the same UNIX server, perform this step. However, if Harvest and Service Desk are installed on two different UNIX servers, perform these steps on the Harvest-UNIX server only.

You must restart the Harvest broker for the environment variable changes to be recognized by Harvest.

To restart the Harvest broker on the Harvest-UNIX server

  1. Start the command prompt and enter the following command:
    bkrd -shutdown
    
  2. Restart the broker. To do this, execute the following command:
    bkrd
    

Delete the hid.dfo File

Important! Perform this step every time you re-install or reconfigure CA Change Management Integration.

Search $HARVESTHOME for the hid.dfo file. If this file exists, delete it.

Key File

Use the hcrypt utility to create the connector's key file. This utility encrypts and decrypts information.

More information:

Create a Key File

Add Entries to the Key File

Use the hidmgr to add, read, modify, and delete entries in the connector's key file. After creating this key file, add the required entries for Harvest and Service Desk to the file, by following these steps, once for Harvest and once for Service Desk.

More information:

Add Entries to the Key File

Customize the bso.xml File

The bso.xml file is the connector's configuration file. Customize this file for your environment on both the Harvest-UNIX and Service Desk-UNIX servers.

More information:

Customize the bso.xml File

Step 2: Create a Harvest Project from Lifecycle Template

Important! Perform this step on the Harvest‑UNIX server only.

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.

More information:

How to Create the Harvest Project from Lifecycle Template

Step 3: Load the Form into the Harvest Database

Important! Perform this step on the Harvest‑UNIX server only.

Load the SD-Clarity Connector form into the Harvest database and verify that it appears in the list of available forms in the Harvest Administrator application.

More information:

How to Load the Form in to the Harvest Database

Step 4: Make the Form Available to Harvest CM Workbench Users

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:

Note: The Harvest CM Workbench is provided for Harvest clients on Windows servers only.

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

Harvest administrators must make these 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.

Step 5: Load the Form into Harweb

Important! If your environment uses Harweb, do the following on the Harweb server; otherwise, skip this step.

To use the Service Desk Clarity Connector lifecycle template and the Service Desk Clarity Connector Request for Change form, you must load the SD-Clarity Connector form into Harweb.

More information:

How the Form is Loaded in to Harweb

How to Install and Configure Harvest on Windows and Service Desk on UNIX

The following procedures show you how to install and configure the connector when Harvest is on a Windows server and Service Desk is on a UNIX server.

Each step specifies whether the task applies to the Harvest‑Windows server only or to the Service Desk‑UNIX server only. When a task mentions neither server specifically, the task applies to both servers.

  1. Install and configure the files.
  2. Create a Harvest Project from Lifecycle Template.
  3. Load the Service Desk Clarity Connector form into the Harvest database.
  4. Load the Service Desk Clarity Connector form on each Harvest client.
  5. If you are using the Harvest web interface (Harweb), in Harweb, load the Service Desk Clarity Connector form.

Before you start, complete the installation prerequisites for your environment.

Installation Prerequisites

Before you install the connector on Harvest, be sure to complete the following installation prerequisites.

On the Harvest‑Windows server

  1. Ensure that the following are installed and running:
  2. Ensure that the following are included in the PATH environment variable:

On the Service Desk‑UNIX server

  1. Ensure that the following are installed and running:
  2. Ensure that JAVA_HOME/bin is included in the PATH environment variable.

Note: For information about Harvest and Service Desk installation requirements, including third party components, see your Harvest and Service Desk documentation.

Step 1: How to Install and Configure the Files

Perform the following procedures to install and configure the connector's files:

  1. Extract the connector's files.
  2. Create a Windows system environment variable on the Harvest‑Windows server.
  3. Update the system profile.
  4. Set the environment variables.
  5. Restart the Service Desk daemons.
  6. Delete the hid.dfo file.
  7. Create the key file.
  8. Add entries to the key file.
  9. Customize the bso.xml file.

Extract the files

To extract the connector's files on the Harvest‑Windows server

Extract the files from the CMI_WINDOWS.zip file to the program files\CA folder on your server. For example, C:\Program Files\CA.

To extract the connector's files on the Service Desk‑UNIX server

  1. Extract the files from the CMI_UNIX.tar file to an accessible location, for example, /home.

    The CMI directory is created in that location.

    Change to the /home directory in the shell.

  2. At the command prompt, execute the following command:
    chmod -R 755 CMI
    

Create a Windows System Environment Variable

Important! Perform this step on the Harvest‑Windows server only.

To create the connector's Windows system environment variable

  1. Create a Windows system environment variable named SD_CL_CNCTR_HOME.

    Note: For instructions on how to create a Windows system environment variable, see your Windows documentation.

  2. Ensure that this new variable points to the directory in which you extracted the CMI_WINDOWS.zip file.

    For example, if you extracted the CMI_WINDOWS.zip file in C:\Program Files\CA, then the value of SD_CL_CNCTR_HOME is C:\Program Files\CA\CMI.

  3. Add %SD_CL_CNCTR_HOME%\bin to the PATH environment variable.

Update the System Profile

Important! Perform this step on the Service Desk‑UNIX server only.

To update the system profile (/etc/profile)

  1. Add the following lines to the system profile:
    SD_CL_CNCTR_HOME=<complete path name of the CMI directory>
    Add $SD_CL_CNCTR_HOME/bin to the PATH environment variable
    Export PATH, SD_CL_CNCTR_HOME
    

    For example, if you installed CMI_UNIX.tar to the /home directory, add the following lines to the system profile:

    SD_CL_CNCTR_HOME= /home/CMI
    PATH=”${PATH}”:$SD_CL_CNCTR_HOME/bin
    export PATH SD_CL_CNCTR_HOME
    
  2. If the Service Desk privileged user is running the C or Trusted C shells, make the corresponding changes to /etc/.login as well:
    setenv SD_CL_CNCTR_HOME   <complete path name of the CMI directory>
    
  3. Ensure that /etc/profile is executed. If you use su, run /etc/profile explicitly as follows:
     . /etc/profile
    

Set the Environment Variables

Important! Perform this step on the Service Desk‑UNIX server only.

Set the environment variables that are described in $SD_CL_CNCTR_HOME/bin/env.sh. For help, see the $SD_CL_CNCTR_HOME/bin/env_template.sh file.

Restart the Service Desk Daemons

After setting the connector's Windows system environment variable, you must restart the Service Desk daemons for the Service Desk service to recognize the environment variable changes.

Important! Perform this step on the Service Desk‑UNIX server only.

To restart the Service Desk daemons on the Service Desk-UNIX server

  1. Exit your UNIX session.
  2. Log in to UNIX again as the Service Desk privileged user.
  3. Verify if SD_CL_CNCTR_HOME is set correctly. At the command prompt, execute the following command:
    env SD_CL_CNCTR_HOME.
    
  4. As the root user, stop the Service Desk daemons. At the command prompt, execute the following command:
    pdm_halt
    
  5. As the Service Desk privileged user, start the Service Desk daemons. At the command prompt, execute the following command:
    pdm_init
    

Delete the hid.dfo File

Important! Perform this step every time you re-install or reconfigure CA Change Management Integration.

Search the HARVESTHOME directory for the hid.dfo file. If this file exists, delete it.

Create the Key File

Important! You must specify the same name for the key file on both the Harvest and Service Desk servers.

On both the Harvest-Windows and Service Desk-UNIX servers, use hcrypt to create the connector's key file. This utility encrypts and decrypts information.

More information:

Create a Key File

Add Entries to the Key File

Use the hidmgr to add, read, modify, and delete entries in the connector's key file. On both the Harvest and Service Desk servers, after creating this key file, add the required entries for Harvest and Service Desk to the file, once for Harvest and once for Service Desk.

More information:

Add Entries to the Key File

Customize the bso.xml File

The bso.xml file is the CA Change Management Integration configuration file. Customize this file for your environment on both the Harvest and Service Desk servers.

More information:

Customize the bso.xml File

Step 2: Create a Harvest Project from Lifecycle Template

Important! Perform this step on the Harvest-Windows server only.

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.

More information:

How to Create the Harvest Project from Lifecycle Template

Step 3: Load the Form into the Harvest Database

Important! Perform this step on the Harvest-Windows server only.

Load the SD-Clarity Connector form into the Harvest database and verify that it appears in the list of available forms in the Harvest Administrator application.

More information:

How to Load the Form in to the Harvest Database

Step 4: Make the Form Available to Harvest CM Workbench Users

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:

Note: The Harvest CM Workbench is provided for Harvest clients on Windows servers only.

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

Harvest administrators must make these 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.

Step 5: Load the Form into Harweb

Important! If your environment uses Harweb, do the following on the Harweb server; otherwise, skip this step.

To use the Service Desk Clarity Connector lifecycle template and the Service Desk Clarity Connector Request for Change form, you must load the SD-Clarity Connector form into Harweb.

More information:

How the Form is Loaded in to Harweb

How to Install and Configure Harvest on UNIX and Service Desk on Windows

The following procedures show you how to install and configure the connector when Harvest is on a Windows server and Service Desk is on a UNIX server.

Each step specifies whether the task applies to the Service Desk‑Windows server only or to the Harvest‑UNIX server only. When a task mentions neither server specifically, the task applies to both servers.

  1. Install and configure the connector's files.
  2. Create a Harvest Project from Lifecycle Template.
  3. Load the Service Desk Clarity Connector form into the Harvest database.
  4. Load the Service Desk Clarity Connector form on each Harvest client.
  5. If your environment uses the Harvest web interface (Harweb), in Harweb, load the Service Desk Clarity Connector form.

Before you start, complete the installation prerequisites for your environment.

Installation Prerequisites

Before you install the connector on Harvest, be sure to complete the installation prerequisites.

On the Service Desk‑Windows server

  1. Ensure that the following are installed and running on the Service Desk‑Windows server:
  2. Ensure that following are included in the PATH environment variable on the Service Desk‑Windows server:

On the Harvest‑UNIX server

  1. Ensure that the following are installed and running:
  2. Ensure that JAVA_HOME/bin is included in the PATH environment variable.

Note: For information about Harvest and Service Desk installation requirements, including third party components, see your Harvest and Service Desk documentation.

Step 1: How to Install and Configure the Files

Perform the following procedures to install and configure the connector's files:

  1. Extract the connector's files.
  2. On the Service Desk‑Windows server, create a Windows system environment variable.
  3. On the Harvest‑UNIX server, update the user profile (.profile file).
  4. On the Harvest‑UNIX server, restart the Harvest broker.
  5. Delete the hid.dfo file.
  6. Using the hcrypt utility, create the connector's key file.

    Important! You must specify the same name for the key file on both the Harvest and Service Desk servers.

  7. Use the hidmgr to add entries for Harvest and Service Desk to the key file.
  8. Customize the bso.xml file.

Extract the files

To extract the connector's files on the Service Desk-Windows server

Extract the files from the CMI_WINDOWS.zip file to the program files\CA folder on your server, for example, C: \Program Files\CA.

To extract the connector's files on the Harvest‑UNIX server

  1. Extract the connector's files from the CMI_UNIX.tar file to an accessible location, for example, /home.

    The CMI directory is created in that location.

  2. Change to the /home directory in the shell.
  3. Issue the following at the command prompt:
    chmod -R 755 CMI
    

Create a Windows System Environment Variable

Important! Perform the following on the Service Desk‑Windows server only.

You must reboot the Service Desk-Windows server after you create the connector's Windows system environment variable for the Service Desk service to recognize the changes.

To create the connector's Windows system environment variable

  1. Create a Windows system environment variable named SD_CL_CNCTR_HOME.

    Note: For instructions on how to create a Windows system environment variable, see your Windows documentation.

  2. Ensure that this new variable points to the directory in which you extracted the CMI_WINDOWS.zip file.

    For example, if you extracted the CMI_WINDOWS.zip file in C:\Program Files\CA, then the value of SD_CL_CNCTR_HOME is C:\Program Files\CA\CMI.

  3. Add %SD_CL_CNCTR_HOME%\bin to the PATH environment variable.

Update the User Profile

Important! Perform the following on the Harvest-UNIX server only.

To update the user profile (.profile file)

  1. Add the following lines to the user profile (.profile file) where the Harvest broker is running:
    SD_CL_CNCTR_HOME=<complete pathname of the CMI directory>
    
    Add $SD_CL_CNCTR_HOME/bin to the PATH environment variable
    Export PATH,SD_CL_CNCTR_HOME
    

    For example, if you installed CMI_UNIX.tar to the /home directory, add the following lines to the system profile:

    SD_CL_CNCTR_HOME= /home/CMI
    PATH=”${PATH}”:$SD_CL_CNCTR_HOME/bin
    export PATH SD_CL_CNCTR_HOME
    
  2. Ensure that the system profile is executed. If you use su, run .profile explicitly as follows:
     . ~/.profile
    

Restart the Harvest Broker

Important! Do the following on the Harvest‑UNIX server only.

You must restart the Harvest broker for the environment variable changes to be recognized by Harvest.

To restart the Harvest broker on the Harvest-UNIX server

  1. Start the command prompt.
  2. Execute the following command:
    bkrd -shutdown
    
  3. Restart the broker. To do this, execute the following command:
    bkrd
    

Delete the hid.dfo File

Important! Perform this step every time you re-install or reconfigure CA Change Management Integration.

Search the HARVESTHOME directory for the hid.dfo file. If this file exists, delete it.

Create the Key File

On both the Harvest and Service Desk servers, use hcrypt to create the connector's key file. This utility encrypts and decrypts information.

More information:

Create a Key File

Add Entries to the Key File

Use the hidmgr to add, read, modify, and delete entries in the connector's key file. After you create this key file, on both the Harvest-UNIX server and the Service Desk-Windows server, add the required entries for Harvest and Service Desk to the file, once for Harvest and once for Service Desk.

More information:

Add Entries to the Key File

Customize the bso.xml File

The bso.xml file is the CA Change Management Integration configuration file. Customize this file for your environment on both the Harvest and Service Desk servers.

More information:

Customize the bso.xml File

Step 2: Create a Harvest Project from Lifecycle Template

Important! Perform this step on the Harvest‑UNIX server only.

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.

More information:

How to Create the Harvest Project from Lifecycle Template

Step 3: Load the Form into the Harvest Database

Important! Perform this step on the Harvest‑UNIX server only.

Load the SD-Clarity Connector form into the Harvest database and verify that it appears in the list of available forms in the Harvest Administrator application.

More information:

How to Load the Form in to the Harvest Database

Step 4: Make the Form Available to Harvest CM Workbench Users

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:

Note: The Harvest CM Workbench is provided for Harvest clients on Windows servers only.

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

Harvest administrators must make these 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.

Step 5: Load the Form into Harweb

Important! If your environment uses Harweb, do the following on the Harweb server; otherwise, skip this step.

To use the Service Desk Clarity Connector lifecycle template and the Service Desk Clarity Connector Request for Change form, you must load the SD-Clarity Connector form into Harweb.

More information:

How the Form is Loaded in to Harweb

Create a Key File

Use the hcrypt utility to create the connector's key file. This utility encrypts and decrypts information.

To create and store the connector's key file

  1. Start the command prompt.
  2. Execute the following command, specifying the file name of your choice:
    hcrypt -g -k <complete pathname>
    

    Example:

    hcrypt -g -k sd_cl_cnctr.key
    
  3. Copy this key file to the key folder.

More information:

hcrypt, the Harvest Encryption Utility

Add Entries to the Key File

Use the hidmgr to add, read, modify, and delete entries in the connector's key file. Add the required entries for Harvest and Service Desk to the file, once for Harvest and once for Service Desk.

To add entries to the connector's key file

  1. Start the command prompt.
  2. Start the hidmgr. Execute the following command, using the complete path name of the key file you created:
    hidmgr <key file>
    

    Windows Example:

    hidmgr c:\program files\ca\cmi\key\sd_cl_cnctr.key
    

    UNIX Example:

    hidmgr /home/CMI/key/sd_cl_cnctr.key
    

    The hidmgr menu options appear.

  3. Select option 1 - Add an entry.
  4. Enter the value for each of the following at the utility prompt:

    Note: Record these values so that you can supply them correctly when customizing the bso.xml file.

Customize the bso.xml File

The bso.xml file is the connector's configuration file. To customize this file for your environment, follow these steps on both the Harvest and Service Desk servers.

To customize the bso.xml file for your environment

  1. Using a text editor, open the bso.xml file.
  2. Under the sti:general element, provide values for the following elements:
  3. Note: If the path name contains a space, use ~ symbols. For example, if the path is C:\Program Files\CA\CMI, specify the path as follows:
    “C:\PROGRA~1\CA\CMI”
    
    sti:keyfile

    Specify the complete path of the connector's key file.

    Windows Example:

    <sti:keyfile>
    C:\PROGRA~1\CA\CMI\key\allfusion.key
    </sti:keyfile>
    

    UNIX Example:

    <sti:keyfile>
    /home/CMI/key/allfusion.key
    </sti:keyfile>
    
    sti:idmanagerpgm

    Specify the complete path of the hidmgr.

    On Windows, this file is typically located in the %SD_CL_CNCTR_HOME%\bin folder.

    On UNIX, this file is typically located in the $SD_CL_CNCTR_HOME/bin directory.

    Windows Example:

    <sti:idmanagerpgm>
    c:\PROGRA~1\CA\CMI\bin\hidmgr.exe
    </sti:idmanagerpgm>
    

    UNIX Example:

    <sti:idmanagerpgm>
    /home/CMI/bin/hidmgr
    </sti:idmanagerpgm>
    
    sti:dateformat

    Specify the date format; the default value is dd/MM/yyyy HH:mm:ss aaa.

    The following table contains examples of other date and time formats:

Date and Time Pattern

Example

“yyyy.MM.dd G ‘at’ HH:mm:ss z”

2001.07.04 AD at 12:08:56 PDT

“EEE, MM dd, ‘ ’ yy”

Wed, Jul 4, ‘01

“h:mm a”

12:08 PM

“hh ‘o’ ‘clock’ a, zzzz”

12 o’clock PM, Pacific Daylight Time

“K:mm a, z”

0:08 PM, PDT

“yyyyy.MMMMM.dd GGG hh:mm aaa”

02001.July.04 AD 12:08 PM

“EEE, d MMM yyyy HH:mm:s Z”

Wed, 4 Jul 2001 1208:56 -0700

“yyMMddHHmmssZ”

010704120856-0700

Example:

<sti:dateformat>dd/MM/yyyy HH:mm:ss aaa</sti:dateformat>
  1. Under the harvest element, provide values for the following elements:
    sti:product

    Specify the product name. The default is HARVEST. Specify the same product name used in the connector's key file for the Harvest broker.

    Example:

    <sti:product>HARVEST</sti:product>
    
    sti:state

    Specify the initial lifecycle state of the Harvest project.

    Example:

    <sti:state>Plan</sti:state>
    
    sti:process

    Specify the process name (harvest).

    Example:

    <sti:process>Create RFC</sti:process>
    
    sti:user

    Specify the harvest user name.

    Example:

    <sti:user>harvest</sti:user>
    
  2. Under the uspsd element, provide values for the following elements:
  3. Under the workflow element, provide values for following elements:
  4. If you want to change table name/column names in the form sql script file (SD_CL_CONNECTOR_INGRES.sql, SD_CL_CONNECTOR_ORACLE.sql, SD_CL_CONNECTOR_SQLSERVER.sql), then change the HARVESTFORM element in the bso.xml file.
  5. If you customize the Harvest project, modify the following elements in the bso.xml file:

    Example:

    <sti:harvest>
    	<sti:product>HARVEST</sti:product>
    	<sti:state>Plan</sti:state>
    	<sti:process>Create RFC</sti:process>
    	<sti:user>harvest</sti:user>
    </sti:harvest>
    

How to Create the Harvest Project from Lifecycle Template

Create the 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. You can do this from your Harvest server or from the Harvest client application.

More information:

How Service Desk to Harvest User Tasks are Integrated

Create a Harvest Project on Harvest Server on UNIX or Windows

To create the Harvest project from the Service Desk Clarity Connector lifecycle template on a Harvest client/server

  1. Start the command prompt.
  2. Change the directory. Issue the following command:
  3. Execute the following command:
    himpenv -b [broker name] -usr [harvest user name] 
       -pw [harvest password] -f  sd_cl_connector.har  -oa test.log -wts
    

    Example:

    himpenv -b hqatest5-2003 -usr harvest -pw harvest -f
       sd_cl_connector.har -oa  test.log -wts
    
  4. Check the log file for a message that himpenv was executed successfully.

Create a Harvest Project on Harvest Client Application

To create the Harvest project from the Service Desk Clarity Connector lifecycle template on a Harvest client application

  1. Start Harvest and log in to the Harvest Administrator application. In the login dialog, enter your Harvest user name, password, and broker name.

    The Harvest Administrator application GUI appears.

  2. In the tree under your broker name, click Lifecycle Templates.

    All lifecycle templates display as follows:

  3. Locate the Service Desk Clarity Connector lifecycle template, right-click it, and select Copy To.

    The Copy Project dialog appears.

  4. Enter the name of the new Harvest project you want to create, and select Active Projects from Copy to combo box.

    On the Copy Project dialog, ensure that:

  5. Click OK.

    The new project appears in Active Project list.

How to Load the Form in to the Harvest Database

This section explains how to perform the following on UNIX and Windows platforms:

Load and Verify the Form for UNIX

To load the form into the Harvest database on the Harvest-UNIX server

  1. Ensure that the Harvest database is running, and connect to it.
  2. Start the command prompt.
  3. If the Harvest database is running on Oracle, do this step; otherwise skip it.

    Run the SD_CL_CONNECTOR_ORACLE.sql script file by entering the following command:

    sqlplus <harvest db user name>/<harvest db password>@<SID> 
       @<file name>
    

    Example:

    sqlplus harvest/harvest@orcl @ 
       “/opt/CA/CMI/config/SD_CL_CONNECTOR_ORACLE.sql”
    
  4. If the Harvest database is running on Ingres, do this step; otherwise skip it.

    Run the SD_CL_CONNECTOR_INGRES.sql script file by entering the following command at the command prompt:

    Sql -u<user> -G<group name> <database name> <'sqlfile'>
    

    Example:

    If the database user is harvest and the group is harvest, execute the following command:

    Sql -uharvest -Gharvest_group mdb <“/opt/CA/CMI/config/SD_CL_CONNECTOR_INGRES.sql”
    

To verify that the form was loaded into the Harvest database correctly

  1. Log in to Harvest Administrator, and connect to the Harvest broker for your UNIX server.
  2. Copy the following from the c:\Program Files\CA\CMI\config folder of the connector to the %HARVESTHOME%\FORMS folder of the Harvest client:
  3. Select the Forms tab and verify that the SD-Clarity Connector form appears in the list of available forms.

Load and Verify the Form for Windows

To load the form into the Harvest database on the Harvest-Windows server

  1. Ensure that the Harvest database is running, and connect to it.
  2. Start the command prompt.
  3. If the Harvest database is running on Oracle, do this step; otherwise skip it.

    Run the SD_CL_CONNECTOR_ORACLE.sql script file by executing the following command at the command prompt:

    sqlplus <harvest db user name>/<harvest db password>@<SID> 
       @<file name>
    

    Example:

    sqlplus harvest/harvest@orcl @ 
       “C:\Program Files\CA\CMI\config\SD_CL_CONNECTOR_ORACLE.sql”
    
  4. If the Harvest database is running on SQL Server and if you are using the default instance of SQL Server, do this step; otherwise skip it.

    Run the SD_CL_CONNECTOR_SQLSERVER.sql script file by executing the following command at the command prompt:

    osql -E -d mdb -i  <file name> -o  output.log
    

    Example:

    osql -E -d mdb -i  
       “C:\Program Files\CA\CMI \config\SD_CL_CONNECTOR_SQLSERVER.sql”
    -o output.log
    

    To see whether the script executed successfully, check the log file.

    Note: The SD_CL_CONNECTOR_SQLSERVER.sql file is located in the %SD_CL_CNCTR_HOME%\config folder.

  5. If the Harvest database is running on SQL Server and if you are using the named instance of SQL Server, do this step; otherwise skip it.

    Execute the following command at the command prompt:

    osql -E -S <instance name> -d mdb -i <file name>  -o output.log
    

    Example:

    osql -E -S  computer55 -d mdb -i
    “C:\Program Files\CA\CMI \config\SD_CL_CONNECTOR_SQLSERVER.sql”
       -o output.log
    
  6. If the Harvest database is running on Ingres, do this step; otherwise skip it.

    Run the SD_CL_CONNECTOR_INGRES.sql script file by entering the following command at the command prompt:

    Sql -u<user> -G<group name> <database name> <'sqlfile'>
    

    Example:

    If the database user is harvest and the group is harvest, execute the following command:

    Sql -uharvest -Gharvest_group mdb <“C:\Program Files\CA\CMI \config\ 
       SD_CL_CONNECTOR_INGRES.sql”
    

To verify that the form was loaded into the Harvest database correctly

  1. Copy the following from the c:\Program Files\CA\CMI\config folder of the connector to the %HARVESTHOME%\FORMS folder of the Harvest client:
  2. Log in to the Harvest Administrator application.
  3. Select the Forms tab and verify that the SD-Clarity Connector form appears in the list of available forms.

How the Form is Loaded in to Harweb

Important! If your environment uses Harweb, do the following on the Harweb server; otherwise, skip this step.

To use the Service Desk Clarity Connector lifecycle template and the Service Desk Clarity Connector Request for Change form, you must load the SD-Clarity Connector form into Harweb.

To Load the Form for UNIX

To load the form into the Harweb-UNIX server

  1. Copy $SD_CL_CNTR_HOME/config/SD-Clarity_Connector.xml to HARWEBHOME/harweb, the location where Harweb is deployed.

    For example, if Harweb is deployed in /home/Apache Software Foundation/Tomcat 5.5/webapps, then HARWEBHOME is /home/Apache Software Foundation/Tomcat 5.5/webapps/harweb.

  2. Log in to Harweb Administrator.
  3. Click Forms, Custom Forms.

    The Generate Form window appears.

  4. Complete the following fields on the Generate Form window:
  5. Click Execute.
  6. Copy the following files from the $SD_CL_CNTR_HOME/config/ directory on the UNIX server to the <HARWEBHOME>/harweb directory on the Harweb server, replacing the existing files that have the same name.
  7. Restart Tomcat servlet.

To Load the Form for Windows

To load the form into the Harweb-Windows server

  1. Copy C:\Program Files\CA\CMI\config\SD-Clarity_Connector.xml to HARWEBHOME\harweb, the location where Harweb is deployed.

    For example, if Harweb is deployed in C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps, then HARWEBHOME is C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps\harweb.

  2. Log in to Harweb Administrator.
  3. Click Forms, Custom Forms.

    The Generate Form window appears.

  4. Complete the following fields:
  5. Click Execute.
  6. Copy the following files from the C:\Program Files\CA\CMI\config folder to the <HARWEBHOME>\harweb directory on the Harweb-Windows server, replacing the existing files that have the same name.
  7. Restart Tomcat servlet.

hcrypt, the Harvest Encryption Utility

Using hcrypt, the Harvest encryption utility, you can create the connector's key file. This utility encrypts and decrypts information.

Instructions for running hcrypt appear in context. This section provides additional details about the utility for your information.

The command syntax is:

hcrypt <OPTION> -f <Encrypted File> -i <Input File> -m 
   <Message to Encrypt> -o <Output File> -k <Key File> 
   -p <Encryption Key>

Options

-e = Encrypt the file

-d = Decrypt the file

-g = Generate a new key file (Requires the option -k followed by file name)

-h = Help

-v = Display version

-f = Final encrypted file

-i = Input file that needs to be encrypted

-m = One line message to encrypt

-o = File name to write the decrypted value. Works only with -d option (Optional)

-k = Encryption key file (Optional)

-p = Encryption key (Optional)

Rules

Examples:

hidmgr, the Harvest ID File Manager Utility

Use the Harvest ID File Manager utility (hidmgr) to add, read, modify, and delete the connector's key file entries. After creating this key file, add the required entries for Harvest and Service Desk to it.

Note: Instructions for running the hidmgr appear in context. This section provides additional details about the utility for your information.

When prompted, enter values for the following:

The hidmgr utility provides the following options to maintain the connector's key file:

  1. Add an entry
  2. Remove an entry
  3. Update an entry
  4. List all computer names
  5. Get Password
  6. Exit

When you select Options 1 to 5, the utility prompts you to enter required information.

Sample Scenario

When you start the hidmgr, the following screen appears:

If you select Option 1, hidmgr prompts you to supply the information shown on the following sample screen:

After you answer the prompts shown, the information that you entered is added to the key file.

View Product Information

To view the product information, select Option 4, as shown on the following screen:

The bso.xml File

The bso.xml file is the connector's configuration file. All scripts read configuration information from this script.

Note: Instructions for configuring bso.xml appear in context. This section provides additional details about the file for your information.

In the bso.xml file, you must specify configuration information in xml format, as follows:

<element - name>value of the element </element>

The following rules apply:

For example, a sample entry is:

<product>HARVEST</product>

In this example:

The structure of the bso.xml file follows:

<?xml version="1.0" encoding="UTF-8"?>
<sti:bso xmlns:sti="http://www.ca.com/sti#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="bso.xsd" >
   <sti:general>
      <sti:keyfile>  </sti:keyfile>
      <sti:idmanagerpgm> </sti:idmanagerpgm>
      <sti:timezone> </sti:timezone>
      <sti:dateformat> </sti:dateformat>
   </sti:general>
 <sti:harvest>
<sti:product> </sti:product>
      <sti:state>Plan</sti:state>
      <sti:process></sti:process>
      <sti:user></sti:user>
</sti:harvest>
   <sti:uspsd>
      <sti:product> </sti:product>
      <sti:server> </sti:server>
      <sti:wsdl> </sti:wsdl>
      <sti:osuser> </sti:osuser>
<sti:chgobj>chg</sti:chgobj>
 <sti:cntobj>cnt</sti:cntobj>
<sti:workflowobj> </sti:workflowobj>
      <sti:chgstatusobj>chgstat</sti:chgstatusobj>
      <sti:taskstatusobj> </sti:taskstatusobj>
         </sti:uspsd>
   <sti:workflow>
      <sti:createpackage>Y</sti:createpackage>
      <sti:createform>Y</sti:createform>
      <sti:packageprefix></sti:packageprefix>
      <sti:packagesuffix></sti:packagesuffix>
   </sti:workflow>
   <sti:harvestform>
      <sti:tablename> </sti:tablename>
      <sti:changeordernumbercolumn> </sti:changeordernumbercolumn>
      <sti:datereportedcolumn> </sti:datereportedcolumn>
      <sti:fixbycolumn> </sti:fixbycolumn>
      <sti:prioritycolumn> </sti:prioritycolumn>
      <sti:descriptioncolumn> </sti:descriptioncolumn>
      <sti:categorycolumn> </sti:categorycolumn>
      <sti:reportedbycolumn> </sti:reportedbycolumn>
      <sti:formprefix></sti:formprefix>
      <sti:formsuffix></sti:formsuffix>
   </sti:harvestform>
</sti:bso>