Creating a configuration file

This topic describes how to create a configuration file.

Before you begin

Perform the procedures described in the Preparing-for-a-project-and-a-pipeline topic.

To create a configuration (Config YAML) file

Use the following procedure to create a configuration file in your CI/CD tool supported repository:

Config YAML file for Universal Connector application

The config YAML file for the Universal Connector application is a YAML formatted document. The Universal Connector application contains the following two applications:

Universal Connector Common application processes are as follows:

Universal Connector Schema Mgmt for Db2 application processes are as follows:

Important

The config file must reside in your CI/CD tool supported repository.
The config file name can be any name as long as it is YAML or yml file type.
The version number must be specified at the top of the config YAML file (for example, version: 1.0.0).
All property keys must be followed by a colon and then a space.
The stepName property key must be preceded by a dash and then a space.
For values with multiple lines, specify the pipe character (|) on the same line after the property key. On the following line, indent the values.

Example

jobCard: |
//JOBNM JOB ($[acctno]),'COMPARE',
// CLASS=Q,MSGLEVEL=(1,1),NOTIFY=&SYSUID

The names for the application processes, which are defined in the configuration file, must be exact (see application process listed above). The application process name is only allowed one definition in the configuration file.
The stepName may have multiple unique definitions for each application process, except authentication.

Example

fileDownload:
  - stepName: mainframe_to_local_Test1
    debugMode: false
    …

  - stepName: mainframe_to_local_Test2
    debugMode: false

