Create Runbook

This section describes the steps required to create a Runbook, including the metadata and scripts.

To create a Runbook, perform the following steps:

  1. On the main menu bar, click Runbooks and then Create Runbook. The Create Runbook page appears.
    Figure 1. Create Runbook
  2. Select a runbook tool to specify the runbook by clicking the drop-down arrow next to the Runbook Tool field.
  3. Users can upload multiple scripts simultaneously using the Upload option or type the script for each runbook in the Script Text field.
  4. Type a runbook name for the new runbook in the Runbook Name field.
  5. Type a runbook friendly name in the Runbook Friendly Name field to easily recognize the runbook in your repository.
  6. Selecting Runbook Tool as ‘BigFix’ enables three more fields:
    1. Response File Path: Type the file location where the response is to be read.
    2. Wait Frequency Interval: Frequency Interval, which is fixed by the user to wait before going to fetch the response post runbook execution. This frequency varies with the type of runbook in terms of SS (seconds), MM (minutes), or HH (hours).
    3. Wait Frequency: The time interval to wait before going to fetch the response.
  7. Specify the path where the master runbook is located within the runbook tool in the Master Runbook Path field.
  8. Specify the name of the master runbook in the Master Runbook Name field.
  9. Type the runbook description in the Runbook Description field.
  10. Type the user-friendly runbook description in the User Runbook Friendly Description field.
  11. Type the Frequency Interval, which is fixed by a user to fetch the status post runbook execution. This frequency varies with the type of runbook in terms of SS (seconds), MM (minutes), or HH (hours).
  12. Specify the frequency of runbook updates in the Update Frequency field.
    Figure 2. Create Runbook (Cont.)
    Note:
    Frequency Interval and Update Frequency are inter-related.
  13. Type the runbook tool category in the Category field.
  14. Type the sub-category of the runbook tool in the Sub-Category field.
  15. Specify the details of a runbook tool category in the Category Granular Details field.
  16. Type the runbook category in Runbook Category field.
  17. Specify the action to be taken by the runbook in the Runbook Actions field.
  18. Specify the Maximum Attempt Count for the runbook to retry in case of failure.
  19. Enter the Toil Value (For Manual Execution) which is the maximum manual execution time of runbook (in minutes). By default, it takes the value of the configured Toil Value (For Manual Execution) for the selected Runbook tool.
  20. Enter the Toil Value (For Auto Execution) which is the maximum auto execution time of runbook (in minutes). By default, it takes the value of the configured Toil Value (For Auto Execution) for the selected Runbook tool.
  21. Enter the Wait Frequency for Status Update (in minutes) for the case when RBA is unable to update execution status back to iAutomate after successful interaction (in case Push Notification is enabled).
  22. Type a tag for a runbook next to the Runbook Tags field and click Add. Added tags appear in a box below the Add button.
    Figure 3. Create Runbook (Cont.)
  23. If required, select Enable Auto Execution to enable auto execution of the runbook.
  24. Enter the Auto Execution Threshold so that the runbook above this threshold will be auto executed if auto execution is enabled.
  25. Once the above values are added successfully, provide the following parameters for runbook execution while ticket parsing.
    1. Parameter Name- Specifies a name of the parameter to be used in runbook for ticket parsing.
    2. Parameter Label- Specifies a unique user-friendly name for the parameter.
    3. Is Mandatory- Select True or False depending on if the parameter details added are mandatory or not.
    4. Parameter Description- Describes the parameter.
    5. Default Parameter Value - Specifies the default value for the parameter.
    6. Field Type- Specifies the data type used in the parameter field. It may be of the following types:
      • Text: The parameter will be saved in plaintext in the database.
      • SecureParameter: The parameter will be saved in encrypted form in Database.
      Note:
      The SecureParameter has specific significance in the case of BigFix tool where this kind of parameter is passed in a different manner to bigfix.

      The parameters which are marked as SecureParameter will be hidden and disabled on Tickets page when runbook is being selected for execution.

    7. Parameter Type- It lists all the parameter types configured in Configure Parameter Type . On selecting the parameter type, iAutomate fetches the related data for ticket parsing.
    8. IsScript Parameter- Check the checkbox if the parameter is the part of Script uploaded.
    9. IsCiBased Parameter- Check the checkbox if the parameter is a CI based parameter. It is mandatory to have at least one parameter as CI based parameter.
    10. IsReadOnly Parameter- Check the checkbox if parameter is read only and user cannot update the same whenever it is parsed.
    11. Action- Enables user to add, edit or delete the existing parameter by clicking respective buttons.
  26. Click Save to configure the newly added runbook to the selected runbook tool.
    Figure 4. Create Runbook (Cont.)
  27. It adds a new Runbook and lists it in a tabular view.