Example property values for all Schema Standards steps


(BMC.DB2.SPE2310)

This topic contains example property key values that you must configure to perform all steps of the Schema Standards application processes. This sample gives a brief explanation of each property key and expected value. For detailed information about each Schema Standards step, see Creating a configuration file.

The following figure represents a sample configuration YAML file for all steps in Schema Standards:

(BMC.DB2.SPE2407)

###------------------------------------------------------------------------------------------------------------------------------------
### Config_Schema_Standards_ALL_Schema_Types.yml (Do not modify the file. Use this as reference only)
###------------------------------------------------------------------------------------------------------------------------------------
# Each line represents a property (key-value pair).
#   The property key (left side of colon) is a fixed keyword and should not be altered.
#   The property value (right side of colon) is for user input.    
#   The alignment or spacing for the property key and value should not be changed. It may result in an unexpected error. The YAML file only works with proper alignment.
#   For property values with multiple lines, specify the pipe | character after the property key.  On the following line, indent the lines with values.
###------------------------------------------------------------------------------------------------------------------------------------

version: 3.0.0               #Version of the configuration file. DO NOT alter the version value unless config file version is upgraded.

authentication:              #Step used in the pipeline/workflow for executing this configuration input. DO NOT alter the name.
  debugMode: false           #Valid values are: true or false(default). If set to true, will produce additional debug messages in the Console output log.
  hostName: db2b.bmc.com     #Mainframe host name in URL format or IP address in IPv4 format.
  port: 32208                #Communication medium port used on mainframe TCP/IP network.
  authenticationType: userBased  #Communication with mainframe using either TSO credential or client certificate. Valid values are: userBased(default) or certBased.
  user: USER_ID_AUTH         #Mainframe TSO logon ID input as specific name or variable name, like shown here: USER_ID_AUTH which will be replaced by variable definition from pipeline/workflow.
  password: USER_PASS_AUTH   #Mainframe TSO logon password. For security purposes, variable name should be used, like shown here: USER_PASS_AUTH which will be replaced by variable definition from pipeline/workflow.
  certificatePath: CERT_PATH_AUTH     #Client certificate path input as specific name or variable name, like shown here: CERT_PATH_AUTH which will be replaced by variable definition from pipeline/workflow.
  certificatePassword: CERT_PASS_AUTH #Client certificate password. For security purposes, variable name should be used, like shown here: CERT_PASS_AUTH which will be replaced by variable definition from pipeline/workflow.
  symbolicPropertiesFilePath: AMI_DevOps.properties   #File path or file name (in case file is present in root directory) for the BMC AMI DevOps plug-in variable file. Default file name is AMI_DevOps.properties.
  debugModeAllSteps: false   #Valid values are: true or false(default). If set to true, it will override the debugMode property to true in all config steps.
  executionIdentifier: PipelineName=PIPELINENAME_VALUE,RunNumber=RUNNUMBER_VALUE,RunBy=RUNBY_VALUE,RunMode=RUNMODE_VALUE  #Identifier keys used to trace the executed pipeline/workflow from the submitted JCL at the mainframe. Typically input as variable names and replaced by variable definition from pipeline/workflow. Do NOT alter unless directed by BMC Support.
 
