Install or Upgrade in Silent Mode

You can install or upgrade  in silent mode (without user interaction). Silent mode is suitable for distribution when all of the settings are known and are provided in a response file. To install or upgrade in silent mode, complete these tasks:
xdtw1161
You can install or upgrade
CA XCOM Data Transport for Windows
in silent mode (without user interaction). Silent mode is suitable for distribution when all of the settings are known and are provided in a response file. To install or upgrade in silent mode, complete these tasks:
2
2
Complete the Preliminary Tasks
  1. Verify that you meet the installation prerequisites.
  2. Understand that you can rollback the upgrade manually
    only
    . No automatic rollback exists.
  3. (If applicable) If you are
    installing for the first time
    , perform these tasks:
    Choose a System ID (1 and 4 characters) and System Name (1 and 8 characters) for this
    CA XCOM Data Transport for Windows
    system. Together, the System ID and System Name uniquely identify this system. You supply both values during the installation or upgrade.
    Understand that when you run the installation program, it performs the following tasks to install the product:
    1. Verifies the following pre-installation criteria:
      • The user who invokes the installer has administrative permissions.
      • No
        CA XCOM Data Transport for Windows
        processes are running.
    2. Installs the following entities:
      • CA XCOM Data Transport for Windows
        binary files and services
      • CAPKI and CA License software
        Service pack 11.1.02 and later does not need CA License software.
    3. Performs post-installation tasks.
  4. (If applicable) If you are
    upgrading
    , verify that you have read and understood the upgrade process, reviewed the considerations, and completed the pre-upgrade tasks in the section that applies to your environment:
Become Familiar With the Response File
Before you run a silent installation or upgrade, you build a response file that you customize to your installation. You can configure one response file and can use this file on multiple systems. You require separate response files
only
if you want to install different options on different systems. After you create the response files, you can run the silent installation or upgrade, as explained later in this page.
The response file contains values for the variables that control the installation. Response files use a simple key=value format.
Review the Response File Requirements
For Windows-based target systems, save the response file in one of the following encodings. Otherwise, the installation fails.
  • UTF-8 without a BOM
  • UTF-16 little endian
When you specify a path name in the response file, use a second backslash as an escape character before each directory name and file name in the path, for example:
JDBC_DRIVER=C:\\temp\\DB2 LUW\\db2jcc.jar
Create Your Response File
To create your response file for a silent installation or upgrade,
either
use the installation wizard
or
copy and customize a sample response file. Details follow for each option:
Use the Installation Wizard
Follow these steps to use the installation wizard:
  1. XCOM must not be running.
  2. Elevate the command prompt by right-clicking it and selecting Run as administrator.
  3. Change to the directory that contains the XCOM installer.
  4. Enter the following command to create the response file:
    XCOM.exe -r <response file path and name>
    Example:
    XCOM.exe -r c:\temp\XCOM.properties
    If you specify a path name without a file name, the default file name installer.properties is used.
    This command starts the GUI installation wizard.
  5. Answer the prompts from the wizard.
    For information about the prompts, see Install in GUI Mode.
  6. When you reach the Preinstallation Summary page, click Cancel.
    Your selections are saved in the response file.
Next, run the response file, as explained in Run the Installation or Upgrade later on this page.
Copy and Customize a Sample Response File
Follow these steps to copy and customize a sample response file:
  1. Review the sample files that follow and select the one that most closely matches your need for a new installation or upgrade.
  2. Copy the text from the file and paste it into a text file.
  3. Save the file and customize it as needed.
    For example, for new installations
    only
    , you might want to customize the system ID (SYSID) and system name (SYSNAME) values in the response properties file.