The authentication application does not have a stepName definition and allows one definition in the configuration file.
does not support values with more than 1 hash (#) character (for example, TEST#1.MIG#PROF1), since this is reserved for plug-in variables. Input examples that this applies to are: migrate profile name, baseline profile name, baseline name, work ID, etc.

authentication

The authentication application is the first step in the process that enables you to connect securely to the corresponding mainframe host on which z/OSMF is running.

Important

Ensure that you enter the corresponding mainframe IP address or host name of the LPAR in the SYSPLEX on which z/OSMF is running.
Ensure that you enter the corresponding port number of the LPAR in the SYSPLEX on which z/OSMF is running on the mainframe.

Click here for information about this execution step

The following table lists the authentication property keys:

Property key

Description

debugMode

(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file.

Valid values are as follows:

true
(Default) false

hostName

(Required) The hostName property key specifies the Mainframe (host name or IP address) field as one of the two values that identify the mainframe server:

The web address or link known as a Universal Resource Locator (URL)
The static Internet Protocol (IP) address of the mainframe server in IPv4 format.

The mainframe server must be a LPAR on which the communication medium is installed.

port

(Required) The port property key specifies the port that communication medium uses on a mainframe TCP/IP network. Default port for z/OSMF=32208 but may vary at different sites.

authenticationType

(Required) The authenticationType property key specifies the type of authentication to be performed.

Valid values are as follows:

(Default) userBased

Click here if you are using userBased authentication type

The userBased authentication type uses a mainframe user ID and its password for authentication by the z/OSMF server. The user and password allow you to run a pipeline or workflow and submit a JCL job. The following property keys require specification for userBased authentication type:

Property key	Description
user	(Required) The user property key specifies the mainframe logon ID, or a variable, that is used for authentication by the z/OSMF server.
password	(Required) The password property key specifies the password, or a variable, that is used for authentication by the z/OSMF server as a masked identification key.

certBased

Click here if you are using certBased authentication type

The certBased authentication type uses a client certificate and its password for authentication by the z/OSMF server. The certificatePath and certificatePassword allow you to run a pipeline or a workflow and submit a JCL job. The following property keys require specification for certBased authentication type:

Property key	Description
certificatePath	(Required) The certificatePath property key specifies the path of the client certificate file, or a variable, that is used for authentication by the z/OSMF server.
certificatePassword	(Required) The certificatePassword property key specifies the password of the client certificate file, or a variable, that is used for authentication by the z/OSMF server as a masked identification key. It allows to read the client certificate file.

Important

certBased authentication type supports only PKCS #12 type client certificates.
certBased authentication requires the config yaml file to have version: 2.0.0.

symbolicPropertiesFilePath

(Required) The symbolicPropertiesFilePath property key identifies the directory and file name where the plug-in variables file is stored. The plug-in variables file defines the variables and values that the plug-in uses. You can provide any name for the plug-in variables file, but you must use the .properties file extension. The default name of the plug-in variables file is AMI_DevOps.properties.

The symbolicPropertiesFilePath property key should be the relative path of the plug-in variables file with respect to the source code repository root.
Examples:

If the file is maintained under the root of the repository, then specify the file name:
symbolicPropertiesFilePath: AMI_DevOps.properties
If the file is maintained under the folder(s), then specify the folder and file name:
symbolicPropertiesFilePath:/folderName/subFolderName/AMI_DevOps.properties

debugModeAllSteps

(Optional) The debugModeAllSteps property key specifies whether to run all pipeline or workflow steps in debug mode. The authentication property, debugModeAllSteps: true overrides the debugMode: false property for all steps which have been configured in the pipeline or workflow.

Valid values are as follows:

true
(Default) false

executionIdentifier

(Required) The executionIdentifier property key specifies the following values in the steps of Console Output log file. where PIPELINENAME_VALUE, RUNNUMBER_VALUE, RUNBY_VALUE and RUNMODE_VALUE are placeholders defined as variables.

(Default and required) PipelineName=pipelineValue
RunNumber=runNumberValue
RunBy=runByValue
RunMode=runModeValue

fileDownload

You can use the fileDownload application to transfer PDS members from the mainframe environment to a container workspace. This property has a list of map values.

Click here for information about this execution step

The following table lists the fileDownload property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
sourcePds	(Required) The sourcePds property key specifies the partitioned data set (PDS) on the mainframe from which a member is transferred.
sourceMember	(Required) The sourceMember property key specifies the member on the mainframe that is transferred.
destinationDirectory	(Required) The destinationDirectory property key specifies the directory to which a file is received. This property key supports relative paths. If you do not enter any path or enter a period (.), this application considers the relative path with respect to the workspace. There can be 2 types of values for destinationDirectory. Current working directory i.e., workspace directory - value should be (.). Since the workspace directory exists, the user doesn't need to create it. Other directory - value should be absolute path or the name of the directory only and it must exist at the time of the step execution. Write access must be granted to the agent process which is running the pipeline or workflow. Full path example: /home/reports/output To use the /output directory name, you must map the directory with a volume mount option (-v) in your pipeline or workflow, for example: resources: containers: - container: bmc-container image:attach:xwiki:Mainframe.Data-for-Db2.BMC-AMI-DevOps-for-Db2.AMA13100.Using.Using-BMC-AMI-DevOps-with-Universal-Connector.Creating-a-configuration-file.WebHome@filename <image name> options: -u root -v "/home/reports/output":"/output"
destinationFileName	(Required) The destinationFileName property key specifies the file name to be created in the agent workspace directory. This is always saved in the agent workspace directory.

fileUpload

You can use the fileUpload application to transfer files from a container workspace to a mainframe environment. This property has a list of map values.

Click here for information about this execution step

The following table lists the fileUpload property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
sourceDirectory	(Required) The sourceDirectory property key specifies the directory on the client from which a file is transferred. This property key supports relative paths. If you do not enter any path or enter a period (.), this application considers the relative path with respect to the workspace by default. The following example indicates a relative path: $(Agent.BuildDirectory)/s
sourceFileName	(Required) The sourceFileName property key specifies the file on the client that is transferred. For example, the sourceFileName might be the client DDL file. The sourceFileName must be a plain text file.
destinationPds	(Required) The destinationPds property key specifies the partitioned data set (PDS) on the mainframe to which a member is received.
destinationMember	(Required) The destinationMember property key specifies the member on the mainframe where the file is received.

jclExecutionUsingFile

You can use the jclExecutionUsingFile application to submit JCL from a file on the container workspace.

Click here for information about this execution step

The following table lists the jclExecutionUsingFile property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
jclDirectory	(Required) The jclDirectory property key specifies the directory on which a JCL file is located. This property key supports relative paths. If you do not enter any path or enter a period (.), this application considers the relative path with respect to the workspace by default. The following example indicates a relative path: $(Pipeline.Workspace)/s
jclFileName	(Required) The jclFileName property key specifies the JCL file on the CI\CD agent. The JCL file must be a plain text file.
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999. The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

jclExecutionUsingFreeForm

You can use the jclExecutionUsingFreeForm application to submit JCL Statements supplied for execution.

Click here for information about this execution step

The following table lists the jclExecutionUsingFreeForm property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
freeFormJcl	(Required) The freeFormJcl property key specifies the entire JCL statements to generate a JCL job for submission.
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

jclExecutionUsingPDSMember

The jclExecutionUsingPDSMember application enables you to submit JCL from a data set on the mainframe.

Click here for information about this execution step

The following table lists the jclExecutionUsingPDSMember property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
jclPds	(Required) The jclPds property key specifies the partitioned data set (PDS) on the mainframe where a member is located.
jclMemberName	(Required) The jclMemberName property key specifies the PDS member on the mainframe.
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

localCatToBaseline

The localCatToBaseline application enables you to migrate schema changes via the Local Catalog to Baseline compare type.

Click here for information about this execution step

The following table lists the localCatToBaseline property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
compare2BaselineName	(Required) The compare2BaselineName property key specifies the owner and name of a catalog baseline. It is a snapshot of object structures in the Db2 catalog. Compare2 uses these structures. These structures have the desired structure definition.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var])
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE= // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

