Configuration

  • Updated on Feb 20, 2025
Prev Next

This section of the guide provides information on how to configure an Itential Platform instance using the Itential ServiceNow Application within the ServiceNow platform.

Related Reading:

How to set up OAuth ➟ Using Service Accounts to Access Itential Cloud APIs

Configure the Itential Instance

  1. Click the All tab at the top left-hand corner, click the Itential drop-down menu, and then select the Itential Platform Instances Config option.
  2. Click the Instance you want to configure, or click the New icon (top right-hand corner) to configure a new instance.
  3. Type the Name, IP Address (or Hostname) with the port number in the the respective fields.
    1. You may have to unlock the hostname. The IP/Hostname should be the URL of the Itential server (e.g. https://myIP.com:3443). HTTPS will be required.

Figure 1: Itential Platform Instances Config
01 IP Instances Config

 

Figure 2: Instances Table
02 Instances Table
 

Figure 3: New Instance Config Form
03 New Instance Config Form
 

  1. Select the auth_type. This field was added in the latest version since the Password field is masked whether it has a value or not. Of note, the application and actions should work whether this field is provided or not.
  2. Provide your credentials based on the type of authentication you are using. Credentials will appear masked as you type them and when they are displayed in the table.
    1. Username/Password
    2. API Key requires a static token.
    3. OAuth 2.0 requires a client_id and client_secret to retrieve a token.
  3. Add the Roles that have access to this Itential Platform Instance.
  4. If using a MID Server to communicate with Itential Platform, provide the reference to the MID Server and the MID Server name.
    1. To find the reference, use the search icon (magnifying glass) at the end of the MID_server field.
    2. The reference is utilized by Itential Actions and the name is critical for the Client GUI React Application.
  5. Input the request_timeout to set the timeout for the API calls to Itential Platform. If it is not provided, the default timeout within ServiceNow will be used.
  6. Click Submit (upper-right corner) to set the new instance configurations.

Figure 4: Submit New Instance Configurations
04 Submit New Instance Configurations

Permission Settings

The ServiceNow Application requires the user to have certain permissions within Itential Platform (Itential Cloud).

OnPrem Role SaaS Role Itential Platform Description
admin admin Adapter or Application Ability to get dynamic data from an adapter or Itential Platform Application requires additional permissions. This includes admin for the specific adapter.
apiread forms:read JSON Forms Ability to get a JSON Form associated with the trigger.
apiread cloud-automation:read Operations Manager Ability to get a list of automations from Itential Platform.
apiread workflows:triggers:read Operations Manager Ability to get triggers for an automation from Itential Platform.
apiread jobs:read
cloud-job:read		 Operations Manager Ability to get information on a triggered Job from Itential Platform.
apiwrite jobs:write
cloud-automation		 Workflow Engine Ability to execute a trigger.

To read how Itential Cloud governs role permissions see → Itential Cloud Group Administration

Figure 5: Roles - JSON Forms
05 Roles JSON Forms
 

Figure 6: Roles - Operations Manager
06 Roles Ops Manager
 

Figure 7: Roles - Workflow Engine
07 Roles Workflow Engine