Upgrade on Windows

This article details about how you can upgrade the  on Windows.
cahscm140
This article details about how you can upgrade the
CA Harvest SCM
on Windows .
2
The Upgrade Wizard
Use the Upgrade Wizard to upgrade the CA Harvest SCM server, client, agent and Visual Studio Plugin from a previous product release to the current release. The Upgrade Wizard automatically detects all existing product components from supported releases on a local computer and upgrades them to the current release, in their existing locations. In addition, the Upgrade Wizard backs up your existing supported product release settings, forms, and configuration files and restores them for use with the current release.
The Upgrade Wizard should
not
be used to:
  • Upgrade any product component from a release other than CA Harvest SCM r12.6 and r13.0.x.
  • Change your database.
  • Change the location of any component already installed, except for a network client.
  • Change the options for any component being upgraded, or add new options. All existing options are updated and you cannot delete them.
  • Upgrade the plug-in for Eclipse option.
  • Specify the specific components to be upgraded.
If any of these situations apply, upgrade the component manually.
On Windows, the product includes the SDK (HSDK), the Java HSDK (JHSDK), and the Component Object Model SDK (COM SDK). If you run the Upgrade Wizard on a computer that has the Release 12.6 client installed, the Upgrade Wizard automatically installs the current release of the HSDK, JHSDK, and COM SDK while upgrading the client to the current release. This action applies to local and network clients.
Prepare for the Upgrade Wizard
Follow these steps:
  1. Determine whether you run the Upgrade Wizard from your local computer, a network location, or a shared drive, rather than from the installation media.
    We recommend that you run the Upgrade Wizard directly from the installation media. However, if you decide not to use the installation media, verify that you have copied all of the installation files to the appropriate location and the files are accessible.
  2. If you have not already done so, read the
    Release Information
    . Do not start the Upgrade Wizard until you have read that information and understand it.
  3. Verify that you have Windows Administrator rights on the computers that you plan to upgrade.
    For information about how to verify and upgrade your rights, see your Windows documentation.
  4. Verify the accuracy of your path names.
    • Path names must be standard and must begin with a drive letter, such as the C:\Program Files\ or D:\somedir\someApp\.
    • You can use mapped drives and relative path names, such as ..\somedir\someApp.
    • You cannot use Universal Naming Convention (UNC) path names, such as \\myMachine\somedir\someApp.
  5. For all supported
    servers
    you upgrade, complete the following steps:
    • Verify that the server or client of your database is on the same computer as the Database Configuration Utility. When you use the Upgrade Wizard to upgrade the server, this utility is automatically upgraded.
    • If applicable, verify your database administrator (DBA) credentials. If your
      CA Harvest SCM
      database is running locally, when you upgrade the server, enter the user name and password of the DBA (that is, the user who has administrative rights to the database tables). Therefore, have this information ready when you run the Upgrade Wizard.
    • Back up your database.
      For information about how to back up your database, see your vendor documentation.
    • Back up any custom files (including UDP scripts and forms) from the %HARVESTHOME% and %HARVESTHOME%\Forms directories.
      For information about how to back up custom files, see your operating system documentation.
  6. For all
    local clients
    you upgrade, consider the following information:
    • If you already successfully ran the Upgrade Wizard on a computer, all product components are upgraded and you do not have to run the wizard again.
    • If you installed any options such as Windows Shell Extension, when you installed any product component, the Upgrade Wizard automatically upgrades both the component and the options to the current product release at the same time.
      You cannot change existing options for a component. If you want to upgrade a component, but you also want to add an option from the current release to the component, or delete an existing option from the component, you
      cannot
      use the Upgrade Wizard. Uninstall the component that includes the option you do not want, and then install the component again as if you were installing it for the first time.
    • If you run the Upgrade Wizard on a computer that has the product's client installed, the wizard automatically installs the HSDK, JHSDK, and COM SDK while upgrading the client to the current product release.
    • The plug-in for Eclipse is installed and maintained separately from the product components. Therefore, if the Upgrade Wizard detects an existing version of the plug-in, the wizard upgrades all other existing product components and options,
      except
      for the plug-in for Eclipse.
  7. For all
    agents
    you upgrade, consider the following information:
    • All considerations for local clients also apply to agents.
    • You cannot use the Upgrade Wizard to upgrade a network agent. Manually upgrade the agent.
  8. If you use a
    response file
    to upgrade the product, consider the following information:
    • All considerations for individual product components, including the server, client (including a network client), and agent, also apply to a response file.
  9. Remove any emergency fixes (efixes) that have been installed on the existing release.
Upgrade Locally Installed Components Using the Upgrade Wizard
You can use the Upgrade Wizard to upgrade all locally installed product components, including the server, client, and agent.
Follow these steps:
  1. Make sure that you have properly prepared for the upgrade.
  2. Insert the installation media into your drive. If autorun is enabled on your computer, the Upgrade Wizard starts automatically.
    If autorun is not enabled or if you are not running the upgrade from the installation media, start the wizard in Windows Explorer by double-clicking upgrade.exe in the folder where the wizard files have been copied.
    The license agreement appears.
  3. Read and accept the terms of the agreement to continue.
  4. Review the list of product components already installed.
    If your computer has any product components installed that you do
    not
    want to upgrade, exit the wizard now. Then, uninstall the components and install the component again as if you were installing it for the first time.
  5. Click Upgrade to start the upgrade.
  6. If prompted, select the location where your computer can access the product installation files for the component being upgraded. Browse to the location and click OK.
    Typically, if the wizard prompts you for the location of the installation files for the product components, you are prompted in the following order: agent, client, and server.
  7. Continue entering the requested locations for all product components.
  8. Continue following the on-screen instructions to complete the upgrade.
