Plug-in Documentation

CICS CM (Beta)

Overview

Overview

IBM CICS Configuration Manager is a tool for managing and maintaining CICS Transaction Server definitions. It provides audit, reporting and lifecycle change management control facilities to support the build, management, and deployment of complex mainframe CICS applications.

You can use the CICS CM Beta plug-in for UrbanCode Deploy to automate your resource management process. The resource management process can be simplified by modelling the processes, that might be complex, across each of your environments. For example, these environments might be development, test, and production in different data centers.

To feedback to us about the CICS CM Beta plug-in, or if you have any questions, please contact us by using the CICSdev forum.

Steps

Process steps in the CICS CM plug-in

Backout change package

Backout a change package to reverse a migration event.

Input properties for the Backout change package step
Name Type Description Required
Change Package String The name of the change package to be backed out. The default value is ${p:cicscm.changePackage}. Yes
Migration Scheme String The name of the migration scheme used in the migration event that is to be backed
out. The default value is ${p:Create migration scheme/migrationScheme}.
Yes

Create migration scheme

Dynamically create a migration scheme with a single migration path.

Input properties for the Create migration scheme step
Name Type Description Required
Migration Scheme Description String The description of the new migration scheme. By default, the description is: UCD:
Auto-generated migration scheme.
No
Source Configuration String The name of the source configuration. The default value is ${p:cicscm.sourceConfig}. Yes
Target Configuration String The name of the target configuration. The default value is ${p:cicscm.targetConfig}. Yes
Transformation Rule Set String The name of the transformation rule set. No

Install change package (CSD)

Install the resource definitions in a change package from a CSD configuration.

Input properties for the Install change package (CSD) step
Name Type Description Required
CSD Connection String The name of the connection from the CSD configuration to a particular CICS region. The default value
is ${p:cicscm.csdConnection}.
Yes
Change Package String The name of the change package to be installed. The default value is ${p:cicscm.changePackage}. Yes
Disable and Close resources Boolean Tick box to disable and close resources before installation. By default, the box is
checked.
No
Discard resources Boolean Tick box to discard resources before installation. By default, the box is checked. No
Target Configuration String The name of the target configuration. The default value is ${p:cicscm.targetConfig}. Yes

Migrate change package

Migrate a change package.

Input properties for the Migrate change package step
Name Type Description Required
Change Package String The name of the change package to be migrated. The default value is ${p:cicscm.changePackage}. Yes
Migration Scheme String The name of the migration scheme to be used in the migration. The default value is
${p:Create migration scheme/migrationScheme}.
Yes

Query change package

Query a change package for names, groups and types of resource definitions within
the package.

Input properties for the Query change package step
Name Type Description Required
Change Package String The name of the change package to be queried. The default value is ${p:cicscm.changePackage}. Yes

Ready change package

Ready a change package for migration.

Input properties for the Ready change package step
Name Type Description Required
Change Package String The name of the change package to be readied. The default value is ${p:cicscm.changePackage}. Yes
Migration Scheme String The name of the migration scheme to be assigned to the change package. The default
value is ${p:Create migration scheme/migrationScheme}.
Yes

Default input parameters

There are default input parameters that are available for all CICS CM Beta plug-in steps. To view the default properties, select Show Hidden Properties on any step configuration page. For more information, see Properties.


Name Default value Description
Host ${p:cicscm.host} The host name of the CICS CM server to connect to.
Port ${p:cicscm.port} The CICS CM port number to connect to.
Username ${p?:cicscm.username} The user name authorized to connect to the CICS CM server.
Password ${p?:cicscm.password} The user name password to connect to the CICS CM server.

Output properties

Output properties in the UrbanCode Deploy CICS Configuration Manager Beta plug-in.

Overview of CICS CM output properties

Two of the CICS CM UrbanCode Deploy steps have output properties.

Create migration scheme

Dynamically create a migration scheme with a single migration path.

Output properties for the Create migration scheme step
Name Type Description
migrationScheme String A random 8 alphanumeric string that is generated for the name of the new migration scheme.

Query change package step output properties

Query a change package for names, groups, and types of resource definitions within the package.

Output properties for the Query change package step
Name Type Description
resourceNames String A single string of all the names of the resource definitions contained within the change package, separated by commas.
resourceGroups String A single string of all the different groups of resource definitions contained within the change package, separated by commas.
resourceTypes String A single string of all the different types of resource definitions contained within the change package, separated by commas.

Usage

Migrating resource definitions

To deploy specific resource definitions to selected target configurations, complete the following steps:

  1. Create a migration scheme and specify the Source, Target, and Transformation Rule.
  2. Mark the migration package as ready for use with the specified migration scheme.
  3. Create a change package and add the resources that you want to migrate to this change package.
  4. Send the change package name and source configuration name by using metadata to the UrbanCode Deploy server. You can use either the UrbanCode Deploy client or the REST API.
  5. Migrate (deploy) the change package to an environment in UrbanCode Deploy.

