ServiceNow Connector 7.0 Reference

String

Address of the ServiceNow service.

x

One of:

Proxy configuration for the connection.

String

Username.

x

String

Password.

x

One of:

Transport configuration.

TLS

TLS configuration for the connection.

Wss Sign Security Strategy Adapter

WSS configuration for the signature security strategy.

WSS Username Token Security Strategy Adapter

WSS configuration for the username token security strategy.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

Address of ServiceNow service.

x

One of:

Proxy configuration for the connection.

OAuth2 HTTP Message Dispatcher Provider

Custom transport configuration.

TLS

TLS configuration for the connection.

String

String value that you send when the OAuth dance is initiated and that is returned back by the service provider with the token callback.

Wss Sign Security Strategy Adapter

WSS configuration for the signature security strategy.

WSS Username Token Security Strategy Adapter

Username token WSS configuration.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

OAuth consumer key, as registered with the service provider.

x

String

OAuth consumer secret, as registered with the service provider.

x

String

URL of the service provider’s authorization endpoint.

https://{instance-id}.service-now.com/oauth_auth.do

String

URL of the service provider’s access token endpoint.

https://{instance-id}.service-now.com/oauth_token.do

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

String

Resource owner ID to use with the authorization code grant type.

String

Name of the flow to execute immediately before starting the OAuth dance.

String

Name of the flow to execute immediately after receiving an access token.

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

String

Path of the access token callback endpoint.

x

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

String

Name of the configuration to use.

x

String

Timezone.

America/Los_Angeles

String

Name of the table from which to retrieve the records.

x

String

Optional query that filters the result set. The syntax is sysparm_query=. All parameters are case-sensitive. Queries can contain more than one entry, such as [].

Enumeration, one of:

Data retrieval operation for reference and choice fields. Based on this value, retrieves the display value and/or the actual value from the database.

FALSE

Boolean

Flag that indicates whether to exclude table API links for reference fields.

false

String

Character encoding for polls. Overrides the configuration value.

Number

Maximum time to wait for the response to each poll. Overrides the configuration value.

Enumeration, one of:

Time unit for the Read Timeout field.

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Configures how Mule processes streams. The default is to use repeatable streams.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Boolean

Option that enables users to clear a specific field with a null or empty value for the update operation.

false

ConfigurationProvider

Name of the configuration to use to execute this component.

x

String

Name of the ServiceNow table to invoke. Must contain only ASCII letters, digits, and underscores. Invalid names raise SERVICENOW:BAD_REQUEST.

x

String

Operation name of the service.

x

Enumeration, one of:

Chooses which values are returned for reference fields. Possible options are to return sys_ids, display values, or both. Use this option only for get and getRecords operations.

Binary

XML body to include in the SOAP message, with all the required parameters, or null if no parameters are required.

#[payload]

Binary

XML headers to include in the SOAP message.

Object

Attachments to include in the SOAP request.

String

Character encoding for this invocation. Overrides the configuration value.

Number

Maximum time to wait for the response to this invocation. Overrides the configuration value.

Enumeration, one of:

Time unit for the Read Timeout field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

ID of the resource owner for whom to invalidate access.

ConfigurationProvider

Name of the configuration to use to execute this component.

x

String

Username to use.

x

String

Password to use.

x

Number

Read timeout value.

15000

Enumeration, one of:

Time unit for the Read Timeout field.

MILLISECONDS

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Enumeration, one of:

Time unit for the Max Idle Time field.

Enumeration, one of:

String

x

String

Requester configuration.

x

Number

Read timeout value.

15000

Enumeration, one of:

Time unit for the Read Timeout field.

MILLISECONDS

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Number

How many reconnection attempts the Mule app can make.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

Reconnection strategy to use.

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Redelivery Policy Message Identifier

One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is false.

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

String

One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is false.

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

Enumeration, one of:

Unit for the In Memory Size field.

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Enumeration, one of:

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Object

Additional transport data bundled in the response.

Object

Protocol headers bundled in the response.

Object

Set of attachments bounded to the response, or an empty map if there are no attachments.

Binary

XML response body. Represents the <SOAP:BODY> element.

Object

Map of SOAP header names to repeatable XML streams. These are SOAP response headers, not the HTTP protocol headers returned in SoapAttributes.

String

Location of the keystore file.

x

String

Alias of the private key to use.

String

Password to access the store.

x

String

Password used to access the private key.

String

Type of store, such as fjks, pkcs12, jceks, and so on.

jks

Wss Key Store Configuration

Keystore to use when signing the message.

x

WSS Signing Configuration Adapter

Algorithms to use on the signing.

Enumeration, one of:

Key identifier type to use for the signature.

X509_KEY_IDENTIFIER

Enumeration, one of:

Signature algorithm to use. The default is set by the data in the certificate.

Enumeration, one of:

Signature digest algorithm to use.

SHA256

Enumeration, one of:

Defines which signature c14n (canonicalization) algorithm to use.

EXCLUSIVE_XML_CANONICALIZATION_1_0

String

Comma-separated list of protocols to enable for this TLS context.

String

Comma-separated list of cipher suites to enable for this TLS context.

Trust Store

Trust store configuration.

Key Store

Key store configuration.

One of:

Certificate revocation check configuration.

String

Location of the trust store.

String

Password that protects the trust store.

String

Type of store to use.

String

Algorithm to use for the trust store.

Boolean

If true, certificate validation is disabled. Use this setting only when required.

String

Location of the key store.

String

Type of store to use.

String

Alias of the private key to use.

String

Password that protects the private key.

String

Password that protects the key store.

String

Algorithm to use for the key store.

Boolean

Verify only the last certificate in the certificate chain.

Boolean

Try CRL before OCSP.

Boolean

Don’t use the secondary certificate revocation checking method.

Boolean

Avoid a verification failure when the revocation server can’t be reached or is busy.

String

URL of the OCSP responder.

String

Alias of the certificate that signs the OCSP response.

String

Path to the CRL file.

String

Proxy host.

x

Number

Proxy port.

x

String

Username for proxy authentication.

String

Password for proxy authentication.

String

Hosts that bypass the proxy.

String

NTLM domain for proxy authentication.

x

String

Proxy host.

x

Number

Proxy port.

x

String

Username for proxy authentication.

String

Password for proxy authentication.

String

Hosts that bypass the proxy.

String

Username required to authenticate with the service.

x

String

Password for the provided username required to authenticate with the service.

x

Enumeration, one of:

Password parameter.

DIGEST