Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

RLM create and deploy package instance automation script


You can use this automation script to create and deploy an instance for an existing package on BMC Release Package and Deployment by using the BMC Release Process Management user interface. For this script to work, you must have an already created package on BMC Release Package and Deployment.

Note

This script creates an instance with the next available default name in the BMC Release Package and Deployment database. For example, if the last name with which an instance got created on BMC Release Package and Deployment is 0.0.0.2, then on running this script, the instance is created with the name 0.0.0.3.

Inputs required while creating a step
When you use this automation script at the time of creating a step, you must specify the following inputs:

  • Package: Select from a list of packages present in the database of BMC Release Package and Deployment.
  • Contents: This item is displayed when you select a package. Depending on the package you select, the associated references are displayed.
  • Route: Select from a list of routes present in the database of BMC Release Package and Deployment.
  • Set Properties: This item is displayed only when you select a package. The table displayed provides a list of properties that are associated with the selected package on BMC Release Package and Deployment. You can select one of these properties and override its value with a property value in BMC Release Process Management. For this, you must first create a mapping of properties in BMC Release Process Management with that on BMC Release Package and Deployment. For more information, see Set-property-values-for-a-package-repository-or-instance.

    Note

    The property values are overridden for the package and not instance in BMC Release Package and Deployment.
    Starting with BMC Release Process Manamgement version 4.4.00.10 and later, if you integrate with BMC Release Package and Deployment version 4.4.00.07 and later, the property values are overridden for the instance instance in BMC Release Package and Deployment. To use this functionality, reimport the RLM create and deploy package instance automation script.

  • Locked: Select Yes to create a locked instance for the selected package and select No to not create a locked instance for the selected package.
  • Environment: A list of environments is populated when you select a route. You can select from a list of environments associated with the selected route.

    Note

    If an environment name used in the request of the step matches exactly with the environment name on BMC Release Package and Deployment, then such an environment is selected by default in the step and is suffixed with the text (inherited from request).

  • Channels: Select the channel for the deployment from the list. A list of channels is populated when you select an environment.
  • Log Format: Select the format of the logs returned by the deploy operation from BMC Release Package and Deployment.

    Note

    In automation scripts, log format for BMC Release Package and Deployment is available only if you use BMC Release Process Management version 4.4.00.06 or later and integration with BMC Release Package and Deployment version 4.4.00.06 or later.

 

Expected results on running this automation script

After you run this script, you can expect to see the following results on the Automation tab in the step:

Note

The following results are only available if the step completes successfully. If there are errors and the package instance creation or deployment fails, then the step goes into a problem state and the errors are displayed on the Notes tab in the step.

  • Package Instance: Name of the package instance that is created.
  • Package Instance Log: Contains log details about the package instance that was created. You can download this file and save it. This file contains log details that are originally generated in BMC Release Package and Deployment and is available for download from BMC Release Process Management.
  • Package Instances: Provides a URL that takes you to the location where the package instance log file is available on BMC Release Package and Deployment.
  • Deployment Log File: Contains log details about the package instance deployment. You can download this file and save it. This file contains log details that are originally generated in BMC Release Package and Deployment and is available for download from BMC Release Process Management.
  • Deployment Log URL: Provides a URL that takes you to the location where the deployment log file is available on BMC Release Package and Deployment.

Associated resource automation scripts

The RLM create and deploy package instance automation script uses the following resource automation scripts:

Resource automation scripts

Resource automation script

Description

RLM packages

This script is used for retrieving packages that are already existing in the BMC Release Package and Deployment database. The data retrieved by this script is displayed as a list while adding a step in BMC Release Process Management.

Used in the following automation scripts:

  • RLM create and deploy package instance
  • RLM create package instance
  • RLM deploy package instance
  • RLM deploy package instance by name

RLM package content references

This script is used for retrieving data about references associated with the selected package from the BMC Release Package and Deployment database.

Used in the following automation scripts:

  • RLM create and deploy package instance
  • RLM create package instance

RLM routes

This script is used for retrieving data about routes that are already existing in the BMC Release Package and Deployment database. The data retrieved by this script is displayed as a list while adding a step in BMC Release Process Management.

Used in the following automation scripts:

  • RLM create and deploy package instance
  • RLM create and deploy repo instance
  • RLM deploy package instance by name

RLM route environments

This script is used for retrieving data about environments associated with the selected route from the BMC Release Package and Deployment database. The data retrieved by this script is displayed as a list while adding a step in BMC Release Process Management.

Used in the following automation scripts:

  • RLM create and deploy package instance
  • RLM create and deploy repo instance
  • RLM deploy package instance
  • RLM deploy package instance by name
  • RLM deploy repo instance

RLM channels

This script is used for retrieving data about channels associated with the selected route and environment from the BMC Release Package and Deployment database. The data retrieved by this script is displayed as a list while adding a step in BMC Release Process Management.

Used in the following automation scripts:

  • RLM create and deploy package instance
  • RLM create and deploy repo instance
  • RLM deploy package instance
  • RLM deploy package instance by name
  • RLM deploy repo instance

RLM package properties

This script is used for retrieving data about properties associated with the selected package from the BMC Release Package and Deployment database. The data retrieved by this script is displayed as a table of properties with corresponding values.

Used in the following automation scripts:

  • RLM create and deploy package instance
  • RLM create package instance
  • RLM deploy package instance by name

 

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