Creating local ruby scripts

Local ruby scripts are automation scripts written in the Ruby programming language that run on the agent host of the engine that starts the automation step.

Before you create a local ruby script, ensure that you configured an integration server.

You can create new automation categories to sort your local ruby scripts. Also, you can use one of your existing scripts with a Template type as a template for creating new scripts.

To create a local ruby script

1. Go to Environment > Automation.
2. On the right pane, click Create Automation.
3. In the To use as list, select Local Ruby.
4. In the Choose Automation Category list, select one of the available automation categories.
5. In the File Path box, enter the directory path for exporting or importing the automation script.
6. In the Apply template list, select a template that you want to use as a base for creating your script.

7. In the Script integration server list, select that integration server that you want to use for connecting with the external system.

   Warning

   Notes

   • When you select a server from the list, the details related to that integration server are automatically added to the script body.
   • You cannot add an integration server if the script body is empty.
   • A script that you do not plan to use for performing some actions in a particular target external system does not require an integration server.
8. In the Script Name box, enter a unique name for the script.
9. In the Description box, enter a short description for the script.
10. In the Script body area, enter the Ruby code that runs in a step.
    The script body is the core of an automation script. The action that you want to perform and how you want to execute it depends on how you design the arguments and the logic in the script body. For more information about designing the script body, see Designing-the-script-body-of-a-local-ruby-script.
11. In the Script type list, select one of the following options:
    1. Template—To save the script as a template for future use.
    2. System—To save the script as a base script that can be only viewed or copied but not modified by anyone apart from the Administrator.
    3. User—To save the script as a normal script for your personal use and available for viewing, copying, and modifying. 
12. To save the script, click Add script.
13. (Optional) To make the script available for other users, change the automation script status to the state other than Draft.

Related topics

Integrating with various external systems

Mapping-properties

Routines-for-local-ruby-scripts