Configuring the project
This topic describes how to configure a project:
Before you begin
Perform the procedures described in the following topics:
To configure a project
Use the following procedure to configure the project to migrate schema changes and validate schema standards in Db2 for z/OS environment.
Tip
You can also update the configuration in the sample project provided by BMC. For more information, see Using the configuration provided in the sample project.
For more information, view the following Quick Courses: BMC AMI DevOps for Db2 - Configuring a Test Project BMC AMI DevOps for Db2 - Configuring Sample Change Management project BMC AMI DevOps for Db2 - Configuring a project to prompt for ID/Password |
- From the Dashboard in the Jenkins web user interface:
- Select the project you want to configure.
- Click Configure.
- Select the General tab.
- (Optional) Enter a project description.
- (Optional) To use parameters in the project:
- Select the This project is parameterized check box.
- Click Add Parameter .
From the list, select the type of parameter.
Important
Boolean Parameter, String Parameter, and Password Parameter are the typical parameter types for the variables you might use when working with the product.
- For the new parameter, enter values for the following fields:
Name
Important
- (BMC.DB2.SPE2110) String parameters with spaces in the name are not supported. You can include an underscore in the string parameter names.
A double dollar sign can be used to produce a character string starting with, or containing, a dollar sign. That is, $$ yields $.
- Default Value
- Description
- Select the Build tab to add and configure the build steps as follows:
Click Add build step.
Important
BMC AMI DevOps has five main build steps and three supporting build steps.
The five main build steps are:
- BMC AMI DevOps Common - File Transmission
- BMC AMI DevOps Schema Mgmt for Db2 - Schema Change Migration
- BMC AMI DevOps Schema Mgmt for Db2 - Schema Standards (BMC.DB2.SPE2110)
- BMC AMI DevOps Schema Mgmt for Db2 - Output Transmission
- BMC AMI DevOps Common - JCL Execution
The three supporting build steps are:
- BMC AMI DevOps Common - Authentication
- BMC AMI DevOps Common - Authentication (Credential Store) (BMC.DB2.SPE2204)
- BMC AMI DevOps Common - Clean Up
(BMC.DB2.SPE2204) We offer the BMC AMI DevOps Common - Authentication (Credential Store) build step. This build step has the Login Credentials field that provides credentials saved in Jenkins Credential Store. For more information, see BMC AMI DevOps Common - Authentication (Credential Store).
When configuring projects, if you add one or more main build steps, you must also add the supporting build steps. You must add BMC AMI DevOps Common - Authentication or BMC AMI DevOps Common - Authentication (Credential Store) as the first build step and BMC AMI DevOps Common - Clean Up as the last build step. For more information, see Examples of how to add build steps during project configuration.
Add build steps and enter values for the fields:
Important
- You can run any or all build steps in Debug mode. For more information, see To run build steps in Debug mode.
- When building the project, you can disable processing for one or more build steps except:
- BMC AMI DevOps Common - Authentication
- BMC AMI DevOps Common - Authentication (Credential Store)
- BMC AMI DevOps Common - Clean Up
- To enter your mainframe password when building the project:
- Select the Provide Password via Build Parameter check box.
- Specify a parameter-based variable as the value of the Mainframe Password via Build Parameter field. For example, specify
${MF_PW}
, where MF_PW is a Password Parameter variable, as the value of this field.
- To generate JCL but not execute it, you can select the Generate JCL Only check box in the BMC AMI DevOps Schema Mgmt for Db2 - Schema Change Migration and the BMC AMI DevOps Schema Mgmt for Db2 - Schema Standards build steps. For example, you can use this feature to validate the JCL before submitting it. The generated JCL is saved to the project workspace folder. If you select this option, you must also disable the subsequent build 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 workspace project folder.
Build step Field 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 Mgmt for Db2 - 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 Jenkins projects when the relative path is specified for a field.
BMC AMI DevOps Common - Authentication
BMC AMI DevOps Common - Authentication (Credential Store) (BMC.DB2.SPE2204)
BMC AMI DevOps Common - File Transmission
BMC AMI DevOps Schema Mgmt for Db2 - Schema Change Migration
BMC AMI DevOps Schema Mgmt for Db2 - Schema Standards (BMC.DB2.SPE2110)
BMC AMI DevOps Schema Mgmt for Db2 - Output Transmission
BMC AMI DevOps Common - JCL Execution
- BMC AMI DevOps Common - Clean Up
Add BMC AMI DevOps Common - Clean Up as the last build step in your project to delete the workfile.properties file after processing all the other build steps.
- Click Apply to save the project, or Save to save and close the project.
Examples of how to add build steps during project configuration
The following examples illustrate how to add build steps to the project configuration.
Important
You can either use the Common – Authentication build step or the Common – Authentication (Credential Store) build step based on your Jenkins configuration.
For information about configuring the fields in each build step, see step 3 of the procedure to configure the project.
To use the configuration provided in the sample project
BMC has provided you with a ready-made sample project for your reference and convenience. The sample project folder contains the config.xml file for the project. You can customize the configuration available in the sample project instead of configuring a new project.
For more information, view the Quick Course BMC AMI DevOps for Db2 - Defining Sample Projects to Jenkins. |
Follow this procedure to use the sample project:
Copy the project folder to the following directory:
- Restart the Jenkins server and log in to Jenkins.
The sample project appears on the Dashboard in the Jenkins web user interface. - Open the project for configuration.
- Update the values of the fields based on your requirements. For more information, see To configure a project.
For the full list of sample values that you can configure for the different fields in the project, see Sample projects for Schema Change Migration and Sample projects for Schema Standards.
To run build steps in Debug mode
To view additional diagnostic information, you can run any or all the build steps in the Debug mode. To enable this feature, do one of the following:
- To run any build step in Debug mode, when configuring the build step, select the Run Step in Debug Mode check box.
- To run all the build steps in Debug mode:
When configuring the project, add a Boolean parameter with the following field values:
Field Value Notes Name AMIDevOpsDebugOn You must enter only this value for this field. However, this name is not case-sensitive. Default Value Clear this check box. Description Select this check box to run all the build steps in Debug mode. For more information about configuring parameters, see step 2.b of the procedure to configure a project.
When building the project, select the AMIDevOpsDebugOn check box.
Important
Selecting the AMIDevOpsDebugOn check box runs all the build steps in Debug mode even if you have not selected the Run Step in Debug Mode check box when configuring any of the build steps.
Comments
Log in or register to comment.