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/Server Scan: Scans your current Control-M/Server 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. This scan includes an option to rescan your Control-M/EM, if required.

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 50,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

Log in to the account where Control-M/EM is installed with a username that is associated with an Admin-level role.
Download the Helix Control-M/EM Data Qualification Tool to your Control-M/EM host from Helix Control-M/EM Qualification Tool, and unzip it to a temporary folder.
From the command line, navigate to the temporary folder where you unzipped the Helix Control-M/EM Data Qualification Tool, and run the following command to scan your environment:
- Linux: HelixEMQualificationTool.sh
- Windows: HelixEMQualificationTool.bat
Your environment is scanned and an Excel-based EM_Qualifiation_Report.xlsx file 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.
From the Control-M/EM home directory, open the EM_Qualifiation_Report.xlsx file, and review and follow the directions.

Depending on the results of this preliminary Control-M/EM qualification scan, you might have to run this tool more than once.

Scanning Your Self-Hosted Control-M/Server

This procedure describes how to scan your Control-M/Server or Control-M for z/OS to determine whether to migrate or connect it as a self-hosted component to Helix Control-M, 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 also rescan your Control-M/EM, if required.

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

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 Setting Up the API.

Begin

Download the Helix Control-M/Server Data Migration tool, based on your operating system, from Helix Control-M Migration Tool, and unzip it to a temporary folder.
(Optional) To migrate %%LIBMEMSYM variable lists, create a %%LIBMEMSYM control file, as described in Creating a LIBMEMSYM Control File.
From the inputParameters folder, inside the temporary folder, open the parameters.txt file and define the All Modes parameters, as described in Migration Tool Parameters.
From the command line, navigate to the temporary folder and do one of the following:
- Scan a Self-Hosted Control-M/Server: Do the following:
  1. Run the following command:
    migrateToHelix.bat q-CtmServerOnly
    Scan and export time depends on the size of your environment.
    The scan runs and produces an Excel-based Server_Qualification_Report-<Server_Name>.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.
  2. From the report folder, open, review, and follow the directions in the Server_Qualification_Report-<Server_Name>.xlsx file.
- Scan Control-M/EM and a Self-Hosted Control-M/Server: Do the following:
  1. Run the following command:
    migrateToHelix.bat qualification
    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.
  2. From the report folder, open the Qualification_Report.xlsx file, and review and follow the directions.

Creating a LIBMEMSYM Control File

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

Begin

Find and record all unique LIBMEMSYM files that each %%LIBMEMSYM variable points to.
Copy all of the LIBMEMSYM files that you found from Control-M/Server to a temporary folder on your host.
Open a text editor and for each unique %%LIBMEMSYM variable list, type each of the following entries—separated by , (commas)—on a new line:
- Pathname of the copied LIBMEMSYM file that is located on your host, which 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
Save the LIBMEMSYM_Control_File.csv file, record the pathname, 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/Server, 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	All (Scan and Migration) Modes	--control-m-automation-api-endpoint=<endpoint>:8443/automation-api
Server Name	All Modes	--control-m-server-name=<Server-Name>
Control-M/EM Administrator Username	All Modes	--control-m-enterprise-manager-username=<EM_Username>
Control-M/EM Administrator Password	All Modes	--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	All Modes	--control-m-enterprise-manager-database-username=<Database_Username>
Control-M/EM Database Password	All Modes	--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	All Modes	--control-m-enterprise-manager-database-type=<Database_Type> Type MSSQL, PostgreSQL, or Oracle.
Control-M/EM Database Host Name	All Modes	--control-m-enterprise-manager-database-hostname=<Database_Host_Name>
Control-M/EM Database Port Number	All Modes	--control-m-enterprise-manager-database-port=<Port_Number>
Control-M/EM Database Name	All Modes	--control-m-enterprise-manager-database-name=<EM_Database_Name> Type your database or service name.
%%LIBMEMSYM Variable List	All Modes	--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 Creating a LIBMEMSYM Control File.
Control-M Helix Automation API Endpoint	All Migration Modes	--control-m-helix-automation-api-endpoint=<Endpoint>/automation-api
Control-M Helix Automation API Token	All Migration Modes	--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	All Migration Modes	--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.