Helix Control-M Qualification

Before you migrate some or all of your self-hosted Control-M environment to Helix Control-M, you must run the following qualification scans with the BMC presales team to determine the migration type that best suits your organization:

  • Preliminary Control-M/EM Qualification Scan: Scans your current self-hosted Control-M/EM and produces a preliminary Qualification Report that enables you to determine if you can migrate to Helix Control-M, and helps you estimate the work effort required.

  • In-Depth Control-M/EM and Control-M/Servers Scan: Scans your self-hosted Control-M/EM and Control-M/Servers and produces an in-depth Qualification Report that enables you to determine which Control-M/Servers can migrate to Helix Control-M and which Control-M/Servers must remain self-hosted but can connect to Helix Control-M in Unified View.

  • You cannot migrate Control-M for z/OS environments to Helix Control-M. However, you can connect them to Helix Control-M Unified View.

  • You cannot migrate Control-M/Servers with Agents on unsupported operating systems or with unsupported plug-ins to Helix Control-M. However, you can connect them to Helix Control-M Unified View.

  • You cannot connect a self-hosted Control-M/Server that is installed on Windows to Helix Control-M Unified View.

  • If your Control-M/Servers or Control-M for z/OS environments execute more than 100,000 jobs daily, you must distribute these jobs on two or more Control-M/Servers or Control-M for z/OS environments.

Scanning Your Self-Hosted Control-M/EM

This procedure describes how to scan your current self-hosted Control-M/EM to determine what steps you must take before you can migrate to Helix Control-M. You can run this tool from any Windows- or Linux-based Control-M/EM host.

Before You Begin

  • Verify that Control-M/EM 9.0.20 or higher is installed.

  • Verify that you have access to the Control-M/EM host.

Begin

  1. Log in the Control-M/EM host with a user ID that is associated with an Admin role.

  2. Download the Helix Control-M/EM Qualification Tool to your Control-M/EM host from Helix Control-M/EM Qualification Tool, and unzip it to a temporary folder.

  3. From the command line, navigate to the temporary folder where you unzipped the qualification tool, and run the following command to scan your environment:

    • Linux: HelixQualificationTool.sh

    • Windows: HelixQualificationTool.bat

    Your environment is scanned and an Excel-based Qualification Report is produced, which includes one or more of the following results in the Qualification Summary sheet:

    • Passed

    • Manual action is required.

    • An incompatibility was found.

    • Not qualified.

  4. From the Control-M/EM home directory, open the Qualification Report file, EMHelixQualification.xlsx, and review and follow the directions.

    Depending on the results in the preliminary Qualification Report, you might have to run this tool more than once.

Scanning Your Self-Hosted Control-M/EM and Self-Hosted Control-M/Servers

This procedure describes how to scan your Control-M/EM and a self-hosted Control-M/Server or Control-M for z/OS to determine whether to migrate or connect a self-hosted component, and discover what you must do beforehand. You must perform this procedure for every self-hosted Control-M/Server or Control-M for z/OS in your environment.

You can run this tool from any Windows or Linux computer.

Before You Begin

  • Verify that Control-M Automation API 9.0.20.245 or higher is installed on the Control-M/EM server.

  • Verify that you have access to the Control-M/EM database.

BMC recommends that you use the latest version of Control-M Automation API. For more information, see Automation API Installation.

Begin

  1. Download the Helix Control-M Migration Tool migration tool, based on your operating system, from Helix Control-M Migration Tool, and unzip it to a temporary folder.

  2. (Optional) To migrate %%LIBMEMSYM variable lists, create a %%LIBMEMSYM control file, as described in Creating a LIBMEMSYM Control File.

  3. From the inputParameters folder, inside the unzipped migrateToHelix temporary folder, open the parameters.txt file in a text editor and define the Scan mode parameters, as described in Migration Tool Parameters.

  4. Do one of the following:

    • To scan your environment and export up to 5,000 folders (default) in *.json format, do the following:

      1. (Optional) To change the default 5,000-folder export limit, from the path/data/ directory in the unzipped migrateToHelix folder, open the configuration.json file in a text editor and change the foldersCountLimit parameter value, as shown in the following example:

        Copy 
        "foldersCountLimit": 10000

      2. From the command line, navigate to the unzipped migrateToHelix folder and run the following command:

        migrateToHelix.bat q

    • To scan your environment and export all folders in *.json format, do the following:

      1. Install the most recent version of Control-M Automation API on Control-M/EM Server, as described in Automation API Installation.

      2. From the command line, navigate to the unzipped migrateToHelix folder and run the following command:

        migrateToHelix.bat e

        Scan and export time depends on the size of your environment.

    The scan runs and produces an Excel-based Qualification Report.xlsx file in the report folder, which includes one or more of the following results in the Qualification Summary sheet:

    • Passed

    • An automatic adjustment was made.

    • Manual action is required.

    • An incompatibility was found.

  5. From the report folder, open, review, and follow the directions in the Qualification Report.

    Depending on the results in the Qualification Report, you might have to run this tool more than once.