localCatToDDL

The localCatToDDL application enables you to migrate schema changes via the Local Catalog to DDL File with DDL File as Scope compare type.

Click here for information about this execution step

The following table lists the localCatToDDL property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
compare2DdlPds	(Required) The compare2DdlPds property key specifies the data set and member that represent the objects in the catalog that have the desired structure definitions. The DDL must consist of CREATE and ALTER statements. The ALTER statements must reference the objects named in the CREATE statements.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var])
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE=${compare2DdlPds} // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

localCatToLocalCatBaselineProfileAsScope

The localCatToLocalCatBaselineProfileAsScope application enables you to migrate schema changes via the Local Catalog to local Catalog with Baseline Profile as scope compare type.

Click here for information about this execution step

The following table lists the localCatToLocalCatBaselineProfileAsScope property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
baselineProfileScopeForCompare1	(Required) The baselineProfileScopeForCompare1 property key specifies the catalog baseline profile owner and name for compare 1 input. The profile scope rules identify the objects in the Db2 catalog that are used in the comparison.
baselineProfileScopeForCompare2	(Required) The baselineProfileScopeForCompare2 property key specifies the catalog baseline profile owner and name for Compare2 input and it must reside in the local catalog subsystem. The profile scope rules identify the objects in the Compare2 Db2 catalog that are used in the comparison. The Compare2 profile has the desired structure definition.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var])
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE= // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

localCatToLocalCatMigrateProfileAsScope

The localCatToLocalCatMigrateProfileAsScope application enables you to migrate schema changes via the Local Catalog to local Catalog with Migrate Profile as scope compare type.

Click here for information about this execution step

The following table lists the localCatToLocalCatMigrateProfileAsScope property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
outboundMigrateProfileScopeForCompare1	(Required) The outboundMigrateProfileScopeForCompare1 property key specifies the profile owner and name. The profile scope rules identify the objects in the Db2 catalog that are used in the comparison.
outboundMigrateProfileScopeForCompare2	(Required) The outboundMigrateProfileScopeForCompare2 property key specifies the profile owner and name for Compare2 input and it must reside on the local catalog subsystem. The profile scope rules identify the objects in the Compare2 Db2 catalog that are used in the comparison. The Compare2 profile has the desired structure definition.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var])
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE= // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

localCatToLocalCatObjectsAsScope

You can use the localCatToLocalCatObjectsAsScope application to migrate schema changes via the Local Catalog to Local Catalog with Objects as the Scope Compare type.

Click here for information about this execution step

The following table lists the localCatToLocalCatObjectsAsScope property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
objectType	(Required) The objectType property key specifies the type of objects that a comparison includes when you select a comparison type with objects. The objectType applies to both Compare1 and Compare2 objects. Valid values are as follows: SG, DB, TS, TB, IX, VW, SY, AL, SP
objectNamePart1ForCompare1	(Required) The objectNamePart1ForCompare1 property key specifies the STOGROUP name, database name, creator, or schema. Part 1 of the object name is: STOGROUP name for storage groups. Database name for databases and table spaces. Creator or schema for all other object types. The resulting CDL is applied to these objects.
objectNamePart2ForCompare1	(Optional) The objectNamePart2ForCompare1 property key specifies the object name. Part 2 of the object name is: Blank value for storage groups and databases. Name of the object for all other object types. The resulting CDL is applied to these objects.
objectNamePart3ForCompare1	(Optional) The objectNamePart3ForCompare1 property key specifies the name of a stored procedure. The resulting CDL is applied to these objects.
objectNamePart1ForCompare2	(Required) The objectNamePart1ForCompare2 property key specifies the STOGROUP name, database name, creator, or schema. Part 1 of the object name is: STOGROUP name for storage groups. Database name for databases and table spaces. Creator or schema for all other object types. The resulting CDL is applied to these objects.
objectNamePart2ForCompare2	(Optional) The objectNamePart2ForCompare2 property key specifies the object name. Part 2 of the object name is: Blank value for storage groups and databases. Name of the object for all other object types. The resulting CDL is applied to these objects.
objectNamePart3ForCompare2	(Optional) The objectNamePart3ForCompare2 property key specifies the name of a stored procedure. The resulting CDL is applied to these objects.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key enables you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var]).
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE= // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. Default value is 2.

