Release Manager Unified Upgrade

This topic provides important information for running the Release Manager Unified Upgrade wizard to upgrade clients, Applications and configuration files.

Overview

The Release Manager Unified Upgrade tool helps you install a new version of CDA by automatically upgrading clients and their related applications, user permissions and configuration settings.

Prerequisites

Oracle Data Access Component (ODAC) version x64 must be installed.

Notes:

  • The Machine wide configuration option must be enabled.
  • After installing ODAC, check if the Oracle.DataAccess.dll file exists in the Oracle ODAC folder. If not, copy it to the folder.

Upgrade Steps

  • Simulation

    Before executing a real upgrade, you can perform a dry-run to identify and fix possible issues. The tool checks:

    • If a backup folder containing the server files of the current installation can be created with the naming schema <YYYYMMDD-hhmmss> and then deleted.
    • If new database reports can be found in the ReportDefinitions folder.
    • If a reporting database is specified in the customer.config file. If so, the tool checks the connection to the database.

  • Migration

    Important! The real upgrade process cannot be undone. If you run a real upgrade and some errors occur, you must fix them and re-execute the wizard from start.

    The tool executes the following steps:

    1. Stop the CDA application in IIS / stop IIS.
    2. Create a backup of the existing installation folder with the suffix <YYYYMMDD-hhmmss>.
    3. Create StateFiles and Logs subfolders and set full permission for IIS_IUSERS.
    4. Create customer.config and web.config files.
    5. Move all client data to a single database with the DataMigrator tool. This step simplifies the system and client setup process. A prefix containing the client information will be added to the tables.
    6. Copy the new installation files (including subfolders) to the existing installation folder.
    7. Start the CDA application in IIS / start IIS (after all databases have been successfully upgraded)

Recommendations and Considerations

  • The upgrade tool cannot write, edit or create any AE object in client 0. Therefore, the system settings (RM.SYSTEM_SETTINGS) cannot be created automatically. This step must be carried out manually by an Administrator.
  • If the CDA service user does not have write/create permissions on the client, the tool cannot write, edit, or create any AE object in that client. In this case, the upgrade tool cannot create RM.CLIENT_SETTINGS and modify user/user group objects. These steps must be performed manually.

More information:

Follow the wizard instructions considering the issues listed here:

  • Before running the wizard, review the General Requirements for Upgrading CDA
  • The tool retrieves the information to connect to the Automation Engine system and CDA databases from the source customer.config and web.config files.
  • Encrypted configuration files cannot be upgraded.
  • The CDA tools DataMigrator, ApplicationContentMigrator and SyncPermission.ps1 are automatically executed by the Release Manager Unified Upgrade tool. The tools can still be used independently (see: Tools to Upgrade a CDA System Manually)
  • The wizard shows you the list of database connections for all clients: 
    • Available clients that can be migrated and number of applications
    • Unavailable clients (no connection could be established)
    • Clients that already run on the latest version
  • After executing the Release Manager Unified Upgrade tool, all databases are merged into one single database. You can merge the existing data into a new empty database or select an existing one. A prefix is added to the database table names to identify the client where the data is stored. For example: prefix="C100_". The data from all clients must be migrated.
  • The target database selected in the wizard is used as connectionString.
  • The settings defined in the customer.config are copied to the ClientInfo and AEConnectInfo database tables.
  • CDA can only connect to one AE instance, otherwise, an error will be thrown.
  • The source path is automatically detected by the tool if one of the following conditions apply:
    • The BOND server was installed in the standard folder of IIS. 
    •  ARA 12.0/12.1 was installed using the ONE Installer.
    • CDA 12.2/12.3 was installed using the ONE Installer.
  • The upgrade steps for each client run in parallel.
  • For security reasons, passwords are masked.
  • All Applications (even non-compliant ones) are migrated.
  • All Artifact Sources and Artifacts are migrated.
  • A link to the summary log file is provided in the last step of the wizard. A new log file is generated for each migration run.
  • Read this section to learn more about configuration files: Configuring the CDA Web Application
  • The Release Manager Unified Upgrade tool can be also executed in console mode. See: Running the Release Manager Unified Upgrade Wizard in Console Mode (Command Line)
  • Check the log file for information about connection errors.

Running the Release Manager Unified Upgrade Wizard in Console Mode (Command Line)

Syntax

\ramiusupgradetool.exe <command> [parameters]

Commands

  • Help [parameter]

    Provides information about parameters and their description.

    Parameters

    • upgrade

      Describes how to upgrade a CDA system.

      Mandatory: no

  • Upgrade [parameter]

    Runs the tool in real mode.

    Parameters

    • -source

      Path to the source configuration directory.

      Example: c:\inetput\wwroot\ReleaseManager\webui

      Mandatory: yes

    • -target

      Path to the folder where the new configuration files should be stored.

      Mandatory: yes

    • -targetDb

      Connection string to the target database for the OneDB migration step.

      Mandatory: yes (if the OneDB migration step is needed)