Creating a LIBMEMSYM Control File

This procedure describes how to create a LIBMEMSYM control file, which enables the migration tool to migrate your %%LIBMEMSYM variable lists to Pool variables. For more information, see Variable Lists.

Begin

  1. Find all unique LIBMEMSYM files that each %%LIBMEMSYM variable points to, and copy these files from the Control-M/Server to a temporary folder on your host.

  2. Open a text editor and for each unique %%LIBMEMSYM variable list, type the following entries—separated by , (commas)—on a new line:

    • Pathname of the copied LIBMEMSYM file on your host that you copied from the Control-M/Server.

    • Pathname of the LIBMEMSYM file on the Control-M/Server.

    • Pool Name that each variable in the %%LIBMEMSYM variable list is migrated into.

      c:\temp\libMem1.txt,C:\Program Files\BMC Software\Control-M Server\ctm_server\libMem1,PoolName1

      c:\temp\libMem2.txt,C:\Program Files\BMC Software\Control-M Server\ctm_server\libMem2,PoolName2

      c:\temp\libMem3.txt,C:\Program Files\BMC Software\Control-M Server\ctm_server\libMem3,PoolName3

  3. Save the LIBMEMSYM_Control_File.csv file and type the pathname after the = (equals sign) in the %%LIBMEMSYM Variable List Parameter, as described in Migration Tool Parameters.

Migration Tool Parameters

The following table describes the parameters that you must define when Scanning Your Self-Hosted Control-M/EM and Self-Hosted Control-M/Servers, Migrating to Helix Control-M, and Migrating a Self-Hosted Control-M/Server to Helix Control-M, depending on the mode.

Parameter

Mode

Definition

Control-M Automation API Endpoint

  • Scan

  • Migration

--control-m-automation-api-endpoint=<endpoint>:8443/automation-api

Control-M/Server Name

  • Scan

  • Migration

--control-m-server-name=<Control-M/Server-Name>

Control-M/EM Administrator Username

  • Scan

  • Migration

--control-m-enterprise-manager-username=<EM_Username>

Control-M/EM Administrator Password

  • Scan

  • Migration

--control-m-enterprise-manager-password=<EM_Password>

To enter the password when prompted by the migration tool, delete =<EM_Password>.

Control-M/EM Database Username

  • Scan

  • Migration

--control-m-enterprise-manager-database-username=<Database_Username>

Control-M/EM Database Password

  • Scan

  • Migration

--control-m-enterprise-manager-database-password=<Database_Password>

To enter the password when prompted by the migration tool, delete =<Database_Password>.

Control-M/EM Database Type

  • Scan

  • Migration

--control-m-enterprise-manager-database-type=<Database_Type>

Type MSSQL, PostgreSQL, or Oracle.

Control-M/EM Database Host Name

  • Scan

  • Migration

--control-m-enterprise-manager-database-hostname=<Database_Host_Name>

Control-M/EM Database Port Number

  • Scan

  • Migration

--control-m-enterprise-manager-database-port=<Port_Number>

Control-M/EM Database Name

  • Scan

  • Migration

--control-m-enterprise-manager-database-name=<EM_Database_Name>

Type your database or service name.

%%LIBMEMSYM Variable List

  • Scan

  • Migration

--libmemsym-control-file=<LIBMEMSYM_Control_File.csv_Pathname>

(Optional) Creates Pool variables with names and values that correspond to each variable in the %%LIBMEMSYM variable list. For more information, see Variable Lists.

Helix does not recognize %%LIBMEMSYM variable lists. You must find all your %%LIBIMEMSYM variable lists, copy them to your local host, and create a control file to migrate your %%LIBIMEMSYM variable lists to Pool variables, as described in Helix Control-M Qualification.

Control-M Helix Automation API Endpoint

  • Migration

  • Deploy Only

--control-m-helix-automation-api-endpoint=<Endpoint>/automation-api

Control-M Helix Automation API Token

  • Migration

  • Deploy Only

--control-m-helix-api-token=<Token_ID>

To enter the API token when prompted by the migration tool, delete =<Token_ID>.

For more information, see Creating an API Token.

Output Folder Path

All Modes

--output-folder-path=output

(Optional) To change the default output folder, replace output with a new directory path.

Skip Missing Agents

Migration

--skip-if-missing-agents

(Optional) Does not migrate job and folder definitions when the required Helix Agents are not installed.

Helix Control-M/Server Name

All Modes

--control-m-helix-server-name=<Control-M/Server_Name>

(Optional) Defines the name of the Helix Control-M/Server that the current Control-M/Server migrates to.