Integration with Jenkins

To manage / onboard Jenkins 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 existing runbook automation tool.
  3. Select an organization for which you need to create a runbook tool in the Organization Name field.
  4. Type the runbook tool name in the Runbook Tool Name field.
  5. Select Jenkins from the Runbook tool type drop-down.
  6. Select REST as an integration method for Jenkins for the integration method field.
    Figure 1. Manage Runbook Tool
  7. Select one of the Authentication Type from BasicAuth,
    1. Selection of from BasicAuth requires you to enter.
      • User Id
      • Password
  8. Type the URL in the API URL field, sample: https://url.servicenow.com/api/now/v1/table/sc_request?sysparm_fields=#Columns>
  9. Select the integration method type as POST.
  10. Type the username and password in the User Id and Password field to get access to API web service.
    Note:
    API URL, User ID, and Password are dependent on the selected integration method
  11. Specify the path to get consolidate script for the execution of runbook 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.
  12. Select Proxy required, if the environment needs access to contact from the server outside a firewall.
  13. Type the return code in the return code Key field to identify the success or failure of runbook execution. E.g. status
  14. Type the return message key in the return message key field to display the success or failure of runbook execution. E.g. result
  15. Type the Toil Value (for manual execution) which implies the manual execution time of runbook under this tool (in minute)
  16. Type the Toil Value (for auto execution) which implies the manual execution time of runbook under this tool (in minute) if available else it’s a non- mandatory field.
    Figure 2. Manage Runbook Tool (Cont.)
  17. Click Submit/Update for adding a new tool or making changes in an existing tool. An appropriate success message will be displayed.
  18. Type the Connection Retry Count which implies the no. of time connection would be made with RBA tool server in case of connection failure.
    Note:
    The URL of the Jenkins should be of below format:
    Note:
    https://url.servicenow.com/api/now/v1/table/sc_request?sysparm_fields=#Columns