Run the Upgrade Wizard in Unattended (Silent) Mode Using a Response File
To save time during an upgrade, use the default response file to run the Upgrade Wizard and perform an unattended, or silent, upgrade.
Follow these steps:
  1. Copy the default Upgrade Wizard response file (DHUR021705.rkr) to the location from where the upgrade will be run.
    The DHUR021705.rkr file is provided on the installation media in the \upgrade folder.
  2. Use a text editor to open the DHUR021705.rkr file and read the terms of the license agreement.
  3. Accept the terms of the license agreement, as follows:
    1. Find the license agreement parameter listed in the text of the agreement.
    2. Enter the license agreement parameter as an executable option in the file and save the file.
    If you do not accept the license agreement terms, the upgrade will not work.
  4. Enter the -silent option either as a parameter in the DHUR021705.rkr file or enter it on the command line.
  5. (Optional) Modify the response file parameters in the DHUR021705.rkr file based on your specific requirements.
    If any option is needed for the upgrade but is not supplied in the response file, the user running the upgrade is prompted to enter the required values. For example, if the upgrade detects that the client is installed and needs to be upgraded, the upgrade checks for the corresponding entry (-clinstloc=
    client-install-path-name
    ) in the response file. If this entry does not exist in the response file, the upgrade uninstalls the previous client and then prompts the user running the upgrade for the location of the new client installation files.
  6. From the command line, enter the following command:
    upgrade -response="pathname\DHUR021705.rkr" -silent
    • pathname
      Specifies the complete path name or relative path name to the response file DHUR021705.rkr.
      If any part of the
      path name
      in this command includes a space, enclose the complete path name in quotation marks. For example, enclose the path name in -response=”c:\my files\temp\hupgrade.exe” in quotation marks.
      The following sample command illustrates a complete path name.
      "C:\Program Files\CA\SCM"
      The following sample command illustrates a relative path name.
      "..\CA\SCM"
    • -silent
      Specifies that the response file executes silently, with no user input or notification.
  7. Use the hdbsetup Database Configuration Utility to upgrade the database.
Response File Parameters (Server, Client, Agent, and Visual Studio Plug-in)
The following parameters for the Server, Client, Agent, and Visual Studio Plug-in apply only to the content of the DHUR021705.rkr response file that is used to run the Upgrade Wizard in unattended (silent) mode. You
cannot
use these options directly from the command line. The response file can include any combination of these parameters.
When editing the response file, verify that you do not enclose parameters in quotation marks, even if they include spaces.
Example: Illustrates the Correct Format for Response File Parameters
-svinstloc=server-install-pathname
Example: Illustrates the Incorrect Format for Response File Parameters
-svinstloc="server-install-pathname"
The following response file parameters are available for the Server, Client, Agent, and Visual Studio Plug-in.
  • -svinstloc=server-install-path-name
    Specifies the path name of the installation files for the server.
  • -clinstloc=client-install-path-name
    Specifies the path name of the installation files for the client.
  • -aginstloc=agent-install-path-name
    Specifies the path name of the installation files for the agent.
  • -scmagentport=<
    portnumber
    >
    Specifies the port number for the agent components.
  • -vciinstloc=vsip-install-path-name
    Specifies the path name of the installation files for Visual Studio Plug-in.
Database Configuration and Maintenance
After using the Upgrade Wizard to upgrade the
CA Harvest SCM
server, database, and other components, configure and maintain the database. This configuration ensures that the upgraded software runs as expected in your environment. To configure, run the Database Configuration Utility for any supported database.
Backward Compatibility
When you upgrade Client / Workbench and Server to a higher version of
CA Harvest SCM
, upgrade the Agent also to connect to Agent from the upgraded Client / Workbench.
If you are on a release earlier than CA Harvest r12.0 , we recommend you to upgrade to CA Harvest SCM r12.6 first and then, upgrade to CA Harvest SCM 14.0. Releases earlier than r12.0 use "CAcrypto" component to encrypt the password. From CA Harvest SCM r12.0 onwards, this encryption is done by ETPKI [also referred to as CAPKI].
The below instructions are applicable only if you are upgrading from CA Harvest SCM r7.x to r14.0. Contact Broadcom Support to get a recommendation on the upgrade approach that you can follow for your organization or environment.
Convert the Encrypted Password
The convpw (convert password) command-line utility converts the CACE encrypted user passwords stored in the
CA Harvest SCM
database tables and the various dfo files to the eTPKI encrypted format. Encrypted credentials are saved in a hidden file named hsvr.dfo in <CA_SCM_HOME>; which is then utilized by the
CA Harvest SCM
server processes when connecting to the database server.
To convert existing passwords, execute the convpw command from the command line as follows:
convpw -db DBResource DBUsername DBPassword
convpw -dfo
convpw -dfo filenamec
Follow these steps:
  1. Set the following variables:
    export CACRYPTDIR=location of CAcrypto
    export CACRYPTINI=
    location of CAcrypto INI file
    export LD_LIBRARY_PATH=
    location of CAcrypto libraries
    export SHLIB_PATH=
    location of CAcrypto libraries
    export LIBPATH=
    location of CAcrypto libraries
    Make sure that these variables are set before upgrading
    CA Harvest SCM
    database tables to Service Pack 12.1.03 from 7.x.
  2. Execute the convpw command from the command line to convert the password in the database:
    convpw -db D
    BResource DBUsername DBPassword
  3. Execute the convpw command from the command line to convert the password in the dfo file:
    convpw {-dfo
    filename
    .dfo}
    The CACE encrypted user passwords stored in the
    CA Harvest SCM
    database tables and the various dfo files are converted to the eTPKI encrypted format.