Contact Free trial Login

ServiceNow Connector Technical Reference

Configurations


Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name of this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances based on internal criteria.

Connection Types

Basic Connection
Parameters
Name Type Description Default Value Required

Username

String

x

Password

String

x

Service Address

String

x

ServiceNow Version

Enumeration, one of:

  • EUREKA

  • FUJI

  • GENEVA

  • HELSINKI

  • ISTANBUL

  • JAKARTA

  • KINGSTON

  • MADRID

MADRID

User Table List

Array of String

Transport Configuration

x

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn't pass after exhausting the associated reconnection strategy.

Pooling Profile

Characteristics of the connection pool.

Supported Operations

Operations

Invoke

<servicenow:invoke>

invokes Web Service operations

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Service

String

x

Operation

String

x

Body

Binary

The XML body to include in the SOAP message, with all the required parameters.

#[payload]

Headers

Binary

The XML headers to include in the SOAP message.

Attachments

Object

The attachments to include in the SOAP request.

Headers

Object

The headers to set in the transport configuration.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression that evaluates against the operation's output and stores the outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

SOAP Output Payload

Attributes Type

For Configurations

Throws

  • SERVICENOW:RETRY_EXHAUSTED

  • MULE:ANY

  • SERVICENOW:SOAP_FAULT

  • MULE:RETRY_EXHAUSTED

  • SERVICENOW:BAD_RESPONSE

  • SERVICENOW:TIMEOUT

  • SERVICENOW:CONNECTIVITY

  • SERVICENOW:BAD_REQUEST

  • SERVICENOW:CANNOT_DISPATCH

  • MULE:CONNECTIVITY

  • SERVICENOW:ENCODING

  • SERVICENOW:INVALID_WSDL

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be active in a session at one time. When set to a negative value, there is no limit to the number of components that can be active at one time. When maxActive is exceeded, the pool is exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that can be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object can sit idle in the pool before it is eligible for eviction. When non-positive, no objects are evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are:

"WHEN_EXHAUSTED_FAIL", which throws a NoSuchElementException

"WHEN_EXHAUSTED_WAIT", which blocks by invoking Object.wait(long) until a new or idle object is available, or

"WHEN_EXHAUSTED_GROW", which creates a new Mule instance and returns it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it blocks for at most that many milliseconds, after which a NoSuchElementException is thrown. If maxThreadWait is a negative value, it blocks indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (doesn’t load any components into the pool on startup), INITIALISE_ONE (loads one initial component into the pool on startup), or INITIALISE_ALL (loads all components in the pool on startup).

Disabled

Boolean

Whether pooling should be disabled

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

SOAP Output Payload

Field Type Description Default Value Required

Attachments

Object

Body

Binary

Headers

Object

SOAP Attributes

Field Type Description Default Value Required

Protocol Headers

Object

Basic Auth HTTP Message Dispatcher Provider

Field Type Description Default Value Required

Username

String

x

Password

String

x

Read Timeout

Number

30000

HTTP Requester Based Transport Provider

Field Type Description Default Value Required

Requester Config

String

x

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.