Creating automation scripts

BMC Release Process Management enables you to integrate with external systems and perform various functions by using the BMC Release Process Management user interface. You can do this either by importing default scripts to perform certain functions or by creating new scripts to perform other functions not enabled by the default scripts. For more information about the integrations supported, the default scripts available for those integrations, and the tasks that you can perform using the default scripts, see Integrating.

You can create the following types of scripts:

• Local ruby—Automation scripts in the Ruby programming language that run on the agent host of the engine that starts an automation step.
• Data retriever—Automation scripts in the Ruby programming language that run on the target servers to obtain the necessary configuration data.

• Remote dispatcher —Automation scripts in the Ruby programming language that run on the engine server. They implement various transport protocols (agent types) for transferring files and executing scripts on remote servers.
  Remote dispatcher scripts are executed based on the agent type of the target server.

  Note

  You can use remote dispatcher automation scripts only in other automation scripts. You cannot use remote dispatcher scripts in steps of a request.

• Local shell—Automation scripts that run on the agent host of the engine that starts an automation step and can be written in any interpreted language available on the engine server.
• Remote shell—Automation scripts that run on the target servers, perform actions specific to the target server, and can be written in any interpreted language available on the target server.

You can also create your own automation script types. For more information, see Managing-automation-types.

To allow or prevent the usage of your automation scripts, you can change the automation script status. For more information, see Using-status-of-objects.

Before you begin

• If you plan to write automation scripts in the programming language other than Ruby, ensure the interpreter for the appropriate programming language is installed on the agent host of the engine that starts the automation step.
• Before you create new automation scripts to perform functions in a particular external system, you must appropriately configure the external system to integrate with BMC Release Process Management. For more information about the configurations required for the various integrations supported, see Integrating.
• Ensure that you have enabled automation by navigating to System > Settings > General and selecting the Enable Automation check box.

To create an automation script:

1. Go to Environment > Automation.
2. On the right pane, click Create Automation.
3. In the To use as list, select one of the following options:
   1. Local Shell
      For more information, see Creating-local-shell-scripts.
   2. Remote Dispatcher
      For more information, see Creating-remote-dispatcher-scripts.
   3. Remote Shell
      For more information, see Creating-remote-shell-scripts.
   4. Local Ruby
      For more information, see Creating-local-ruby-scripts.
   5. Data Retriever
      For more information, see Creating-data-retriever-scripts.
4. (Optional) To make the script available for other users, change the imported automation script status to the state other than Draft.

To change the automation script status

1. Go to Environment > Automation.
2. In the automation scripts list, find the appropriate script.
3. For the required automation script, in the Actions column, click << or >>.
   _{click the image to expand} 
   

For more information about the states available for automation scripts, see Using-status-of-objects.

Related topics

Integrating

Importing-automation-scripts-from-the-library

Mapping-properties