localCatToRemoteCatBaselineProfileAsScope

You can use the localCatToRemoteCatBaselineProfileAsScope application to migrate schema changes via the Local Catalog to Remote Catalog with Baseline Profile as the Scope compare type.

Click here for information about this execution step

The following table lists the localCatToRemoteCatBaselineProfileAsScope property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
baselineProfileScopeForCompare1	(Required) The baselineProfileScopeForCompare1 property key specifies the catalog baseline profile owner and name for compare 1 input. The profile scope rules identify the objects in the Db2 catalog that are used in the comparison.
compare2Ssid	(Required) The compare2Ssid property key specifies the Db2 subsystem ID that contains the objects with the desired structure definitions.
baselineProfileScopeForCompare2	(Required) The baselineProfileScopeForCompare2 property key specifies the catalog baseline profile owner and name for Compare2 input and it must reside in the local catalog subsystem. The profile scope rules identify the objects in the Compare2 Db2 catalog that are used in the comparison. The Compare2 profile has the desired structure definition.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var])
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE= // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime process key identifies the maximum length of time in minutes that the plug-in waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the plug-in terminates the build step and stops subsequent processing. Valid values are 1 through 60. Default value is 2.

localCatToRemoteCatMigrateProfileAsScope

The localCatToRemoteCatMigrateProfileAsScope application allows you to migrate schema changes via the Local Catalog to Remote Catalog with Outbound Migrate Profile as Scope compare type.

Click here for information about this execution step

The following table lists the localCatToRemoteCatMigrateProfileAsScope property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
outboundMigrateProfileScopeForCompare1	(Required) The outboundMigrateProfileScopeForCompare1 property key specifies the profile owner and name. The profile scope rules identify the objects in the Db2 catalog that are used in the comparison.
compare2Ssid	(Required) The compare2Ssid property key specifies the Db2 subsystem ID that contains the objects with the desired structure definitions.
outboundMigrateProfileScopeForCompare2	(Required) The outboundMigrateProfileScopeForCompare2 property key specifies the profile owner and name for Compare2 input and it must reside on the local catalog subsystem. The profile scope rules identify the objects in the Compare2 Db2 catalog that are used in the comparison. The Compare2 profile has the desired structure definition.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var])
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE= // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

localCatToRemoteCatObjectsAsScope

The localCatToRemoteCatObjectsAsScope application allows you to migrate schema changes via the Local Catalog to Remote Catalog with Objects as Scope compare type.

Click here for information about this execution step

The following table lists the localCatToRemoteCatObjectsAsScope property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
objectType	(Required) The objectType property key specifies the type of objects that a comparison includes when you select a comparison type with objects. The objectType applies to both Compare1 and Compare2 objects. Valid values are as follows: SG, DB, TS, TB, IX, VW, SY, AL, SP
objectNamePart1ForCompare1	(Required) The objectNamePart1ForCompare1 property key specifies the STOGROUP name, database name, creator, or schema. Part 1 of the object name is: STOGROUP name for storage groups. Database name for databases and table spaces. Creator or schema for all other object types. The resulting CDL is applied to these objects.
objectNamePart2ForCompare1	(Optional) The objectNamePart2ForCompare1 property key specifies the object name. Part 2 of the object name is: Blank value for storage groups and databases. Name of the object for all other object types. The resulting CDL is applied to these objects.
objectNamePart3ForCompare1	(Optional) The objectNamePart3ForCompare1 property key specifies the name of a stored procedure. The resulting CDL is applied to these objects.
compare2Ssid	(Required) The compare2Ssid property key specifies the Db2 subsystem ID that contains the objects with the desired structure definitions.
objectNamePart1ForCompare2	(Optional) The objectNamePart1ForCompare2 property key specifies the STOGROUP name, database name, creator, or schema. Part 1 of the object name is: The STOGROUP name for storage groups. The database name for databases and table spaces. The creator or schema for all other object types. The resulting CDL is applied to these objects.
objectNamePart2ForCompare2	(Optional) The objectNamePart2ForCompare2 property key specifies the object name. Part 2 of the object name is: A blank value for storage groups and databases. The name of the object for all other object types. The resulting CDL is applied to these objects.
objectNamePart3ForCompare2	(Optional) The objectNamePart3ForCompare2 property key specifies the name of a stored procedure. The resulting CDL is applied to these objects.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var])
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE= // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

localCatToWorklist

The localCatToWorklist application enables you to migrate schema changes via the Local Catalog to Migration Worklist with Worklist as Scope compare type.

Click here for information about this execution step