__________________________________________________________________________________________________________________________________

Dynamic migration example

In the following example, the component that is going to be deployed is called Core Banking.

Before you deploy

You need to have an existing version or create a version in the component that you want to use for the change package. Each version includes the change package name and the source configuration name.

The following screen capture shows the defined version properties. version

In Environments, select which environment you want to target. In this example, we have DEVELOPMENT, TEST, and PRODUCTION environments defined.

environments

Expand the environment that you want to target and click Add Base Resources to see the resource tree.

From the resource tree, select one or more target configurations to add to the environment. The target configuration can be a CICS CSD or a BAS configuration. Select the component that you want to deploy to the target configurations.

In the following screen capture, the Core Banking component will be deployed to the CTS41CSD and CTS42CSD configurations. The change package will be dynamically migrated to these two CSDs.

CMResourceTree

The component consists of different processes. In the Core Banking example, we are using the Dynamic Migration process.

You can create your own processes or you can use the CICS CM component template, which contains re-configured processes.

Under CICS CM, in the Design Step Palette, drag and drop the relevant steps for your migration process. For each step, an Edit Properties window opens, which shows the data the step needs to run. The fields contain variables because the information is inherited from different locations. For example, inherited from the selected version and target configuration.

The following screen captures show the dynamic migration steps and the properties for the Create migration scheme step.
Dynamic_Migration_Process(Bigger image) Create_Migration_Scheme_Properties

Install component step

The Install Component step is a Process within an Application. You can choose which process within the component that you want to install or deploy to your target environment. In this example, the Dynamic Migration Process is selected for the Core Banking component.

The following screen captures show the install component step and properties for Core Banking. When you include an install step in your deployment process, set the Max # of concurrent jobs to 1 because it is a sequential process. InstallComponentInstallComponentProperties

Deploy the component

Ensure that the version you want to use exists, that you have added the base resources to your environment, included your component, and created a process for your application.

Now, click the play icon for the environment within your application and select the component version and application process for the deployment to start the migration process.

The Applications view changes to show the progress of the migration. You can expand the process to view the different process steps. As each step completes, the status is updated to show whether the step was successful. A log file for each step is created if you need to view the contents.

CICS CM properties

CICS CM properties

When you add a new CICS CM step to a process, the step contains a number of default values that refer to properties.

For the CICS CM steps, you can create a resource tree and define properties at the following resource levels:

Resource Property Resource with tag Description
cicscm.host
Agent The host name of the CICS CM server to connect to
cicscm.port
Agent The CICS CM port number to connect to
cicscm.username
Agent The user name authorized to connect to CICS CM
cicscm.password
Agent The password for the user name to connect to CICS CM
cicscm.targetConfig
Configuration The name of the target configuration
cicscm.csdConnection
Region The name of the connection from the CSD to a specific CICS region

For the CICS CM versions, the following properties can be defined:

Version Property Description
cicscm.changePackage
The name of the change package to be deployed
cicscm.sourceConfig
The name of the source configuration.

By default, the Transformation Rule property is blank. If you want to use a Transformation Rule property, define the property at the environment level. For more information, see Referring to properties.

Component Templates

Overview

You can use component templates to reuse component processes and properties across similar deployment scenarios. The CICS CM plug-in provides a CICS CM component template.

Using a component template

To use a component template, create a new component from the component template:

  1. From the Components tab, click Create Component.
  2. In the dialogue box that opens, select the relevant template from the Template list. For example, CICS CM.
  3. Complete the required fields, and click Save.

Updating a CICS CM supplied component template

When the CICS CM plug-in is updated, the component template is updated.

You can bind your component to a specific version of the template to avoid automatically using newer versions. If you want to modify the template processes, you can copy the process and update the copy.

More information

For more information about creating, using, and editing component templates, see the Component Templates section of the UrbanCode Deploy documentation or watch the introductory video, Component Templates in IBM UrbanCode Deploy v6.0.

CICS CM template

The CICS CM template contains the following processes:

Dynamic Migration

To dynamically migrate resource definitions within a change package to a CSD or BAS configuration.

The dynamic migration steps are:

  1. Create the migration scheme.
  2. Ready the change package.
  3. Migrate change package.

Dynamic Migration and Install (CSD)

To dynamically migrate resource definitions within a change package to a CSD configuration, and then install the resource definitions to a connected CICS region.

The dynamic migration and install steps are:

  1. Create the migration scheme.
  2. Ready the change package.
  3. Migrate change package.
  4. Install the change package.

________________________________________________________________________________________________________

Dynamic Migration process diagram. DynamicMigrationProcess

________________________________________________________________________________________________________

Dynamic Migration and Install (CSD) process diagram. DynamicMigrationAndInstall(CSD)Process

________________________________________________________________________________________________________