Next, run the response file, as explained in Run the Installation or Upgrade later on this page.
Sample Response File for a Typical New Installation
# Tue Dec 22 10:12:57 IST 2015 # Replay feature output # --------------------- # This file was built by the Replay feature of InstallAnywhere. # It contains variables that were set by Panels, Consoles or Custom Code. #Choose Install Folder #---------------------------- USER_INSTALL_DIR=C:\\Program Files\\CA\\XCOM #Choose Install Set #------------------------ CHOSEN_FEATURE_LIST=BaseXCOM CHOSEN_INSTALL_FEATURE_LIST=BaseXCOM CHOSEN_INSTALL_SET=Typical #Set System ID and System Name #------------------------------------------ SYSID=WIN SYSNAME=SYSNAME
Sample Response File for a Typical New Installation – SP03
# Wed Mar 04 13:48:07 CET 2020 # Replay feature output # --------------------- # This file was built by the Replay feature of InstallAnywhere. # It contains variables that were set by Panels, Consoles or Custom Code. #Choose Java Virtual Machine #--------------------------- JAVA_DOT_HOME=C:\\Program Files\\Java\\jre #Choose Install Folder #--------------------- USER_INSTALL_DIR=C:\\Program Files\\CA\\XCOM #Choose Install Set #------------------ CHOSEN_FEATURE_LIST=BaseXCOM CHOSEN_INSTALL_FEATURE_LIST=BaseXCOM CHOSEN_INSTALL_SET=Typical #Set System ID and System Name #----------------------------- SYSID=WIN SYSNAME= SYSNAME
Sample Response File for a Custom New Installation
# Tue Dec 22 10:12:57 IST 2015 # Replay feature output # --------------------- # This file was built by the Replay feature of InstallAnywhere. # It contains variables that were set by Panels, Consoles or Custom Code. #Choose Install Folder #---------------------------- USER_INSTALL_DIR=C:\\Program Files\\CA\\XCOM #Choose Install Set #------------------------ CHOSEN_FEATURE_LIST=BaseXCOM,SNA CHOSEN_INSTALL_FEATURE_LIST=BaseXCOM,SNA CHOSEN_INSTALL_SET=Custom #CA XCOM Invokable TP Setup #-------------------------- LUNAME=XCOMLU #Set System ID and System Name #------------------------------------------ SYSID=WIN SYSNAME=SYSNAME
Sample Response File for a Custom New Installation – SP03
# Wed Mar 04 13:48:07 CET 2020 # Replay feature output # --------------------- # This file was built by the Replay feature of InstallAnywhere. # It contains variables that were set by Panels, Consoles or Custom Code. #Choose Java Virtual Machine #--------------------------- JAVA_DOT_HOME=C:\\Program Files\\Java\\jre #Choose Install Folder #--------------------- USER_INSTALL_DIR=C:\\Program Files\\CA\\XCOM #Choose Install Set #------------------------ CHOSEN_FEATURE_LIST=BaseXCOM,SNA CHOSEN_INSTALL_FEATURE_LIST=BaseXCOM,SNA CHOSEN_INSTALL_SET=Custom #CA XCOM Invokable TP Setup #-------------------------- LUNAME=XCOMLU #Set System ID and System Name #------------------------------------------ SYSID=WIN SYSNAME=SYSNAME
Sample Response File for a New Installation with Cleanup Option– SP03
# Wed Mar 04 14:32:58 CET 2020 # Replay feature output # --------------------- # This file was built by the Replay feature of InstallAnywhere. # It contains variables that were set by Panels, Consoles or Custom Code. #Cleanup Choice #-------------- CLEANUP=YES #Choose Java Virtual Machine #--------------------------- JAVA_DOT_HOME=C:\\Program Files\\Java\\jre #Choose Install Folder #--------------------- USER_INSTALL_DIR=C:\\Program Files\\CA\\XCOM #Choose Install Set #------------------ CHOSEN_FEATURE_LIST=BaseXCOM CHOSEN_INSTALL_FEATURE_LIST=BaseXCOM CHOSEN_INSTALL_SET=Typical #Set System ID and System Name #----------------------------- SYSID=WIN SYSNAME=SYSNAME
Sample Response File for an Upgrade to SP01
# Wed Feb 17 16:35:41 IST 2016 # Replay feature output # --------------------- # This file was built by the Replay feature of InstallAnywhere. # It contains variables that were set by Panels, Consoles or Custom Code. #Upgrade Choice #-------------- UPGRADE=YES #Choose Backup Directory #----------------------- BACKUPDIR=C:\\Program Files\\CA\\XCOM_R116BACKUP #Choose Trusted Database drivers #------------------------------- JDBC_DRIVER=C:\\temp\\DB2 LUW\\db2jcc.jar DB2_LICENSE_DRIVER=C:\\temp\\DB2 LUW\\db2jcc_license_cu.jar
Sample Response File for an Upgrade to SP02
# Thu Sep 21 12:38:15 IST 2017 # Replay feature output # --------------------- # This file was built by the Replay feature of InstallAnywhere. # It contains variables that were set by Panels, Consoles or Custom Code. #Upgrade Choice #-------------- UPGRADE=YES #Choose Backup Directory #----------------------- BACKUPDIR=C:\\Program Files\\CA\\XCOM_R116_SPBACKUP #Trusted Database #---------------- UPGRADETRUSTED=YES #Choose Trusted Database drivers #------------------------------- JDBC_DRIVER=C:\\Program Files\\CA\\XCOM\\lib DB2_LICENSE_DRIVER=C:\\Program Files\\CA\\XCOM\\lib #History database #---------------- UPGRADEHISTDB=NO
Sample Response File for an Upgrade to SP03
# Wed Mar 04 14:29:04 CET 2020 # Replay feature output # --------------------- # This file was built by the Replay feature of InstallAnywhere. # It contains variables that were set by Panels, Consoles or Custom Code. #Choose Java Virtual Machine #--------------------------- JAVA_DOT_HOME=C:\\Program Files\\Java\\jre #Upgrade Choice #-------------- UPGRADE=YES #Choose Backup Directory #----------------------- BACKUPDIR=C:\\Program Files\\CA\\XCOM_R116SP03BACKUP #Trusted Database #---------------- UPGRADETRUSTED=YES #Choose Trusted Database drivers #------------------------------- JDBC_DRIVER=C:\\Program Files\\CA\\XCOM\\lib DB2_LICENSE_DRIVER=C:\\Program Files\\CA\\XCOM\\lib #History database #---------------- UPGRADEHISTDB=NO
Run the Installation or Upgrade
To run the silent installation or upgrade, follow these steps:
  1. XCOM must not be running
  2. Run the Installer
    either
    asynchronously
    or
    synchronously:
    (Asynchronously)
    Enter the following command:
    XCOM.exe -i silent -f <response file path and name>
    For example:
    XCOM.exe -i silent -f c:\temp\XCOM.properties
    The command prompt returns immediately, and the silent installation process runs asynchronously in the background. Allow time for the silent installation to finish.
    (Synchronously)
    Enter the following command:
    Start /w XCOM.exe -i silent -f <response file path and name>
    For example:
    Start /w XCOM.exe -i silent -f c:\temp\XCOM.properties
    The command prompt returns once the silent installation has finished.
    To query the status of the installation, enter the following command:
    echo %errorlevel%