The following table lists the localCatToWorklist property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
compare2WorklistPds	(Required) The compare2WorklistPds property key specifies the data set and member that represent the objects in the catalog that have the desired structure definitions. The DDL must consist of CREATE and ALTER statements. The ALTER statements must reference the objects named in the CREATE statements.
useOutboundMigrateProfileBeforeComparison	(Optional) The useOutboundMigrateProfileBeforeComparison property key specifies whether to use the outbound migrate profile’s change rules, which are applied to the objects in the Compare2 scope. Valid values are as follows: true (Default) false
outboundMigrateProfileBeforeComparison	(Optional) The outboundMigrateProfileBeforeComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied to the objects in the Compare2 scope that have the desired structure definitions.
addCommentToCompare	(Optional) The addCommentToCompare property key allows adding user supplied Compare comments to the CDL file. Valid values are as follows: true (Default) false
compareCommentText	(Optional) The compareCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, $[plugin_var])
useOutboundMigrateProfileAfterComparison	(Optional) The useOutboundMigrateProfileAfterComparison property key specifies whether to use an outbound migrate profile’s change rules, which are applied to the objects in the CDL. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterComparison	(Optional) The outboundMigrateProfileAfterComparison property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after the comparison to the objects in the CDL.
cdlPds	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalCompareInputKeywords	(Optional) The additionalCompareInputKeywords field contains the additional keywords that the comparison process uses. The additional keywords will append at the end of the compare input stream. By default, this field is blank.
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE=${compare2WorklistPds} // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

useExistingCDLFile

The useExistingCDLFile application doesn’t perform a compare but uses an existing CDL file to execute requested schema changes.

Click here for information about this execution step

The following table lists the useExistingCDLFile property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID of the destination where schema changes are applied.
workIdOwner	(Required) The workIdOwner property key specifies the first part of the name of the unit of work (work ID) that contains change requests. The owner is the creator of the work ID.
workIdName	(Required) The workIdName property key specifies the second part of the name of the unit of work (work ID) that contains change requests. The name is a string that can contain 18 or fewer alphanumeric or special characters, except for percent (%), asterisk (*), underscore (_), and space ( ).
addCommentToWorkId	(Optional) The addCommentToWorkId property key allows adding user supplied Work ID comments to the WORKID. If defined, comments will display on the WORKID list panel from BMC AMI Change Manager and will be placed in the Worklist. Valid values are as follows: true (Default) false
workIdCommentText	(Optional) The workIdCommentText property key allows you to enter any comment text up to 254 bytes. You can specify Azure variables or plug-in variables as part of the comment (f or example, RUNBY_VALUE or $[plugin_var])
	(Required) The cdlPds property key specifies the partitioned data set (PDS) and member that contains the output from a Compare, which are the CDL schema changes, and is used as the input file for Import. If you are using this step to roll back changes implemented by another step, enter the cdlPdsRollback property key that you specified for the other step.
