String
ServiceNow Connector 6.9 Reference - Mule 4
Anypoint Connector for ServiceNow (ServiceNow Connector) provides connections between Mule runtime engine (Mule) and ServiceNow apps.
Configurations
Config
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
The name for 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 as appropriate. |
Connection Types
Basic Authentication
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Service Address |
String |
Address of the ServiceNow service. |
x |
|
ServiceNow Version |
Enumeration, one of:
|
ServiceNow API Version. |
QUEBEC |
|
User Tables List |
Array of String |
List of user-defined tables |
||
Encoding |
String |
Character encoding |
UTF-8 |
|
User Name |
String |
User Name |
x |
|
Password |
String |
Password |
x |
|
Transport Configuration |
||||
Sign Security Strategy |
A WSS configuration for the signature security strategy |
|||
Username Token Security Strategy |
A WSS configuration for the username token security strategy |
|||
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 |
OAuth 2.0 Authorization Code
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Service Address |
String |
Address of ServiceNow service. |
x |
|
ServiceNow Version |
Enumeration, one of:
|
ServiceNow API Version. |
QUEBEC |
|
User Tables List |
Array of String |
List of user-defined tables |
||
Encoding |
String |
Character encoding |
UTF-8 |
|
Custom Transport Configuration |
||||
Sign Security Strategy |
A WSS configuration for the signature security strategy |
|||
Username Token Security Strategy |
A usernameToken WSS configuration |
|||
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 |
|||
Consumer Key |
String |
The OAuth consumerKey as registered with the service provider |
x |
|
Consumer Secret |
String |
The OAuth consumerSecret as registered with the service provider |
x |
|
Authorization Url |
String |
The service provider’s authorization endpoint URL |
|
|
Access Token Url |
String |
The service provider’s accessToken endpoint URL |
|
|
Scopes |
String |
The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation |
||
Resource Owner Id |
String |
The Resource Owner ID to use with each component that doesn’t otherwise reference a Resource Owner ID. |
||
Before |
String |
The name of a flow to execute right before starting the OAuth dance |
||
After |
String |
The name of a flow to execute right after an accessToken has been received |
||
Listener Config |
String |
A reference to a <http:listener-config /> to use to create the listener that will catch the access token callback endpoint. |
x |
|
Callback Path |
String |
The path of the access token callback endpoint |
x |
|
Authorize Path |
String |
The path of the local http endpoint which triggers the OAuth dance |
x |
|
External Callback Url |
String |
If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback |
||
Object Store |
String |
A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store. |
Operations
Invoke
<servicenow:invoke>
This is the default operation for ServiceNow SOAP invocations.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Service |
String |
x |
||
Operation |
String |
The operation name of the service |
x |
|
Show Reference Values |
String |
Choose which values are returned for reference fields. Possible options are to return |
||
Body |
Binary |
The XML body to include in the SOAP message, with all the required parameters, or null if no parameters are required. |
|
|
Headers |
Binary |
The XML headers to include in the SOAP message. |
||
Attachments |
Object |
The attachments to include in the SOAP request. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Unauthorize
<servicenow:unauthorize>
This operation deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the OAuth dance.
Types
Wss Sign Security Strategy Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key Store Configuration |
The keystore to use when signing the message. |
x |
||
Sign Algorithm Configuration |
The algorithms to use on the signing. |
Wss Key Store Configuration
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key Store Path |
String |
x |
||
Alias |
String |
|||
Password |
String |
x |
||
Key Password |
String |
|||
Type |
String |
jks |
WSS Signing Configuration Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Signature Key Identifier |
Enumeration, one of:
|
|
||
Signature Algorithm |
Enumeration, one of:
|
|||
Signature Digest Algorithm |
Enumeration, one of:
|
|
||
Signature C14n Algorithm |
Enumeration, one of:
|
|
WSS Username Token Security Strategy Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Username |
String |
The username required to authenticate with the service. |
x |
|
Password |
String |
The password for the provided username required to authenticate with the service. |
x |
|
Password Type |
Enumeration, one of:
|
A #password parameter. |
|
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 |
||
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. |
||
blocking |
Boolean |
If |
|
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
blocking |
Boolean |
If |
|
Pooling Profile
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Active |
Number |
Controls the maximum number of Mule components that can be borrowed from 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 the specified value for maxActive is exceeded, the pool is considered 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 may 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 may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be 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:
|
Specifies the behavior of the Mule component pool when the pool is exhausted:
If a positive |
||
Initialisation Policy |
Enumeration, one of:
|
Determines how to initialize components in a pool:
|
Disabled |
OAuth2 HTTP Message Dispatcher Provider
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Read Timeout |
Number |
|
||
Read Timeout Unit |
Enumeration, one of:
|
|
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 is allowed to be idle before it’s considered eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the Max idle time attribute. |
SOAP Output Envelope
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Attachments |
Object |
|||
Body |
Binary |
|||
Headers |
Object |
SOAP Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Additional Transport Data |
Object |
|||
Protocol Headers |
Object |