schemaStandards:                                #Step represents Schema Standards. DO NOT alter the name.
  - stepName: schema_standards_ddl              #Step details for Schema Type-DDL, user defined step name used in the pipeline/workflow for executing this configuration input.
    debugMode: true                             #Valid values are: true or false(default). If set to true, will produce additional debug messages in the Console output log.
    generateJclOnly: false                      #Valid values are: true or false(default). If set to true, will generate the JCL only without executing the step.
    ssid: DEJM                                  #Db2 subsystem ID for schema standards.
    ruleSetName: $BMC SAMPLE RULE SET           #Rule set name, defined via Command Center, that Schema Standards uses for analysis. Default value, $BMC SAMPLE RULE SET, is a rule set supplied by BMC Software that contains example rules.
    violationResponse: FAIL                     #Valid values are: WARN or FAIL. If set to WARN, it prevents the application step from failing if a violation is encountered. If set to FAIL, it causes a rule violation to fail the application step.
    schemaType: DDL                             #Valid values are: DDL, CDL, migrateWorklist, catalogMigrateProfileScope or catalogBaselineProfileScope. Schema Standards uses schema type option, DDL, for analysis.
    inputSchemaSource: $[ddlpds](JOB_ID)        #Specify partitioned data set (PDS) name and member which contain the DDL that Schema Standards analyzes.
    useOutboundMigrateProfileAfterRead: false   #Valid values are: true or false(default). If set to true, outbound migrate profile’s change rules are used for analysis.
    outboundMigrateProfileAfterRead:            #Outbound migrate profile (owner.name) that contains change rules for object names. The change rules are applied after objects are read to ensure structure definitions are as per naming standards.
    jobCard: |                                  #JOB statement to run the JCL.  Typically, multiple lines are required.
      //AMASTDS JOB ($[acctno]),'SCHEMA STANDARDS',
      //  CLASS=A,MSGLEVEL=(1,1)
      //*
    schemaStandardsInputStream: |               #Contains the DD names, parameters and option override values for schema type DDL that the Schema Standards analysis uses. Value will be multiple lines.
      //SCHEMAS.AMAIN  DD DISP=SHR,
      //           DSN=${inputSchemaSource}
      //SCHEMAS.ALUIN  DD *,SYMBOLS=JCLONLY
        SSID &SSID
        SOURCETYPE DDL
        RULESET (&RULESET)
        LOGMODE &LOGMODE
        VTIBUCKETSIZE &VTIBSZ
    debugInputStream: |                         #Contains the DDs for debugging Schema Standards analysis. Value will be multiple lines.
      //**********************************************************************
      //* 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: |                                      #Contains statements that Schema Standards needs to perform object parsing, rule evaluation, violation logging and generate the Schema Standards Violations report.
      ${jobCard}
      //*
      //       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='${ruleSetName}'
      // SET LOGMODE=${violationResponse}
      // SET VTIBSZ=20
      //*******************************************************
      //SCHSTDS  EXEC AMAPROCS
      ${schemaStandardsInputStream}
      ${debugInputStream}
    maxJobWaitTime:  2                          #Valid values are: 1-60 and default is 2. Maximum length of time in minutes that the application waits for job completion from the mainframe.

  - stepName: schema_standards_cdl              #Step details for Schema Type-CDL, user defined step name used in the pipeline/workflow for executing this configuration input.
    debugMode: true                             #Valid values are: true or false(default). If set to true, will produce additional debug messages in the Console output log.
    generateJclOnly: false                      #Valid values are: true or false(default). If set to true, will generate the JCL only without executing the step.
    ssid: DEJM                                  #Db2 subsystem ID for schema standards.
    ruleSetName: $BMC SAMPLE RULE SET           #Rule set name, defined via Command Center, that Schema Standards uses for analysis. Default value, $BMC SAMPLE RULE SET, is a rule set supplied by BMC Software that contains example rules.
    violationResponse: FAIL                     #Valid values are: WARN or FAIL. If set to WARN, it prevents the application step from failing if a violation is encountered. If set to FAIL, it causes a rule violation to fail the application step.
    schemaType: CDL                             #Valid values are: DDL, CDL, migrateWorklist, catalogMigrateProfileScope or catalogBaselineProfileScope. Schema Standards uses schema type option, CDL, for analysis.
    inputSchemaSource: $[cdlpds](JOB_ID)        #Specify partitioned data set (PDS) name and member which contain the CDL that Schema Standards analyzes.
    useOutboundMigrateProfileAfterRead: false   #Valid values are: true or false(default). If set to true, outbound migrate profile’s change rules are used for analysis.
    outboundMigrateProfileAfterRead:            #Outbound migrate profile (owner.name) that contains change rules for object names. The change rules are applied after objects are read to ensure structure definitions are as per naming standards.
    jobCard: |                                  #JOB statement to run the JCL.  Typically, multiple lines are required.
      //AMASTDS JOB ($[acctno]),'SCHEMA STANDARDS',
      //  CLASS=A,MSGLEVEL=(1,1)
      //*
    schemaStandardsInputStream: |               #Contains the DD names, parameters and option override values for schema type CDL that the Schema Standards analysis uses. Value will be multiple lines.
      //SCHEMAS.AMAIN  DD DISP=SHR,
      //           DSN=${inputSchemaSource}
      //SCHEMAS.ALUIN  DD *,SYMBOLS=JCLONLY
        SSID &SSID
        SOURCETYPE CDL
        RULESET (&RULESET)
        LOGMODE &LOGMODE
        VTIBUCKETSIZE &VTIBSZ
    debugInputStream: |                         #Contains the DDs for debugging Schema Standards analysis. Value will be multiple lines.
      //**********************************************************************
      //* 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: |                                      #Contains statements that Schema Standards needs to perform object parsing, rule evaluation, violation logging and generate the Schema Standards Violations report.
      ${jobCard}
      //*
      //       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='${ruleSetName}'
      // SET LOGMODE=${violationResponse}
      // SET VTIBSZ=20
      //*******************************************************
      //SCHSTDS  EXEC AMAPROCS
      ${schemaStandardsInputStream}
      ${debugInputStream}
    maxJobWaitTime:  2                          #Valid values are: 1-60 and default is 2. Maximum length of time in minutes that the application waits for job completion from the mainframe.

  - stepName: schema_standards_migrateWorklist  #Step details for Schema Type-migrateWorklist, user defined step name used in the pipeline/workflow for executing this configuration input.
    debugMode: true                             #Valid values are: true or false(default). If set to true, will produce additional debug messages in the Console output log.
    generateJclOnly: false                      #Valid values are: true or false(default). If set to true, will generate the JCL only without executing the step.
    ssid: DEJM                                  #Db2 subsystem ID for schema standards.
    ruleSetName: $BMC SAMPLE RULE SET           #Rule set name, defined via Command Center, that Schema Standards uses for analysis. Default value, $BMC SAMPLE RULE SET, is a rule set supplied by BMC Software that contains example rules.
    violationResponse: FAIL                     #Valid values are: WARN or FAIL. If set to WARN, it prevents the application step from failing if a violation is encountered. If set to FAIL, it causes a rule violation to fail the application step.
    schemaType: migrateWorklist                 #Valid values are: DDL, CDL, migrateWorklist, catalogMigrateProfileScope or catalogBaselineProfileScope. Schema Standards uses schema type option, migrateWorklist, for analysis.
    inputSchemaSource: $[wlpds](JOB_ID)         #Specify partitioned data set (PDS) name and member which contain Migrate Worklist that Schema Standards analyzes.
    useOutboundMigrateProfileAfterRead: false   #Valid values are: true or false(default). If set to true, outbound migrate profile’s change rules are used for analysis.
    outboundMigrateProfileAfterRead:            #Outbound migrate profile (owner.name) that contains change rules for object names. The change rules are applied after objects are read to ensure structure definitions are as per naming standards.
    jobCard: |                                  #JOB statement to run the JCL.  Typically, multiple lines are required.
      //AMASTDS JOB ($[acctno]),'SCHEMA STANDARDS',
      //  CLASS=A,MSGLEVEL=(1,1)
      //*
    schemaStandardsInputStream: |               #Contains the DD names, parameters and option override values for schema type migrateWorklist that the Schema Standards analysis uses. Value will be multiple lines.
      //SCHEMAS.AMAIN  DD DISP=SHR,
      //           DSN=${inputSchemaSource}
      //SCHEMAS.ALUIN  DD *,SYMBOLS=JCLONLY
        SSID &SSID
        SOURCETYPE WORKLIST
        RULESET (&RULESET)
        LOGMODE &LOGMODE
        VTIBUCKETSIZE &VTIBSZ
    debugInputStream: |                         #Contains the DDs for debugging Schema Standards analysis. Value will be multiple lines.
      //**********************************************************************
      //* 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: |                                      #Contains statements that Schema Standards needs to perform object parsing, rule evaluation, violation logging and generate the Schema Standards Violations report.
      ${jobCard}
      //*
      //       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='${ruleSetName}'
      // SET LOGMODE=${violationResponse}
      // SET VTIBSZ=20
      //*******************************************************
      //SCHSTDS  EXEC AMAPROCS
      ${schemaStandardsInputStream}
      ${debugInputStream}
    maxJobWaitTime:  2                          #Valid values are: 1-60 and default is 2. Maximum length of time in minutes that the application waits for job completion from the mainframe.

  - stepName: schema_standards_catalogMigrateProfileScope  #Step details for Schema Type-catalogMigrateProfileScope, user defined step name used in the pipeline/workflow for executing this configuration input.
    debugMode: true                             #Valid values are: true or false(default). If set to true, will produce additional debug messages in the Console output log.
    generateJclOnly: false                      #Valid values are: true or false(default). If set to true, will generate the JCL only without executing the step.
    ssid: DEJM                                  #Db2 subsystem ID for schema standards.
    ruleSetName: $BMC SAMPLE RULE SET           #Rule set name, defined via Command Center, that Schema Standards uses for analysis. Default value, $BMC SAMPLE RULE SET, is a rule set supplied by BMC Software that contains example rules.
    violationResponse: FAIL                     #Valid values are: WARN or FAIL. If set to WARN, it prevents the application step from failing if a violation is encountered. If set to FAIL, it causes a rule violation to fail the application step.
    schemaType: catalogMigrateProfileScope      #Valid values are: DDL, CDL, migrateWorklist, catalogMigrateProfileScope or catalogBaselineProfileScope. Schema Standards uses schema type option, catalogMigrateProfileScope, for analysis.
    inputSchemaSource: OWNER.MPNAME             #Specify two-part name (owner. name) of migrate profile that contains the scope rules to identify the objects in the Db2 catalog that Schema Standards analyzes.
    useOutboundMigrateProfileAfterRead: false   #Valid values are: true or false(default). If set to true, outbound migrate profile’s change rules are used for analysis.
    outboundMigrateProfileAfterRead:            #Outbound migrate profile (owner.name) that contains change rules for object names. The change rules are applied after objects are read to ensure structure definitions are as per naming standards.
    jobCard: |                                  #JOB statement to run the JCL.  Typically, multiple lines are required.
      //AMASTDS JOB ($[acctno]),'SCHEMA STANDARDS',
      //  CLASS=A,MSGLEVEL=(1,1)
      //*
    schemaStandardsInputStream: |               #Contains the DD names, parameters and option override values for schema type catalogMigrateProfileScope that the Schema Standards analysis uses. Value will be multiple lines.
      //SCHEMAS.ALUIN  DD *,SYMBOLS=JCLONLY
        SSID &SSID
        SOURCETYPE CATALOG
        MIGPROFILE ${inputSchemaSource}
        RULESET (&RULESET)
        LOGMODE &LOGMODE
        VTIBUCKETSIZE &VTIBSZ
    debugInputStream: |                         #Contains the DDs for debugging Schema Standards analysis. Value will be multiple lines.
      //**********************************************************************
      //* 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: |                                      #Contains statements that Schema Standards needs to perform object parsing, rule evaluation, violation logging and generate the Schema Standards Violations report.
      ${jobCard}
      //*
      //       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='${ruleSetName}'
      // SET LOGMODE=${violationResponse}
      // SET VTIBSZ=20
      //*******************************************************
      //SCHSTDS  EXEC AMAPROCS
      ${schemaStandardsInputStream}
      ${debugInputStream}
    maxJobWaitTime:  2                          #Valid values are: 1-60 and default is 2. Maximum length of time in minutes that the application waits for job completion from the mainframe.

  - stepName: schema_standards_catalogBaselineProfileScope  #Step details for Schema Type-catalogBaselineProfileScope, user defined step name used in the pipeline/workflow for executing this configuration input.
    debugMode: true                             #Valid values are: true or false(default). If set to true, will produce additional debug messages in the Console output log.
    generateJclOnly: false                      #Valid values are: true or false(default). If set to true, will generate the JCL only without executing the step.
    ssid: DEJM                                  #Db2 subsystem ID for schema standards.
    ruleSetName: $BMC SAMPLE RULE SET           #Rule set name, defined via Command Center, that Schema Standards uses for analysis. Default value, $BMC SAMPLE RULE SET, is a rule set supplied by BMC Software that contains example rules.
    violationResponse: FAIL                     #Valid values are: WARN or FAIL. If set to WARN, it prevents the application step from failing if a violation is encountered. If set to FAIL, it causes a rule violation to fail the application step.
    schemaType: catalogBaselineProfileScope     #Valid values are: DDL, CDL, migrateWorklist, catalogMigrateProfileScope or catalogBaselineProfileScope. Schema Standards uses schema type option, catalogBaselineProfileScope, for analysis.
    inputSchemaSource: OWNER.BPNAME             #Specify two-part name (owner. name) of baseline profile that contains the scope rules to identify the objects in the Db2 catalog that Schema Standards analyzes.
    useOutboundMigrateProfileAfterRead: false   #Valid values are: true or false(default). If set to true, outbound migrate profile’s change rules are used for analysis.
    outboundMigrateProfileAfterRead:            #Outbound migrate profile (owner.name) that contains change rules for object names. The change rules are applied after objects are read to ensure structure definitions are as per naming standards.
    jobCard: |                                  #JOB statement to run the JCL.  Typically, multiple lines are required.
      //AMASTDS JOB ($[acctno]),'SCHEMA STANDARDS',
      //  CLASS=A,MSGLEVEL=(1,1)
      //*
    schemaStandardsInputStream: |               #Contains the DD names, parameters and option override values for schema type catalogBaselineProfileScope that the Schema Standards analysis uses. Value will be multiple lines.
      //SCHEMAS.ALUIN  DD *,SYMBOLS=JCLONLY
        SSID &SSID
        SOURCETYPE CATALOG
        BLPROFILE ${inputSchemaSource}
        RULESET (&RULESET)
        LOGMODE &LOGMODE
        VTIBUCKETSIZE &VTIBSZ
    debugInputStream: |                         #Contains the DDs for debugging Schema Standards analysis. Value will be multiple lines.
      //**********************************************************************
      //* 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: |                                      #Contains statements that Schema Standards needs to perform object parsing, rule evaluation, violation logging and generate the Schema Standards Violations report.
      ${jobCard}
      //*
      //       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='${ruleSetName}'
      // SET LOGMODE=${violationResponse}
      // SET VTIBSZ=20
      //*******************************************************
      //SCHSTDS  EXEC AMAPROCS
      ${schemaStandardsInputStream}
      ${debugInputStream}
    maxJobWaitTime:  2                          #Valid values are: 1-60 and default is 2. Maximum length of time in minutes that the application waits for job completion from the mainframe.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*