useInboundMigrateProfile	(Optional) The useInboundMigrateProfile property key specifies whether to use the inbound migrate profile's change rules. Valid values are as follows: true (Default) false
inboundMigrateProfile	(Optional) The inboundMigrateProfile property key specifies the two-part name (owner.name) of the profile that contains change rules. The change rules are applied when the resulting CDL is imported and processed.
worklistPds	(Required) The worklistPds property key specifies the partitioned data set (PDS) and member that contains the worklist of DDL schema changes that Analysis generates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
impactReportPds	(Optional) The impactReportPds property key specifies the partitioned data set (PDS) and member that contains the impact report that Analysis creates. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the impact report for rollback schema changes.
executionJclPds	(Required) The executionJclPds property key specifies the partitioned data set (PDS) and member that contains the execution JCL that JCL Generation creates. This JCL runs the worklist that applies schema changes. If you are using this step to roll back changes implemented by another step, enter the PDS and member of the execution JCL for rollback schema changes.
preExecutionBaselineType	(Optional) The preExecutionBaselineType property key specifies whether to create a baseline before applying schema changes. Specifies one of the following types: (Default) none: Does not create any baseline preExec : The Pre-Execution Baseline specifies whether to create an additional step in the Execution JCL, which creates a baseline before applying schema changes. Keywords are added to AJXIN DD. full : The Full-Recovery Baseline enables the worklist to create a baseline tied to the work ID, which you can use later for recovery.
preExecutionBaselineProfileName	(Optional) The preExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile that contains scope rules. The profile scope rules identify the objects in the Db2 catalog that are used to create a baseline before applying the resulting schema changes.
preExecutionBaselineName	(Optional) The preExecutionBaselineName property key specifies the name of the baseline to create before applying schema changes.
generateCdlRollbackSchemaChanges	(Optional) The generateCdlRollbackSchemaChanges property key creates an additional step in the Execution JCL. This step compares the Db2 catalog to the baseline (before execution) to generate the CDL that the rollback needs. Valid values are as follows: true (Default) false
cdlPdsRollback	(Optional) The cdlPdsRollback property key specifies the partitioned data set and member on the mainframe that contains CDL because of the rollback compare.
createPostExecutionBaseline	(Optional) The createPostExecutionBaseline property key creates an additional step in the Execution JCL. This step creates a baseline after applying schema changes. Valid values are as follows: true (Default) false
postExecutionBaselineProfileName	(Optional) The postExecutionBaselineProfileName property key specifies the two-part name (owner.name) of the profile used to create a baseline after applying schema changes.
postExecutionBaselineName	(Optional) The postExecutionBaselineName property key specifies the name of the baseline created after applying schema changes.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). A sample jobcard follows, definition will vary based on site requirements: //DEVOPS JOB ($[acctno]),'COMPARE', // CLASS=A,MSGLEVEL=(1,1) //*
additionalImportInputKeywords	(Optional) The additionalImportInputKeywords field contains the additional keywords that the import process uses. The additional keywords will append at the end of the import input stream. By default, this field is blank.
additionalAnalysisInputKeywords	(Optional) The additionalAnalysisInputKeywords field contains the additional keywords that the analysis process uses. The additional keywords will append at the end of the analysis input stream. By default, this field is blank.
additionalJclGenerationInputKeywords	(Optional) The additionalJclGenerationInputKeywords field contains the additional keywords that the JCL generation process uses. The additional keywords will append at the end of the JCL generation input stream. By default, this field is blank.
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default values are as follows: ${jobCard} //* // JCLLIB ORDER=($[proclib]) //* //JOBLIB DD DSN=$[joblib1],DISP=SHR // DD DSN=$[joblib2],DISP=SHR // DD DSN=$[dsnexit],DISP=SHR // DD DSN=$[dsnload],DISP=SHR //************************************************* // SET ACMDOPT=$[dopts] // SET RTEHLQ=$[rtehlq] // SET USRHLQ=$[usrhlq] //************************************************* // SET DDLFILE= // SET CDLFILE=${cdlPds} // SET WORKLIST=${worklistPds} // SET EXECJCL=${executionJclPds} // SET IMPRPT=${impactReportPds} //* // SET POFFILE=$[pofdsn] //---------------------------------------------------- // BMC CHANGE MANAGER COMPARE //---------------------------------------------------- ${Compare Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER IMPORT //---------------------------------------------------- //IMPORT EXEC AMAPROCI, // COND=${BMC_COMPARE_COND_CODE} //IMPORT.IMPORTIN DD DISP=SHR, // DSN=&CDLFILE ${Import Input Stream} //---------------------------------------------------- //* BMC CHANGE MANAGER ANALYSIS //---------------------------------------------------- //ANALYSIS EXEC AMAPROCA, // COND=${BMC_COMPARE_COND_CODE} ${Analysis Input Stream} //---------------------------------------------------- //* BMC JCL GENERATION //*---------------------------------------------------- //JCLGEN EXEC AMAPROCJ, // COND=${BMC_COMPARE_COND_CODE} ${JCL Generation Input Stream}
acceptableReturnCode	(Required) The acceptableReturnCode property key specifies the maximum return code value that communicates that the submitted job was successful. You must specify the acceptable return code as a four-digit number (for example, 0000, 0004, 0008, or 0012). If the return code from the mainframe server is less than or equal to the acceptable return code, the application continues processing additional steps. If the return code from the mainframe server is greater than the acceptable return code, the application prevents processing additional steps. Valid values are 0000 through 9999.The default value is 0004.
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

outputTransmission

The outputTransmission application enables you to download any or all of the generated artifacts (CDL file, worklist, impact report, and execution JCL) to the container workspace. You must enter the source PDS name for at least one artifact.

Click here for information about this execution step

The following table lists the outputTransmission property keys:

Important

