Previous Topic: Prepare for the UpgradeNext Topic: Migrate the CA Risk Authentication Database

CA Advanced Authentication Upgrade Guide › CA Advanced Authentication Upgrading › How to Upgrade CA Risk Authentication on Windows › Migrate the Common Components Database

Migrate the Common Components Database

To migrate the database for the common components, perform the following steps.

Follow these steps:

  1. Copy the Upgrade directory to a temporary location on the system where you plan to upgrade.

    This directory contains the following zip files that are applicable for this migration path:

    Important! If CA Strong Authentication is upgraded to 8.0, or if current CA Strong Authentication version is 7.x, or if current CA Risk Authentication version is 3.x, then ignore Steps# 2 to 10

  2. Copy the ca-common-upgrade-1.0.x-2.0.zip file to the ARCOT_HOME directory.
  3. Extract the contents of the ca-common-upgrade-1.0.x-2.0.zip file in this directory.

    Note: Click Yes if you are prompted to overwrite any existing files.

  4. Navigate to the following directory: 
    %ARCOT_HOME%\tools\common\upgrade
  5. Extract the contents of the arcot-common-db-upgrade.zip file in this directory.
  6. Download the JDBC JAR that is compatible with your database:

    Copy the JAR to the %ARCOT_HOME%\tools\common\upgrade\lib directory.

  7. Locate the JAVA_HOME used by the existing installation. Verify that you used the same JAVA_HOME to run the upgrade tool.
  8. Verify that the ArcotAccessKeyProvider.dll shared library is configured with the application server. Copy this file to the <JAVA_HOME used by App Server>\jre\bin\ folder.
  9. Change your working directory to: 
    %ARCOT_HOME%\tools\common\upgrade\
  10. Run the arcot-common-upgrade-framework.jar file by using the following command: 
    java [JVM_Options] -jar arcot-common-upgrade-framework.jar [--log-file <log-file-name>] [--log-level <log-level>][--commit-batch-size <batch_size>] [--product-name common] [--prompt][--mst]

    The following table describes the options that are supported by this JAR file.

Option

Description

JVM-Options

The following JVM options are required only if LDAP organizations are configured:

  • -Xmx<heap_memory_size_in_MB>M: Sets the maximum heap size to 1 GB. If there are more than 1,00,000 users in the configured LDAP, then it is strongly recommended that you increase the heap size to 2048M (2 GB).

-Dcom.arcot.ldap.migration.timeout=<duration>: The migration of an LDAP organization involves fetching all the users from the LDAP server and migrating the users to the CA Risk Authentication database. This parameter sets the maximum time (in minutes) taken to fetch all users from the LDAP server, beyond which the migration of the LDAP organization is marked as failed. The LDAP migration timeout for 1,00,000 users is approximately 240 minutes or 4 hours. However, the timeout value would depend on the type of hardware configuration being used. The default value of this parameter is 240 minutes.

Note: Ensure that the java command executable belongs to JAVA_HOME identified in Step 7. If JAVA_HOME is not set, modify the PATH environment variable to include %JAVA_HOME%\bin.

log-file

Specifies the path to the log file:

  • If you do not provide any value, the arcot_common_upgrade.log file is created in the %ARCOT_HOM%\logs/\directory.
  • If you provide an absolute path, the log file is created at the given location.
  • If you provide a file name, the log file is created in %ARCOT_HOME%\logs\ with the given file name.

log-level

Specifies the log level. If you do not provide any value, the upgrade log level is set to INFO.

commit-batch-size

Specifies the number of transactions to be issued to the database before a COMMIT statement is issued.

product-name

Specifies the name of the product for which the upgrade is run. If you do not specify the product name, the product name is assumed to be common. Possible values are:

  • common: Indicates the common components.
  • CA Risk Authentication: Indicates CA Risk Authentication.

    Note: Ensure that you upgrade the common components before you upgrade CA Risk Authentication.

prompt

Prompts whether to proceed further after each phase of the upgrade process is completed successfully. The upgrade process happens in the following phases:

  • Pre-upgrade: Involves performing various DDL and DML operations to migrate the database schema.
  • Upgrade: Involves migrating the data to the new schema.
  • Post-upgrade: Involves cleanup or follow-up actions that are required to be performed after the upgrade.
  • Verification: Involves the verifying of whether the upgrade is successful.

This option You can choose to run the upgrade tool later to continue from where it stopped. If this option is not specified, the upgrade tool runs without any prompting until the upgrade process is completed.

mst

Refers to the Monitoring Sleep Time. If you specify this option, the upgrade tool prints diagnostic messages describing the progress made during upgrade after sleeping for the specified duration (in minutes.) The default value is two minutes.

Note: If you are upgrading from release 1.0.x, verify for the following line in the %ARCOT_HOME%\logs\arcot_common_upgrade.log file:

Upgrade for common from version 1.0.x to version 2.0 run successfully.

The presence of this line in the log confirms that the database was upgraded successfully.