Versions Compared

Old Version 8

changes.mady.by.user Lianne So

Saved on

compared with

New Version Current

changes.mady.by.user Aryn Wiebe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Need help? Contact us:

...

 

The ServiceNow adapter is designed to provide a template for getting started with ServiceNow integrations, includingAPI integrations. It leverages the SERVICENOW Library to:

  1. Authenticating Authenticate with the ServiceNow API via OAuth2.0 (JWT).

  2. Creating Create and retrieving retrieve Incident table records in ServiceNow.

This component can be customized and adapted according to your workflow needs. For example, it could be adapted as a Notifications component that integrates Iguana notifications with an existing support workflow. The ServiceNow Rest API Explorer is useful for reviewing the available API endpoints.

...

Expand
titleStart the component or open the Translator to create the ticket and view the results
Expand
titlemethods/SERVICENOWgetTbRecord - prepares arguments for SERVICENOWcustom to retrieve an incident ticket

  1. Start the ServiceNow component or open the Translator to run the script. If running the script from the Translator, you will need to set the createTbRecord function call’s live parameter to true for the function to execute when viewing from the Translator

    image-20240417-180922.png

  2. If running the script from within the Translator, you can check the created ticket from the results of the getTbRecord function

    image-20240417-180735.png

  3. In ServiceNow, go to Service Desk > Incidents to see the resulting ticket!

image-20240417-153159.png

The SERVICENOW Library:

Expand
titleSERVICENOWclient - sets up the adapter framework

Sets up the ServiceNow Adapter framework, adding the method modules to a metatable and storing the configurations from the custom fields in a table to call the API.

Expand
titleSERVICENOWcustom - makes API requests and returns the response

SERVICENOWcustom takes in any API requests and parameters to make the API call and return the response.

  • First, the function checks if the token key exists or is still valid (based on the key_expiry). If not, it calls SERVICENOWauth to perform the OAuth2.0 authentication workflow to obtain the token to be used in subsequent requests.

  • Uses the passed configurations API request parameters - the method (ex. post), ServiceNow API endpoint (ex. 'now/table/') and parameters for the call (ex. the incident ticket) - to build and carry out the appropriate HTTP request.

Expand
titleauth/SERVICENOWauth - authenticates with the ServiceNow API authorization endpoint /oauth_token.do

The SERVICENOWauth function builds and makes the HTTP POST token request to obtain the access token required for any resource requests against the FHIR Server.

A separate SERVICENOWcreateJWT function creates the JSON Header and Payload components of the JWT and calls SERVICENOWjwt to sign and return the JWT required for the token request.

If the token requests is successful (HTTP 200 response), the token and token expiry returned are stored in the adapter object (key and key_expiry) and saved in an encrypted file via SERVICENOWencrypt.

Expand
titleauth/SERVICENOWencrypt - stores and encrypts the API token and token expiry

SERVICENOWencrypt provides localized https://interfaceware.atlassian.net/wiki/x/EQCeqg functionality via save and load functions that encrypt and decrypt the provided API token and expiry time in an external file. This allows the token to be reused for subsequent API calls.

Expand
titleauth/SERVICENOWjwt - takes the provided parameters and private key to generate and sign the JWT token

SERVICENOWjwt provides localized OAUTH Library functionality. It takes the provided JWT header, JWT payload, signing algorithm, and private key to generate and sign the JWT token.

Expand
titlemethods/SERVICENOWcreateTbRecord - prepares arguments for SERVICENOWcustom to create an incident ticket

SERVICENOWcreateTbRecord prepares the arguments and calls SERVICENOWcustom to create an incident ticket in ServiceNow via HTTP POST request.

SERVICENOWgetTbRecord prepares the arguments and calls SERVICENOWcustom to retrieve an incident ticket in ServiceNow via HTTP GET request.