You must enter the source PDS name for at least one artifact.

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
cdlSourcePds	(Required) The cdlSourcePds property key specifies the partitioned data set (PDS) on the mainframe from which a CDL member is transferred.
worklistSourcePds	(Required) The worklistSourcePds property key specifies the partitioned data set (PDS) on the mainframe from which a WORKLIST member is transferred.
execJclSourcePds	(Required) The execJclSourcePds property key specifies the partitioned data set (PDS) on the mainframe from which a EXEC_JCL member is transferred.
impactReportSourcePds	(Required) The impactReportSourcePds property key specifies the partitioned data set (PDS) on the mainframe from which a IMPACT REPORT member is transferred.
sourceMemberName	(Required) The sourceMemberName property key specifies the member on the mainframe that is transferred.
destinationDirectory	(Required) The destinationDirectory property key specifies the directory to which a file is received. This property key supports relative paths. If you do not enter any path or enter a period (.), this application considers the relative path with respect to the workspace. There can be 2 types of values for destinationDirectory. Current working directory i.e., workspace directory - value should be (.). Since the workspace directory exists, the user doesn't need to create it. Other directory - value should be absolute path or the name of the directory only and it must exist at the time of the step execution. Write access must be granted to the agent process which is running the pipeline or workflow. Full path example: /home/reports/output To use the /output directory name, you must map the directory with a volume mount option (-v) in your pipeline or workflow, for example: resources: containers: - container: bmc-container image:attach:xwiki:Mainframe.Data-for-Db2.BMC-AMI-DevOps-for-Db2.AMA13100.Using.Using-BMC-AMI-DevOps-with-Universal-Connector.Creating-a-configuration-file.WebHome@filename <image name> options: -u root -v "/home/reports/output":"/output"
destinationFileName	(Optional) The destinationFileName property key specifies the file name to create in the agent workspace directory. This property key is always saved in the agent workspace directory. The file names of the corresponding files in the destinationDirectory are automatically appended with a _CDL.txt, _WL.txt, _EXEC.txt, or _IR.txt suffix and file type.

schemaStandards

The schema standards application enables you to analyze schema based on schema rules defined and managed via the BMC AMI Command Center for Db2 product.

Important

The minimum version number required for schemaStandards is 3.0.0. The version is specified at the top of the config YAML file.

Click here for information about this execution step

The following table lists the schemaStandards property keys:

Property key	Description
- stepName	(Required) The stepName property key specifies a user-defined step name for the application process. This stepName is then referenced in the pipeline or workflow YAML file.
debugMode	(Optional) The debugMode property key specifies whether this step should issue additional messages in the Console Output log file. Valid values are as follows: true (Default) false
generateJclOnly	(Optional) The generateJclOnly property key controls whether the build step JCL is generated without running the step. Use this feature to validate the JCL from the Console Output log. Valid values are as follows: true (Default) false
ssid	(Required) The ssid property key specifies the Db2 subsystem ID where the Schema Standards analysis will be performed and the rule sets reside.
ruleSetName	(Required) The ruleSetName property key specifies the rule set to be used for Schema Standards analysis of the schema source. Important The Schema Standards rule sets and rules are defined and managed via the product. For more information, see Managing schema rule sets
violationResponse	(Required) The violationResponse property key specifies how the application reacts if it encounters a rule violation. Valid values are as follows: (Default) Fail (Fail causes a rule violation to fail the application step) Warn (Warn prevents the application step from failing if a violation is encountered)
schemaType	(Required) The schemaType property key specifies the schema source option that Schema Standards uses for analysis. Valid values are as follows: (Default) DDL CDL migrateWorklist catalogMigrateProfileScope catalogBaselineProfileScope
inputSchemaSource	(Required) The inputSchemaSource property key specifies the value for the schema source. Important The value for the inputSchemaSource depends on the option you selected in the schemaType property key: When using DDL, CDL, or migrateWorklist in schemaType, specify the partitioned data set (PDS) name and member which contains the DDL, CDL, or Migrate Worklist that Schema Standards analyzes. When using catalogMigrateProfileScope or catalogBaselineProfileScope in schemaType, specify the two-part name (owner.name) of the profile that contains the scope rules to identify the objects in the Db2 catalog that Schema Standards analyzes.
useOutboundMigrateProfileAfterRead	(Optional) The useOutboundMigrateProfileAfterRead property key specifies whether to use the outbound migrate profile’s change rules for the Schema Standards analysis of the inputSchemaSource. Valid values are as follows: true (Default) false
outboundMigrateProfileAfterRead	(Optional) The outboundMigrateProfileAfterRead property key specifies the two-part name (owner.name) of the profile that contains change rules for object names. The migrate profile must contain change rules for object names (parts 1, 2, and 3). The change rules are applied after objects are read to ensure structure definitions are as per naming standards.
jobCard	(Required) The jobCard property key specifies the JOB statement and additional information in the mainframe JCL. This statement provides the job name, account number, and any keyword parameters (such as CLASS, MSGCLASS, REGION, or TIME). The default values are as follows: //AMASTDS JOB (#acctno#),'SCHEMA STANDARDS', // CLASS=A,MSGLEVEL=(1,1) //*
schemaStandardsInputStream	(Required) The schemaStandardsInputStream property key contains the DD names, parameters, and option override values that the Schema Standards analysis uses. The default values are as follows: Click here for schemaType: DDL schemaStandardsInputStream: \| //SCHEMAS.AMAIN DD DISP=SHR, // DSN=${inputSchemaSource} //SCHEMAS.ALUIN DD ,SYMBOLS=JCLONLY SSID &SSID SOURCETYPE DDL RULESET (&RULESET) LOGMODE &LOGMODE VTIBUCKETSIZE &VTIBSZ Click here for schemaType: CDL schemaStandardsInputStream: \| //SCHEMAS.AMAIN DD DISP=SHR, // DSN=${inputSchemaSource} //SCHEMAS.ALUIN DD ,SYMBOLS=JCLONLY SSID &SSID SOURCETYPE CDL RULESET (&RULESET) LOGMODE &LOGMODE VTIBUCKETSIZE &VTIBSZ Click here for schemaType: migrateWorklist schemaStandardsInputStream: \| //SCHEMAS.AMAIN DD DISP=SHR, // DSN=${inputSchemaSource} //SCHEMAS.ALUIN DD ,SYMBOLS=JCLONLY SSID &SSID SOURCETYPE WORKLIST RULESET (&RULESET) LOGMODE &LOGMODE VTIBUCKETSIZE &VTIBSZ Click here for schemaType: catalogMigrateProfileSource schemaStandardsInputStream: \| //SCHEMAS.ALUIN DD ,SYMBOLS=JCLONLY SSID &SSID SOURCETYPE CATALOG MIGPROFILE ${inputSchemaSource} RULESET (&RULESET) LOGMODE &LOGMODE VTIBUCKETSIZE &VTIBSZ Click here for schemaType: catalogBaselineProfileSource schemaStandardsInputStream: \| //SCHEMAS.ALUIN DD *,SYMBOLS=JCLONLY SSID &SSID SOURCETYPE CATALOG BLPROFILE ${inputSchemaSource} RULESET (&RULESET) LOGMODE &LOGMODE VTIBUCKETSIZE &VTIBSZ
debugInputStream	(Required) The debugInputStream property key contains the DDs for debugging Schema Standards analysis. The default value is as follows: //********************************************************************** //* The DDs below are used for debugging of Schema Standards //********************************************************************** //* $$XMLOUT$$ contains the objects that will be processed //SCHEMAS.$$XMLOUT$$ DD SYSOUT= //* $$RULETRE contains the rules that will run against the objects //SCHEMAS.$$RULETRE DD SYSOUT= //* $$VTIRULE contains the VTI rules that were tested //SCHEMAS.$$VTIRULE DD SYSOUT= //* //**********************************************************************
jcl	(Required) The jcl property key contains the statements that BMC AMI Change Manager for Db2 needs to perform a comparison, import the resulting CDL, analyze a worklist, and generate execution JCL. The default value is as follows: ${Job Card} //* // JCLLIB ORDER=(#proclib#) //* //JOBLIB DD DISP=SHR, // DSN=#joblib1# // DD DISP=SHR, // DSN=#joblib2# // DD DISP=SHR, // DSN=#dsnexit# // DD DISP=SHR, // DSN=#dsnload# //* // EXPORT SYMLIST=() // // SET SSID=${SSID} // SET GUDPLAN=#gudplan# // SET RULESET='${Schema Standards Rule Set name}' // SET LOGMODE=${Violation Response} // SET VTIBSZ=20 //********************************************************************** //SCHSTDS EXEC AMAPROCS ${schemaStandardsInputStream} ${debugInputStream}
maxJobWaitTime	(Required) The maxJobWaitTime property key specifies the maximum length of time in minutes that the application waits for job completion from the mainframe. If the time for the response exceeds the maximum job wait time, the application terminates the build step and stops subsequent processing. Valid values are 1 through 60. The default value is 2.

Creating a configuration file

Before you begin

To create a configuration (Config YAML) file

Config YAML file for Universal Connector application

authentication

fileDownload

fileUpload

jclExecutionUsingFile

jclExecutionUsingFreeForm

jclExecutionUsingPDSMember

localCatToBaseline

localCatToDDL

localCatToLocalCatBaselineProfileAsScope

localCatToLocalCatMigrateProfileAsScope

localCatToLocalCatObjectsAsScope

localCatToRemoteCatBaselineProfileAsScope

localCatToRemoteCatMigrateProfileAsScope

localCatToRemoteCatObjectsAsScope

localCatToWorklist

useExistingCDLFile

outputTransmission

schemaStandards

On this page