Override Values for Selected Variables from the Command Line
For the following variables
only
, you can optionally use the -D operand to override the values in the response file with new values that you specify at the command prompt:
For new installations
only
:
  • SYSID
  • SYSNAME
  • LUNAME
  • USER_INSTALL_DIR
For upgrades
only
:
  • BACKUPDIR
  • JDBC_DRIVER
  • DB2_LICENSE_DRIVER
For example, for new installations
only
, to override the SYSID and SYSNAME values in the response file with new values from the command line, enter the following command:
XCOM.exe -i silent -f c:\temp\XCOM.properties -DSYSID=
xxxx
-DSYSNAME=
yyyyyyyy
Use this example as a model to set custom values for other variables from the command line, if necessary.
Priority Order of Setting Values for Selected Variables
For a silent installation, the priority order follows for setting the values of SYSID, SYSNAME, LUNAME, and USER_INSTALL_DIR:
1. Command Line
2. Response File
3. Default Values
Perform the Post-Installation or Post-Upgrade Tasks
If you installed the product for the first time, perform these post-installation tasks:
  1. (Optional) Set the PATH variable to include the directory where
    CA XCOM Data Transport for Windows
    is installed.
  2. Before you use the product, start the XCOMD CA XCOM Scheduler service.
  3. Create the CA XCOM batch interactive group for running jobs or scripts.
If you upgraded the product, complete the post-upgrade tasks in the section that applies to your environment:
Review the Log Files
If an error occurs, the silent installation does not display any dialog. Instead, view status information about the installation in the default xcominstaller.log file in the temporary directory:
%temp%\xcominstaller.log
The xcominstaller.log file includes warnings, error messages, and exit codes that occurred during the installation.
If you want to view the sequence of actions that the installer performed, see the following section:
%XCOM_HOME%\Uninstaller\Logs\*install*.log
If trusted database is not configured, you can ignore the following message or any message related to JDBC jar files from the installation log (%temp%\xcominstaller.log) -
  • Specified JDBC Driver File <JAR FILE PATH>> is not valid
If the history database is not configured, you can ignore the following message or any message related to database upgrade from the installation log (%temp%\xcominstaller.log) -
  • No Success return code on UpgradeDB action. Failed with return code:nn
Analyze the Return Codes
To verify that the installation occurred successfully, analyze the return codes for the silent installation.