Redwood Automation Connector ServiceNow Application
The Redwood Automation Connector is an application that is available in the ServiceNow app store. It provides tables, views, and additional functionality in ServiceNow to provide two-way communication with RunMyJobs. Follow the instructions on the Redwood Automation Connector listing in the ServiceNow App Store to install the Redwood Automation Connector application into your ServiceNow instance.
The Redwood Automation Connector provides a Guided Setup page (Redwood Guided Setup) to guide you through the configuration process. The configuration process should be performed by someone with administrative permissions in ServiceNow. They will need permissions to create the integration user, and also need the x_rsnbv_redwood_nw.admin role to be able to see and edit the configuration page.
-
Set up an Integration user: This is the user that you will use in the ServiceNow Connection object in the Redwood Scheduler to perform the actions in ServiceNow. Grant the user the roles defined in the setup process.
-
Configuration Page:
-
API Details: Here you can configure the connection information for RunMyJobs. This is only required if you plan to use the functionality where ServiceNow performs actions in RunMyJobs (running Processes, responding to User Messages, etc). After you fill out all the details, use the Test Connection button to test the connection to RunMyJobs.
Note: If you only want to use a one-way integration from Redwood to ServiceNow (using the Redwood Process Definitions to create/update ServiceNow incidents), you can skip this section.
-
Redwood Instance URL: This is the full URL for the extension point in RunMyJobs. This should be:
<RunMyJobs endpoint>/api-extension/External/REDWOOD/Redwood_ServiceNow/rest/v1
. For example:https://region.runmyjobs.cloud/mycompany/test/api-extension/External/REDWOOD/Redwood_ServiceNow/rest/v1
-
Redwood Application API Key: To communicate with RunMyJobs, ServiceNow requires a valid RunMyJobs API Key. Create an API key for the desired user, then paste the key value into this field in ServiceNow.
-
Mid Server: If RunMyJobs is not directly accessible from ServiceNow, the communication from ServiceNow to RunMyJobs can be routed through a Mid Server. Provide the name of an existing Mid Server that has connectivity with RunMyJobs.
-
ServiceNow Integration User: Enter the name of the Integration User that was created during the guided setup.
-
-
Incident Management: This section lets you provide default values for some incident fields for incidents that are created by RunMyJobs. Use these fields to provide default category, sub-category, configuration item, and contact type if desired.
-
Available Actions
The following actions are available in the Redwood Automation Connector application.
Responding to Redwood Incidents
The Incidents view in the Redwood Automation Connector is different from the regular Incidents table. This will only show incidents that were created from RunMyJobs that require some type of response (e.g., incidents created with the Redwood_SNOW_UserMessage Process Definition). If you click one of the incidents from this table view, you will see a Process Remediation tab with a dropdown list. These options directly map to the options that were provided by the Redwood User Message. If you select an option and click Execute, the Connector will respond to the User Message that opened the incident, allowing the RunMyJobs workflow to continue.
Required Roles: x_rsnbv_redwood_nw.user
Configuring Background Jobs
In the Background Jobs view, you can configure scripts to run either on a schedule or on-demand to perform actions in the ServiceNow platform. These scripts can be invoked from RunMyJobs using the Redwood_SNOW_RunJob Process Definition.
Log messages from these scripts (output from gs.info()
statements or error details if the script fails) can be found in the Redwood Logs view.
Required Roles: x_rsnbv_redwood_nw.admin
Importing and Running Redwood Processes
The Redwood Automation Connector allows you to invoke Redwood Processes from within ServiceNow. To import Redwood Processes into ServiceNow, use the Gather Processes button on the App Configuration page (this will only work after you have configured the connection to the Redwood Scheduler). When you do this, any Redwood Processes that have been exported as a Web Service will be imported into the ServiceNow instance. You can see the list of imported processes in the Redwood Processes view in the Redwood Automation Connector application.
To run a process, select it from the list in the Redwood Processes view. On the page that opens describing the Process, click the Submit Published Process button. This will open a dialog allowing you to configure details for the process run, such as the Description, Queue, Submit Frame, and process parameters.
Required Roles:
-
x_rsnbv_redwood_nw.admin to import processes from the Configuration page.
-
x_rsnbv_redwood_nw.user to view the Redwood Processes page.