(SPE2101)
This topic describes how to configure a component process:
Before you begin
Perform the procedures described in the following topics:
Use the following procedure to configure the component process to migrate schema changes across the z/OS environment.
Tip
You can also update the configuration in the sample component process provided by BMC. For more information, see Using the configuration provided in the sample component process.
- From the UrbanCode Deploy/HCL Launch web console:
- Click Components tab from the product toolbar.
- Select your component.
- From your component's dashboard, click Processes.
- Select the process that you want to configure.
From the process editor, click BMC to expand the plug-in drawer.
Important
The BMC plug-in drawer has two plug-ins:
BMC AMI DevOps has eight main process steps and two supporting process steps.
The eight main process steps are:
- ommon - File Transmission
- BMC AMI DevOps Schema Migration - Output Transmission
- BMC AMI DevOpsSchema Migration - Schema Mig: Cat to Cat Baseline Profile as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Migrate Profile as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Objects as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to DDL-WL-BL
- BMC AMI DevOps Schema Migration - Schema Mig: Use Existing CDL File
- ommon - JCL Execution
The two supporting process steps are:
- Common - Authentication
- BMC AMI DevOps Common - Clean Up
When configuring component processes, if you add one or more main process steps, you must also add both the supporting process steps. You must add BMC AMI DevOps Common - Authentication as the first process step and BMC AMI DevOps Common - Clean Up as the last process step. For more information, see Examples of how to add process steps during component process configuration.
Drag and drop the process steps from BMC AMI DevOps Common and BMC AMI DevOps Schema Migration plug-in drawers to the component process editor:
Important
- To enter your mainframe password when executing the component process:
- Select the Provide Password via Property Parameter check box.
- Specify a property-based variable as the value of the Mainframe Password via Property Parameter field. For example, specify ${p:MF_PW}, where MF_PW is a Password Property variable, as the value of this field.
When configuring the component process, you can disable processing for one or more process steps except:
- BMC AMI DevOps Common - Authentication
- BMC AMI DevOps Common - Clean Up
For example, you can disable the BMC AMI DevOps Common - File Transmission process step when you are performing a comparison between two local catalogs. To enable this feature, select the Disable Step check box.
When configuring the component process, you can omit the step processing if the previous compare step found no differences. This can be defined for one or more plug-in steps except:
- BMC AMI DevOps Common - Authentication
- BMC AMI DevOps Common - Clean Up
The Skip Step if Previous Compare Found No Differences check box is selected by default.
Note
If the previous Schema Migration step does not perform a compare, the current step automatically runs.
- You can run any or all process steps in Debug mode. For more information, see To run process steps in Debug mode.
- To generate JCL but not execute it, you can select the Generate JCL Only check box in the BMC AMI DevOps Schema Migration process step. For example, you can use this feature to validate the JCL before submitting it. The generated JCL is saved to the working directory folder. If you select this option, you must also disable the subsequent process steps.
For any of the following fields, if you do not enter any path or enter the relative path, BMC AMI DevOps considers the default path of the working directory folder.
| |
|---|
BMC AMI DevOps Common - Authentication | Plug-in Variables File Path |
BMC AMI DevOps Common - File Transmission | Source PDS or Directory Name |
BMC AMI DevOps Common - File Transmission | Destination PDS or Directory Name |
BMC AMI DevOps Schema Migration - Output Transmission | Destination Directory Name |
BMC AMI DevOps Common - JCL Execution | Execution JCL PDS or Directory Name |
For more information about the default path, see Default-path-for-component-processes-when-relative-path-is-specified-for-a-field
BMC AMI DevOpsCommon - Authentication
Click here for information about configuring this process step
- To edit the step properties, click
. Enter values for the following fields:
Mainframe (host name or IP address)
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.
Port Number
Important
Ensure that you enter the corresponding port number of the LPAR in the SYSPLEX on which z/OSMF is running on the mainframe.
Mainframe User ID
Important
The mainframe server login process requires a user ID and password for security authentication. The Mainframe User ID field value is used in JCL for job submission.
- Mainframe Password option
Select one of the following options:- Mainframe Password via Property Parameter
- Mainframe Password
- Mainframe Password via Property Parameter
Select this option if you want to enter your mainframe password when executing the process. If you select this option, you must enter a parameter as the value for the Mainframe Password via Property Parameter field. - Mainframe Password
If you do not select the Mainframe Password via Property Parameter option, enter your mainframe password in this field. Plug-in Variables File Path
Important
The plug-in variables file defines the variables and values that the plug-in uses.
- AMI_DevOps.properties is the default name of the plug-in variables file. Your plug-in variables file can have any name but it must be a .properties file
- The Plug-in Variables File Path field supports relative paths. This plug-in considers the relative path with respect to the current working directory.
You can also enter a Property-based variable in the Plug-in Variables File Path field. You can specify any of the following values for the variable:
- The full plug-in variables file path, including the file name
- Part of the plug-in variables file path
- The plug-in variables file name
See the following examples:
Example 1
When configuring the component process, you have added a Property-based variable with the following field values:
| | |
|---|
| | |
| The value of this variable is the full plug-in variables file path, including the file name. | |
| | |
| | |
| | |
| | |
| /var/lib/AMA_Properties/AMI_DevOps.properties | |
You can then enter ${p?:var.prop} in the Plug-in Variables File Path field.
Example 2
When configuring the component process, you have added a Property-based variable with the following field values:
| | |
|---|
| | |
| The value of this variable is part of the plug-in variables file path and does not include the file name. | |
| | |
| | |
| | |
| | |
| | |
You can then enter ${p?:var.path}/AMI_DevOps.properties in the Plug-in Variables File Path field.
Example 3
When configuring the component process, you have added a Property-based variable with the following field values:
| | |
|---|
| | |
| The value of this variable is the plug-in variables file name and does not include the file path. | |
| | |
| | |
| | |
| | |
| | |
You can then enter /var/lib/AMA_Properties/${p?:var.file} in the Plug-in Variables File Path field.
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify one of the hidden properties of the plug-in step.- AMI DevOps Debug Mode
Execution Identifier (Internal use only)
Important
Ensure that you don't modify the default value for this field.
- Click the OK button to save the process step.
BMC AMI DevOps ommon - File Transmission
Click here for information about configuring this process step
- To edit the step properties, click .
- Enter values for the following fields:
Direction of File Transfer
Select one of the following options:
- Send file to mainframe
- Receive file from mainframe
Important
The Direction of File Transfer field specifies the direction in which files or PDS members are transferred. Select one of the following:
- Send file to mainframe: Select this to transfer a file from the agent to the mainframe.
- Receive file from mainframe: Select this to transfer a PDS member from the mainframe to the agent.
Source PDS or Directory Name
Important
The source PDS or directory name can be the client DDL file directory or the PDS for the CDL, worklist or execution JCL. The Source PDS or Directory Name field supports relative paths. If you do not enter any path or enter a period (.), this plug-in considers the relative path with respect to the default working directory.
The following example indicates a relative path:
Example
${p:resource/work.dir}/${p:component.name}
Source Member or File Name
Important
The source member or file name might be the client DDL file or the PDS member for the CDL, worklist or execution JCL. The source member or file must be a plain text file.
Destination PDS or Directory Name
Important
The destination PDS or directory name might be a DDL PDS or a client directory for the CDL, worklist or execution JCL. The Destination PDS or Directory Name field supports relative paths. If you do not enter any path or enter a period (.), this plug-in considers the relative path with respect to the default working directory.
The following example indicates a relative path:
Example
${p:resource/work.dir}/${p:component.name}
Destination Member or File Name
Important
The destination member or file name might be a DDL PDS member or the client file for the CDL, worklist or execution JCL. The destination member or file must be a plain text file.
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Baseline Profile as Scope
Click here for information about configuring this process step
- To edit the step properties, click .
- Enter values for the following fields:
- SSID
- Work ID Owner
- Work ID Name
Comparison Type
Select one of the following options:
- Local Catalog to Local Catalog with Baseline Profile as Scope
- Local Catalog to Remote Catalog with Baseline Profile as Scope
Important
You can select an option from the list of allowed comparisons. The name of the comparison type also includes the schema location for Compare1 and Compare2. The first location represents Compare1, where the resulting CDL is applied. The second location represents Compare2, where the objects already have the desired structure definitions.
For more information about the types of comparisons that you can perform using the product, see the BMC AMI Change Manager for Db2.
- Enter values for the fields in the following sections. Depending on the comparison type you selected, some of the fields are optional:
- Compare1 Baseline Profile (SCOPE1)
Compare2 Catalog (SSID)
Important
Input required only for Local Catalog to Remote Catalog with Baseline Profile as Scope.
- Compare2 Baseline Profile (SCOPE2)
If you select the Use Outbound Migrate Profile (applied before comparison) check box, enter a value for the Outbound Migrate Profile (applied before comparison) field.
Important
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.
If you select the Use Outbound Migrate Profile (applied after comparison) check box, enter a value for the Outbound Migrate Profile (applied after comparison) field.
Important
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.
- CDL PDS and Member Name
- If you select the Use Inbound Migrate Profile check box, enter a value for the Inbound Migrate Profile field.
- Worklist PDS and Member Name
- (Optional) Impact Report PDS and Member Name
- Execution JCL PDS and Member Name
Select one of the following options in the Select Baseline Type Before Execution field:
- None: Does not create any baseline.
- Pre-Execution Baseline: Specifies whether an additional step in the Execution JCL is created which creates a baseline before applying schema changes. Keywords added to AJXIN DD.
- Full-Recovery Baseline: The worklist creates a baseline tied to the work ID, which you can use later for recovery.
For more information about recovering from these baselines, see the BMC AMI Change Manager for Db2.
- If you are creating a Pre-Execution or Full-Recovery Baseline, enter values for the following fields:
Baseline Profile Name (before execution)
Important
The scope rules previously defined the set of objects used during the comparison. The scope rules now create a baseline before applying the resulting schema changes.
- Baseline Name (before execution)
If you select the Generate CDL to Rollback Schema Changes check box, enter a value for the Rollback PDS and Member Name (CDL) field.
Important
Generate CDL to Rollback Schema Changes check box is applicable when you select either the Pre-Execution Baseline or the Full-Recovery Baseline option in the Select Baseline Type Before Execution field.
- If you select the Create Baseline After Execution check box, enter values for the following fields:
- Baseline Profile Name (after execution)
- Baseline Name (after execution)
- Job Card
Additional Compare Input Keywords
Important
See the following examples:
Example 1
When the comparison type is Local Catalog to Local Catalog with Baseline Profile as scope and Additional Compare Input Keywords field is blank. The generated compare input stream will be:
//*Compare Input
//COMPARE1 EXEC AMAPROCC,
// COND=(1,LT)
//COMPARE.CDL001 DD DISP=SHR,
// DSN=&CDLFILE
//COMPARE.CMPIN2 DD DISP=SHR,
// DSN=&DDLFILE
//COMPARE.ALUIN DD *
SSID ${SSID}
CMPTYPE1 LOCAL
CMPTYPE2 LOCAL
SCOPETYPE PROFILES:BASELINE,BASELINE
SCOPE1 ${Compare1 Baseline Profile (SCOPE1)}
SCOPE2 ${Compare2 Baseline Profile (SCOPE2)}
INCLUDE (ALTER CREATE DROP )
REPORT (DETAIL )
Example 2
When the comparison type is Local Catalog to Local Catalog with Baseline Profile as scope and the additional keywords added in Additional Compare Input Keywords field are as below:
NOSYNONYM
NOALIAS
NODEFINE
The generated compare input stream will be:
//*Compare Input
//COMPARE1 EXEC AMAPROCC,
// COND=(1,LT)
//COMPARE.CDL001 DD DISP=SHR,
// DSN=&CDLFILE
//COMPARE.CMPIN2 DD DISP=SHR,
// DSN=&DDLFILE
//COMPARE.ALUIN DD *
SSID ${SSID}
CMPTYPE1 LOCAL
CMPTYPE2 LOCAL
SCOPETYPE PROFILES:BASELINE,BASELINE
SCOPE1 ${Compare1 Baseline Profile (SCOPE1)}
SCOPE2 ${Compare2 Baseline Profile (SCOPE2)}
INCLUDE (ALTER CREATE DROP )
REPORT (DETAIL )
NOSYNONYM
NOALIAS
NODEFINE
- Additional Import Input Keywords
- Additional Analysis Input Keywords
- Additional JCL Generation Input Keywords
- JCL
Acceptable Return Code
Important
- If the return code from the mainframe server is less than or equal to the acceptable return code, the plug-in continues processing additional process steps.
- If the return code from the mainframe server is greater than the acceptable return code, the plug-in prevents processing additional process steps.
- The return code 0001 is a result of no differences found in a comparison.
Maximum Job Wait Time
Important
If the time for the response exceeds the maximum job wait time, the plug-in terminates the process step and stops subsequent processing.
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Migrate Profile as Scope
Click here for information about configuring this process step
- To edit the step properties, click .
- Enter values for the following fields:
- SSID
- Work ID Owner
- Work ID Name
Comparison Type
Select one of the following options:
- Local Catalog to Local Catalog with Outbound Migrate Profile as Scope
- Local Catalog to Remote Catalog with Outbound Migrate Profile as Scope
Important
You can select an option from the list of allowed comparisons. The name of the comparison type also includes the schema location for Compare1 and Compare2. The first location represents Compare1, where the resulting CDL is applied. The second location represents Compare2, where the objects already have the desired structure definitions.
For more information about the types of comparisons that you can perform using the product, see the BMC AMI Change Manager for Db2.
- Enter values for the fields in the following sections. Depending on the comparison type you selected, some of the fields are optional:
- Compare1 Outbound Migrate Profile (SCOPE1)
Compare2 Catalog (SSID)
Important
Input required only for Local Catalog to Remote Catalog with Outbound Migrate Profile as Scope.
- Compare2 Outbound Migrate Profile (SCOPE2)
If you select the Use Outbound Migrate Profile (applied before comparison) check box, enter a value for the Outbound Migrate Profile (applied before comparison) field.
Important
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.
If you select the Use Outbound Migrate Profile (applied after comparison) check box, enter a value for the Outbound Migrate Profile (applied after comparison) field.
Important
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.
- CDL PDS and Member Name
- If you select the Use Inbound Migrate Profile check box, enter a value for the Inbound Migrate Profile field.
- Worklist PDS and Member Name
- (Optional) Impact Report PDS and Member Name
- Execution JCL PDS and Member Name
- Select one of the following options in the Select Baseline Type Before Execution field:
- None: Does not create any baseline.
- Pre-Execution Baseline: Specifies whether an additional step in the Execution JCL is created which creates a baseline before applying schema changes. Keywords added to AJXIN DD.
Full-Recovery Baseline: The worklist creates a baseline tied to the work ID, which you can use later for recovery.
For more information about recovering from these baselines, see the BMC AMI Change Manager for Db2.
- If you are creating a Pre-Execution or Full-Recovery Baseline, enter values for the following fields:
Baseline Profile Name (before execution)
Important
The scope rules previously defined the set of objects used during the comparison. The scope rules now create a baseline before applying the resulting schema changes.
- Baseline Name (before execution)
If you select the Generate CDL to Rollback Schema Changes check box, enter a value for the Rollback PDS and Member Name (CDL) field.
Important
Generate CDL to Rollback Schema Changes check box is applicable when you select either the Pre-Execution Baseline or the Full-Recovery Baseline option in the Select Baseline Type Before Execution field.
- If you select the Create Baseline After Execution check box, enter values for the following fields:
- Baseline Profile Name (after execution)
- Baseline Name (after execution)
- Job Card
Additional Compare Input Keywords
Important
See the following examples:
Example 1
When the comparison type is Local Catalog to Local Catalog with Outbound Migrate Profile as scope and Additional Compare Input Keywords field is blank. The generated compare input stream will be:
//*Compare Input
//COMPARE1 EXEC AMAPROCC,
// COND=(1,LT)
//COMPARE.CDL001 DD DISP=SHR,
// DSN=&CDLFILE
//COMPARE.CMPIN2 DD DISP=SHR,
// DSN=&DDLFILE
//COMPARE.ALUIN DD *
SSID ${SSID}
CMPTYPE1 LOCAL
CMPTYPE2 LOCAL
SCOPETYPE PROFILES:MIGRATE,MIGRATE
SCOPE1 ${Compare1 Outbound Migrate Profile (SCOPE1)}
SCOPE2 ${Compare2 Outbound Migrate Profile (SCOPE2)}
INCLUDE (ALTER CREATE DROP )
REPORT (DETAIL )
Example 2
When the comparison type is Local Catalog to Local Catalog with Outbound Migrate Profile as scope and the additional keywords added in Additional Compare Input Keywords field are as below:
NOSYNONYM
NOALIAS
NODEFINE
The generated compare input stream will be:
//*Compare Input
//COMPARE1 EXEC AMAPROCC,
// COND=(1,LT)
//COMPARE.CDL001 DD DISP=SHR,
// DSN=&CDLFILE
//COMPARE.CMPIN2 DD DISP=SHR,
// DSN=&DDLFILE
//COMPARE.ALUIN DD *
SSID ${SSID}
CMPTYPE1 LOCAL
CMPTYPE2 LOCAL
SCOPETYPE PROFILES:MIGRATE,MIGRATE
SCOPE1 ${Compare1 Outbound Migrate Profile (SCOPE1)}
SCOPE2 ${Compare2 Outbound Migrate Profile (SCOPE2)}
INCLUDE (ALTER CREATE DROP )
REPORT (DETAIL )
NOSYNONYM
NOALIAS
NODEFINE
- Additional Import Input Keywords
- Additional Analysis Input Keywords
- Additional JCL Generation Input Keywords
- JCL
Acceptable Return Code
Important
- If the return code from the mainframe server is less than or equal to the acceptable return code, the plug-in continues processing additional process steps.
- If the return code from the mainframe server is greater than the acceptable return code, the plug-in prevents processing additional process steps.
- The return code 0001 is a result of no differences found in a comparison.
Maximum Job Wait Time
Important
If the time for the response exceeds the maximum job wait time, the plug-in terminates the process step and stops subsequent processing.
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Objects as Scope
Click here for information about configuring this process step
- To edit the step properties, click .
- Enter values for the following fields:
- SSID
- Work ID Owner
- Work ID Name
- Comparison Type
Select one of the following options:
- Local Catalog to Local Catalog with Objects as Scope
Local Catalog to Remote Catalog with Objects as Scope
Important
You can select an option from the list of allowed comparisons. The name of the comparison type also includes the schema location for Compare1 and Compare2. The first location represents Compare1, where the resulting CDL is applied. The second location represents Compare2, where the objects already have the desired structure definitions.
Object Type (applies to Compare1 and Compare2)
Important
Select one of the following values in the Object Type (applies to Compare1 and Compare2) field:
Object Name Part 1 for Compare1
Important
Object names for Part 1 are:
- 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.
Object Name Part 2 for Compare1
Important
Object names for Part 2 are:
- Blank value for storage groups and databases
- Name of the object for all other object types
The resulting CDL is applied to these objects.
Object Name Part 3 for Compare1
Important
Object names for Part 3 are:
- Name for stored procedures
The resulting CDL is applied to these objects.
Compare2 Catalog (SSID)
Important
Input required only for Local Catalog to Remote Catalog with Objects as Scope.
Object Name Part 1 for Compare2
Important
Object names for Part 1 are:
- STOGROUP name for storage groups
- Database name for databases and table spaces
- Creator or schema for all other object types
Object Name Part 2 for Compare2
Important
Object names for Part 2 are:
- Blank value for storage groups and databases
- Name of the object for all other object types
Object Name Part 3 for Compare2
Important
Object names for Part 3 are:
- Name for stored procedures
If you select the Use Outbound Migrate Profile (applied before comparison) check box, enter a value for the Outbound Migrate Profile (applied before comparison) field.
Important
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.
If you select the Use Outbound Migrate Profile (applied after comparison) check box, enter a value for the Outbound Migrate Profile (applied after comparison) field.
Important
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.
- CDL PDS and Member Name
- If you select the Use Inbound Migrate Profile check box, enter a value for the Inbound Migrate Profile field.
- Worklist PDS and Member Name
- (Optional) Impact Report PDS and Member Name
- Execution JCL PDS and Member Name
- Select one of the following options in the Select Baseline Type Before Execution field:
- None: Does not create any baseline.
- Pre-Execution Baseline: Specifies whether an additional step in the Execution JCL is created which creates a baseline before applying schema changes. Keywords added to AJXIN DD.
Full-Recovery Baseline: The worklist creates a baseline tied to the work ID, which you can use later for recovery.
For more information about recovering from these baselines, see the BMC AMI Change Manager for Db2.
- If you are creating a Pre-Execution or Full-Recovery Baseline, enter values for the following fields:
Baseline Profile Name (before execution)
Important
The scope rules previously defined the set of objects used during the comparison. The scope rules now create a baseline before applying the resulting schema changes.
- Baseline Name (before execution)
If you select the Generate CDL to Rollback Schema Changes check box, enter a value for the Rollback PDS and Member Name (CDL) field.
Important
Generate CDL to Rollback Schema Changes check box is applicable when you select either the Pre-Execution Baseline or the Full-Recovery Baseline option in the Select Baseline Type Before Execution field.
- If you select the Create Baseline After Execution check box, enter values for the following fields:
- Baseline Profile Name (after execution)
- Baseline Name (after execution)
- Job Card
Additional Compare Input Keywords
Important
See the following examples:
Example 1
When the comparison type is Local Catalog to Local Catalog with Object as scope and Additional Compare Input Keywords field is blank. The generated compare input stream will be:
//*Compare Input
//COMPARE1 EXEC AMAPROCC,
// COND=(1,LT)
//COMPARE.CDL001 DD DISP=SHR,
// DSN=&CDLFILE
//COMPARE.CMPIN2 DD DISP=SHR,
// DSN=&DDLFILE
//COMPARE.ALUIN DD *
SSID ${SSID}
CMPTYPE1 LOCAL
CMPTYPE2 LOCAL
INCLUDE (ALTER CREATE DROP )
REPORT (DETAIL )
SCOPETYPE RULE
Example 2
When the comparison type is Local Catalog to Local Catalog with Object as scope and the additional keywords added in Additional Compare Input Keywords field are as below:
NOSYNONYM
NOALIAS
NODEFINE
The generated compare input stream will be:
//*Compare Input
//COMPARE1 EXEC AMAPROCC,
// COND=(1,LT)
//COMPARE.CDL001 DD DISP=SHR,
// DSN=&CDLFILE
//COMPARE.CMPIN2 DD DISP=SHR,
// DSN=&DDLFILE
//COMPARE.ALUIN DD *
SSID ${SSID}
CMPTYPE1 LOCAL
CMPTYPE2 LOCAL
INCLUDE (ALTER CREATE DROP )
REPORT (DETAIL )
SCOPETYPE RULE
NOSYNONYM
NOALIAS
NODEFINE
- Additional Import Input Keywords
- Additional Analysis Input Keywords
- Additional JCL Generation Input Keywords
- JCL
Acceptable Return Code
Important
- If the return code from the mainframe server is less than or equal to the acceptable return code, the plug-in continues processing additional process steps.
- If the return code from the mainframe server is greater than the acceptable return code, the plug-in prevents processing additional process steps.
- The return code 0001 is a result of no differences found in a comparison.
Maximum Job Wait Time
Important
If the time for the response exceeds the maximum job wait time, the plug-in terminates the process step and stops subsequent processing.
Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory.
- Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
BMC AMI DevOps Schema Migration - Schema Mig: Cat to DDL-WL-BL
Click here for information about configuring this process step
- To edit the step properties, click .
- Enter values for the following fields:
- SSID
- Work ID Owner
- Work ID Name
Comparison Type
Select one of the following options:
- Local Catalog to DDL File with DDL File as Scope
- Local Catalog to Migrate Worklist with Worklist as Scope
- Local Catalog to Baseline
Important
You can select an option from the list of allowed comparisons. The name of the comparison type also includes the schema location for Compare1 and Compare2. The first location represents Compare1, where the resulting CDL is applied. The second location represents Compare2, where the objects already have the desired structure definitions.
Compare2 DDL/Worklist PDS and Member Name
Important
The DDL must consist of CREATE and ALTER statements. The ALTER statements must reference the objects named in the CREATE statements. By default, it contains default text 'Input required only for Local Cat to DDL or Worklist'.
This field is mandatory for following comparison types:
- Local Catalog to DDL File with DDL File as Scope
- Local Catalog to Migrate Worklist with Worklist as Scope
Compare2 Baseline Name
Important
A baseline is a snapshot of object structures in the Db2 catalog. Compare2 uses these structures which have the desired structure definition. This field is only mandatory for the Local Catalog to Baseline comparison type. By default, the field contains default text 'Input required only for Local Cat to Baseline'.
If you select the Use Outbound Migrate Profile (applied before comparison) check box, enter a value for the Outbound Migrate Profile (applied before comparison) field.
Important
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.
If you select the Use Outbound Migrate Profile (applied after comparison) check box, enter a value for the Outbound Migrate Profile (applied after comparison) field.
Important
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.
- CDL PDS and Member Name
- If you select the Use Inbound Migrate Profile check box, enter a value for the Inbound Migrate Profile field.
- Worklist PDS and Member Name
- (Optional) Impact Report PDS and Member Name
- Execution JCL PDS and Member Name
- Select one of the following options in the Select Baseline Type Before Execution field:
- None: Does not create any baseline.
- Pre-Execution Baseline: Specifies whether an additional step in the Execution JCL is created which creates a baseline before applying schema changes. Keywords added to AJXIN DD.
Full-Recovery Baseline: The worklist creates a baseline tied to the work ID, which you can use later for recovery.
For more information about recovering from these baselines, see the BMC AMI Change Manager for Db2.
- If you are creating a Pre-Execution or Full-Recovery Baseline, enter values for the following fields:
Baseline Profile Name (before execution)
Important
The scope rules previously defined the set of objects used during the comparison. The scope rules now create a baseline before applying the resulting schema changes.
- Baseline Name (before execution)
If you select the Generate CDL to Rollback Schema Changes check box, enter a value for the Rollback PDS and Member Name (CDL) field.
Important
Generate CDL to Rollback Schema Changes check box is applicable when you select either the Pre-Execution Baseline or the Full-Recovery Baseline option in the Select Baseline Type Before Execution field.
- If you select the Create Baseline After Execution check box, enter values for the following fields:
- Baseline Profile Name (after execution)
- Baseline Name (after execution)
- Job Card
Additional Compare Input Keywords
Important
See the following examples:
Example 1
When the comparison type is Local Catalog to DDL File with DDL file as scope and Additional Compare Input Keywords field is blank. The generated compare input stream will be:
//*Compare Input
//COMPARE1 EXEC AMAPROCC,
// COND=(1,LT)
//COMPARE.CDL001 DD DISP=SHR,
// DSN=&CDLFILE
//COMPARE.CMPIN2 DD DISP=SHR,
// DSN=&DDLFILE
//COMPARE.ALUIN DD *
SSID ${SSID}
CMPTYPE1 LOCAL
CMPTYPE2 DDL
SCOPETYPE DDL
Example 2
When the comparison type is Local Catalog to DDL File with DDL file as scope and the additional keywords added in Additional Compare Input Keywords field are as below:
NOSYNONYM
NOALIAS
NODEFINE
The generated compare input stream will be:
//*Compare Input
//COMPARE1 EXEC AMAPROCC,
// COND=(1,LT)
//COMPARE.CDL001 DD DISP=SHR,
// DSN=&CDLFILE
//COMPARE.CMPIN2 DD DISP=SHR,
// DSN=&DDLFILE
//COMPARE.ALUIN DD *
SSID ${SSID}
CMPTYPE1 LOCAL
CMPTYPE2 DDL
SCOPETYPE DDL
NOSYNONYM
NOALIAS
NODEFINE
- Additional Import Input Keywords
- Additional Analysis Input Keywords
- Additional JCL Generation Input Keywords
- JCL
Acceptable Return Code
Important
- If the return code from the mainframe server is less than or equal to the acceptable return code, the plug-in continues processing additional process steps.
- If the return code from the mainframe server is greater than the acceptable return code, the plug-in prevents processing additional process steps.
- The return code 0001 is a result of no differences found in a comparison.
Maximum Job Wait Time
Important
If the time for the response exceeds the maximum job wait time, the plug-in terminates the process step and stops subsequent processing.
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
BMC AMI DevOps Schema Migration - Schema Mig: Use Existing CDL File
Click here for information about configuring this process step
- To edit the step properties, click .
- Enter values for the following fields:
- SSID
- Work ID Owner
- Work ID Name
CDL PDS and Member Name
Important
If you are using this component process to roll back changes implemented by another component process, enter the Rollback PDS and Member Name (CDL) that you specified for the other component process.
- If you select the Use Inbound Migrate Profile check box, enter a value for the Inbound Migrate Profile field.
Worklist PDS and Member Name
Important
If you are using this component process to roll back changes implemented by another component process, enter the PDS and member of the worklist of DDL schema changes that can roll back the schema changes implemented previously.
(Optional) Impact Report PDS and Member Name
Important
If you are using this component process to roll back changes implemented by another component process, enter the PDS and member of the impact report for rollback schema changes.
Execution JCL PDS and Member Name
Important
If you are using this component process to roll back changes implemented by another component process, enter the PDS and member of the execution JCL for rollback schema changes.
- Select one of the following options in the Select Baseline Type Before Execution field:
- None: Does not create any baseline.
- Pre-Execution Baseline: Specifies whether an additional step in the Execution JCL is created which creates a baseline before applying schema changes. Keywords added to AJXIN DD.
Full-Recovery Baseline: The worklist creates a baseline tied to the work ID, which you can use later for recovery.
For more information about recovering from these baselines, see the BMC AMI Change Manager for Db2.
- If you are creating a Pre-Execution or Full-Recovery Baseline, enter values for the following fields:
Baseline Profile Name (before execution)
Important
The scope rules previously defined the set of objects used during the comparison. The scope rules now create a baseline before applying the resulting schema changes.
- Baseline Name (before execution)
If you select the Generate CDL to Rollback Schema Changes check box, enter a value for the Rollback PDS and Member Name (CDL) field.
Important
Generate CDL to Rollback Schema Changes check box is applicable when you select either the Pre-Execution Baseline or the Full-Recovery Baseline option in the Select Baseline Type Before Execution field.
- If you select the Create Baseline After Execution check box, enter values for the following fields:
- Baseline Profile Name (after execution)
- Baseline Name (after execution)
- Job Card
- Additional Compare Input Keywords
- Additional Import Input Keywords
- Additional Analysis Input Keywords
- Additional JCL Generation Input Keywords
- JCL
Acceptable Return Code
Important
- If the return code from the mainframe server is less than or equal to the acceptable return code, the plug-in continues processing additional process steps.
- If the return code from the mainframe server is greater than the acceptable return code, the plug-in prevents processing additional process steps.
- The return code 0001 is a result of no differences found in a comparison.
Maximum Job Wait Time
Important
If the time for the response exceeds the maximum job wait time, the plug-in terminates the process step and stops subsequent processing.
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
BMC AMI DevOps Schema Migration - Output Transmission
Click here for information about configuring this process step
- To edit the step properties, click .
Enter values for the following fields:
Important
The BMC AMI DevOps Schema Migration - Output Transmission process step lets you download any or all of the generated artifacts (CDL file, worklist, impact report, and execution JCL) to the destination directory. To download an artifact, enter its respective source PDS name.
You must enter the source PDS name for at least one artifact.
- Source PDS Name (CDL)
- Source PDS Name (WORKLIST)
- Source PDS Name (EXEC_JCL)
- Source PDS Name (IMPACT REPORT)
- Source Member Name
Destination Directory Name
Important
The Destination PDS or Directory Name field supports relative paths. If you do not enter any path or enter a period (.), this plug-in considers the relative path with respect to the default working directory.
The following example indicates a relative path:
Example
${p:resource/work.dir}/${p:component.name}
- Destination File Name
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
ommon - JCL Execution
Click here for information about configuring this process step
- To edit the step properties, click .
- Enter values for the following fields:
- Execute JCL from Mainframe PDS check box
Execution JCL PDS or Directory Name
Important
The Execution JCL PDS or Directory Name field supports relative paths. If you do not enter any path or enter a period (.), this plug-in considers the relative path with respect to the working directory.
- Execution JCL Member or File Name
Acceptable Return Code
Important
- If the return code from the mainframe server is less than or equal to the acceptable return code, the plug-in continues processing additional process steps.
- If the return code from the mainframe server is greater than the acceptable return code, the plug-in prevents processing additional process steps.
Maximum Job Wait Time
Important
If the time for the response exceeds the maximum job wait time, the plug-in terminates the process step and stops subsequent processing.
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
BMC AMI DevOps Common - Clean Up
Click here for information about configuring this process step
Important
Add BMC AMI DevOps Common - Clean Up as the last process step in your component process to delete the workfile.properties file after processing all the other process steps.
- To edit the step properties, click .
- Enter values for the following fields:
- Working Directory
You can enter an alternative absolute path to the working directory for this step. If left blank, it will use the default process-specific working directory. - Show Hidden Properties
Select this check box if you want to modify the hidden properties of the plug-in step.Info Key
Important
Ensure that you don't modify the default value for this field unless the name of the authentication step is modified.
- Click the OK button to save the process step.
- To save the component process, click
.
Examples of how to add process steps during component process configuration
The following examples illustrate how to add process steps to the component process configuration.
Example 1
You must add the following process steps sequentially during configuration for a component process that contains all the main process steps:
| | | |
|---|
| | BMC AMI DevOps Common - Authentication | This must be the first process step that you add when configuring the component process. |
| | BMC AMI DevOps Common - File Transmission | This step is optional depending on the type of comparison. |
| - BMC AMI DevOpsSchema Migration - Schema Mig: Cat to Cat Baseline Profile as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Migrate Profile as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Objects as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to DDL-WL-BL
- BMC AMI DevOps Schema Migration - Schema Mig: Use Existing CDL File
| You may use one or any combination of the BMC AMI DevOpsSchema Migration process steps. |
| BMC AMI DevOps Schema Migration - Output Transmission | |
| BMC AMI DevOps Common - JCL Execution | |
| | BMC AMI DevOps Common - Clean Up | This must be the last process step that you add when configuring the component process. |
Example 2
You must add the following process steps sequentially during configuration for component process that contains one or more of the main process steps:
Click here for component process that contain only the BMC AMI DevOps Common - File Transmission main process step
You must add the following process steps sequentially during configuration:
| | | |
|---|
| | BMC AMI DevOps Common - Authentication | This must be the first process step that you add when configuring the component process. |
| | BMC AMI DevOps Common - File Transmission | |
| | BMC AMI DevOps Common - Clean Up | This must be the last process step that you add when configuring the component process. |
Click here for component process that contain only the BMC AMI DevOps Schema Migration main process step
You must add the following process steps sequentially during configuration:
| | | |
|---|
| | BMC AMI DevOps Common - Authentication | This must be the first process step that you add when configuring the component process. |
| | - BMC AMI DevOpsSchema Migration - Schema Mig: Cat to Cat Baseline Profile as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Migrate Profile as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to Cat Objects as Scope
- BMC AMI DevOps Schema Migration - Schema Mig: Cat to DDL-WL-BL
- BMC AMI DevOps Schema Migration - Schema Mig: Use Existing CDL File
| You may use one or any combination of the BMC AMI DevOpsSchema Migration process steps. |
| | BMC AMI DevOps Common - Clean Up | This must be the last process step that you add when configuring the component process. |
Click here for component process that contain only the BMC AMI DevOps Schema Migration - Output Transmission main process step
You must add the following process steps sequentially during configuration:
| | | |
|---|
| | BMC AMI DevOps Common - Authentication | This must be the first process step that you add when configuring the component process. |
| | BMC AMI DevOps Schema Migration - Output Transmission | |
| | BMC AMI DevOps Common - Clean Up | This must be the last process step that you add when configuring the component process. |
Click here for component process that contain only the BMC AMI DevOps Common - JCL Execution main process step
You must add the following process steps sequentially during configuration:
| | | |
|---|
| | BMC AMI DevOps Common - Authentication | This must be the first process step that you add when configuring the component process. |
| | BMC AMI DevOps Common - JCL Execution | |
| | BMC AMI DevOps Common - Clean Up | This must be the last process step that you add when configuring the component process. |
For information about configuring the fields in each process step, see step 3 of the procedure to configure the component process.
To use the configuration provided in the sample component process
BMC has provided you with a ready-made sample component process for your reference and convenience. You can customize the configuration available in the sample component process template instead of configuring a new component process.
Follow this procedure to use the sample component process template:
- Perform the procedure described in the topic, To install the plug-ins on UrbanCode Deploy/HCL Launch.
- From the UrbanCode Deploy/HCL Launch web console:
- Click Components > Templates tab.
- Click Import Template and perform the following actions:
- Click Choose File.
- Select the AMI_DEVOPS_COMPONENT.json file from the UCD folder in your download directory: BMC AMI DevOps for Db2.
- Click Submit.
- The component template appears in the component template list.
- Select the component template you want to configure.
- Click Create Component to configure your component template. This component inherits the properties and processes of the component template.
Inside the component template, click Processes to update the values of the fields based on your requirements. For more information, see To configure a component process.
Important
Ensure the following points when the component is created via the BMC provided component template:
- Refer to the template environment properties in the configuration screen of the template. These environment properties are used in the component processes. Make the necessary updates for the property values
- Environment properties are inherited by the component created from the template. Their value can also be modified after adding the component to the application environment resources from the configuration screen of the environment.
- Configure the property 'ama.job.id' as an application process property to allow the user to provide input at the time of application process execution.
For the full list of example values that you can configure for the different fields in the component process, see Sample UrbanCode Deploy/HCL Launch component processes.
To run process steps in Debug mode
To view additional diagnostic information, you can run any or all the process steps in the Debug mode. To enable this feature, do one of the following:
- To run any process step in Debug mode, when configuring the process step, select the Run Step in Debug Mode check box for each process step.
To run all the process steps in Debug mode, when configuring the component process, add a property with the following values:
Important
- If the property variable is defined as true, then each process step will run in debug mode irrespective of the selection for the Run Step in Debug Mode.
- If the property variable is defined as false or the AMI DevOps Debug Mode field is empty, then each process step will run in debug mode based on the selection for the Run Step in Debug Mode.
You can customize the property variable name or use amiDebugAll as the default name.