Integration with ServiceNow Orchestration

To manage / onboard ServiceNow Orchestration as the RBA tool, perform the following steps:

  1. On the main menu bar, click Runbooks, and then click Manage Runbook Tool. The Manage Runbook Tool appears.
  2. Click Add New to add a new tool or click to edit an existing runbook automation tool.
  3. Select an organization for which you need to create runbook tools in the Organization Name field.
  4. Type the runbook tool name in the Runbook Tool Name field.
  5. Select SNOW from the Runbook Tool Type drop-down
  6. Select REST API as the integration method for ServiceNow Orchestration for the Integration Method field.
    Figure 1. Manage Runbook Tool (Cont.)
    A screenshot of a computer AI-generated content may be incorrect.
  7. Select one of the Authentication Type from BasicAuth, OAuth 2.0
    1. Selection of BasicAuth requires you to enter:
      • User Id
      • Password
    2. Selection of OAuth 2.0 requires you to enter:
      • Authentication URL
      Figure 2. Manage Runbook Tool (Cont.)
      A screenshot of a computer Description automatically generated
  8. Click Add Authentication Parameters to add more parameters, as depicted below -
    Figure 3. Manage Runbook Tool (Cont.)
    A screenshot of a computer Description automatically generated
  9. Integration Section:
    1. Type the URL in the API URL. field.

      Sample URL - http://<URL/IP>:<PORT>/api/26803/run_book_center/

    2. Select the Integration Method Type as POST
    3. Type the return code key in the Return Code Key field to identify the success or failure of runbook execution. E.g. ReturnCode
    4. Type the return message key in the Return Message Key field to display the success or failure of runbook execution. E.g. ReturnMessage
  10. Authnetication Section:
    1. Type the username and password in the User ID and Password field to get access to API web services.
      Note:
      API URL, User ID, and Password are dependent on the selected integration method.
  11. Base Section:
    1. Specify the path to get the consolidated scripts for the execution of runbooks in the Master Runbook Path field. This will be provided by respective Runbook Tool teams if they have a master runbook.
      Note:
      This is not a mandatory field. Users can change and run these scripts any time.
    2. Select Proxy Required, if the environment needs access to content from servers outside a firewall.
    3. Type the Toil Value (For Manual Execution) which implies the manual execution time of runbook under this tool (in minutes).
    4. Type the Toil Value (For Auto Execution) which implies the auto execution time of runbook under this tool (in minutes), if available else it’s a non-mandatory field.
    5. Enter the value in Connection Retry Count* field which shows the retry count in case the connection with RBA tool fails.
      Figure 4. Manage Runbook Tool (Cont.)
      A screenshot of a computer AI-generated content may be incorrect.
  12. Click Submit / Update for adding a new tool or making changes to an existing tool. An appropriate success message will be displayed.