Processes

Process is the top level configuration element which contains all Integrations for the Process concerned (e.g. Incident, Problem, Change, Request etc.).

Process is at the top of the configuration chain in Unifi. It is a mechanism which provides functionality not provided OOTB in ServiceNow. The purpose of a process is to keep like integrations in one place (e.g. Incident process integrations, or Change process integrations).

One Process may contain multiple Integrations which can each be configured separately and uniquely (more on that on the Integrations page).

Automated Creation of REST Service

From v3.0, when you create a Process, Unifi will automatically create* the corresponding Web Service (REST method).

If you change either the Process Name or the API Name**, Unifi will automatically update the corresponding Web Service (REST method).

Please note: deleting a Process will not remove the Web Services or Business Rule. They will need to be removed manually.

*Requires Global Utility

**If you change the API Name for Process created in versions prior to v3.0, ensure that all scripts which use it are also updated. It will break the integration if they are not.

Process Fields

The fields to be configured in the Process record are as follows:

Field

Type

Description

Description

String

A description of what this Process is for and/or how it works.

Target table

Table name

The primary target or process table that this integration uses.

Reference field

Table name

The field on the target table that is used as the reference for the external system.

Stage table*

Table name

The table for storing staged data.

API Name**

String

The unique name of this process for use with the API.

SOAP Service***

Reference

The Scripted SOAP Service that external systems will connect to.

REST Service****

Reference

The Scripted REST API that external systems will connect to.

Message method****

Reference

The REST interface to send messages to.

Action method****

Reference

The REST interface to send attachments to.

Application

Reference

Application containing this record.

*Stage table

This value is automatically populated. All Integrations for this Process will leverage the one Stage table. The Stage is the root staging table for all data mapping.

Stages are created dynamically at the time of data being sent/received. For more information see the Stages page.

**API Name

The API Name is how we identify which Process we are integrating with. The Scripted SOAP/REST Service will reference the API Name (which is why it is important for this to be a unique reference).

***SOAP/REST Service

When building an Integration & after configuring the relevant SOAP Service, populate this field with the relevant value to enable Unifi to include that Service in the packaged Integration.

****REST Service/Message method/Action method

Unifi will automatically populate these fields with the relevant values. The 'Unifi' Scripted REST API is shipped with Unifi. The relevant Message method & Action method (Scripted REST Resources) are automatically created/updated when the Process is created/updated based on the templates contained in the shipped 'Unifi' Scripted REST API.

Last updated