Informatica Business 360 Connector 1.0 Reference
|
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. |
Configurations
Default Configuration
Default configuration for the connector.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types to provide to this configuration. |
x |
||
Name |
String |
The identifier of this element used to reference it in other components. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
Login V2 Connection Provider
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Base URL |
String |
Base URL for the Informatica MDM API. |
x |
|
Username |
String |
The username used to authenticate requests. |
x |
|
Password |
String |
The password used to authenticate requests. |
x |
|
Connection Timeout |
Number |
Connection timeout for the request. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Whether to use persistent HTTP connections for outbound requests. |
true |
|
Max Connections |
Number |
Maximum simultaneous outbound connections, unlimited by default. |
-1 |
|
Connection Idle Timeout |
Number |
Time a connection can stay idle before closing. Applies only when persistent connections are enabled. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Stream Response |
Boolean |
When enabled, allows processing to begin after headers are parsed. The response must be read eventually to avoid memory issues. |
false |
|
Response Buffer Size |
Number |
Space in bytes for the buffer where the HTTP response is stored. |
-1 |
|
Token Refresh Interval (minutes) |
Number |
Interval in minutes at which the session token is refreshed. |
25 |
|
Proxy Configuration |
HTTP proxy configuration for outbound requests. |
|||
TLS Configuration |
When using HTTPS, the TLS configuration used to secure the connection. |
|||
Default Headers |
Array of Default Header |
Custom headers to include in every request. |
||
Default Query Parameters |
Array of Default Query Param |
Custom query parameters to include in every request. |
||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test does not pass after exhausting the associated reconnection strategy. |
Login V3 Connection Provider
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Base URL |
String |
Base URL for the Informatica MDM API. |
x |
|
Username |
String |
The username used to authenticate requests. |
x |
|
Password |
String |
The password used to authenticate requests. |
x |
|
Connection Timeout |
Number |
Connection timeout for the request. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Whether to use persistent HTTP connections for outbound requests. |
true |
|
Max Connections |
Number |
Maximum simultaneous outbound connections, unlimited by default. |
-1 |
|
Connection Idle Timeout |
Number |
Time a connection can stay idle before closing. Applies only when persistent connections are enabled. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Stream Response |
Boolean |
When enabled, allows processing to begin after headers are parsed. The response must be read eventually to avoid memory issues. |
false |
|
Response Buffer Size |
Number |
Space in bytes for the buffer where the HTTP response is stored. |
-1 |
|
Token Refresh Interval (minutes) |
Number |
Interval in minutes at which the session token is refreshed. |
25 |
|
Proxy Configuration |
HTTP proxy configuration for outbound requests. |
|||
TLS Configuration |
When using HTTPS, the TLS configuration used to secure the connection. |
|||
Default Headers |
Array of Default Header |
Custom headers to include in every request. |
||
Default Query Parameters |
Array of Default Query Param |
Custom query parameters to include in every request. |
||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test does not pass after exhausting the associated reconnection strategy. |
Create Entity
<informatica-b360:create-entity>
Creates a master data record in Informatica Business 360.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Business entity or object type identifier (for example, |
x |
|
Source System |
String |
Internal ID of the source system. |
x |
|
Payload |
Any |
Request body for the create operation. |
x |
|
Source Primary Key |
String |
Primary key of the source record. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Output Encoding |
String |
The encoding of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Additional query parameters to send with the request. |
||
Custom Headers |
Object |
Additional HTTP headers to send with the request. |
||
Target Variable |
String |
Name of the variable that stores 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. |
#[payload] |
|
Error Mappings |
Array of Error Mapping |
Set of error mappings. |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
INFORMATICA-B360:BAD_GATEWAY
-
INFORMATICA-B360:BAD_REQUEST
-
INFORMATICA-B360:CLIENT_ERROR
-
INFORMATICA-B360:CONNECTIVITY
-
INFORMATICA-B360:FORBIDDEN
-
INFORMATICA-B360:GATEWAY_TIMEOUT
-
INFORMATICA-B360:NOT_FOUND
-
INFORMATICA-B360:RATE_LIMITED
-
INFORMATICA-B360:REQUEST_TIMEOUT
-
INFORMATICA-B360:RETRY_EXHAUSTED
-
INFORMATICA-B360:SERVER_BUSY
-
INFORMATICA-B360:SERVER_ERROR
-
INFORMATICA-B360:SERVICE_ERROR
-
INFORMATICA-B360:UNAUTHORIZED
Delete Entity
<informatica-b360:delete-entity>
Removes data from Business 360.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Business entity or object type identifier (for example, |
x |
|
Business ID |
String |
Unique business identifier of the master record. |
x |
|
Source System |
String |
Internal ID of the source system. |
x |
|
Source Primary Key |
String |
When specified, deletes only the source record instead of the master record. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Output Encoding |
String |
The encoding of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Additional query parameters to send with the request. |
||
Custom Headers |
Object |
Additional HTTP headers to send with the request. |
||
Target Variable |
String |
Name of the variable that stores 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. |
#[payload] |
|
Error Mappings |
Array of Error Mapping |
Set of error mappings. |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
INFORMATICA-B360:BAD_GATEWAY
-
INFORMATICA-B360:BAD_REQUEST
-
INFORMATICA-B360:CLIENT_ERROR
-
INFORMATICA-B360:CONNECTIVITY
-
INFORMATICA-B360:FORBIDDEN
-
INFORMATICA-B360:GATEWAY_TIMEOUT
-
INFORMATICA-B360:NOT_FOUND
-
INFORMATICA-B360:RATE_LIMITED
-
INFORMATICA-B360:REQUEST_TIMEOUT
-
INFORMATICA-B360:RETRY_EXHAUSTED
-
INFORMATICA-B360:SERVER_BUSY
-
INFORMATICA-B360:SERVER_ERROR
-
INFORMATICA-B360:SERVICE_ERROR
-
INFORMATICA-B360:UNAUTHORIZED
Partial Update Entity
<informatica-b360:partial-update-entity>
Applies partial changes to an existing master record using a list of update operations (for example, JSON patch), without sending a full entity replacement.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Business entity or object type identifier (for example, |
x |
|
Business ID |
String |
Unique business identifier of the master record. |
x |
|
Source System |
String |
Internal ID of the source system. |
x |
|
Update Operations |
Array of Any |
Partial update operations to apply to the entity (for example, JSON patch operations). |
x |
|
Resolve Crosswalk |
Boolean |
Standardize picklist values based on source system configuration. |
false |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Output Encoding |
String |
The encoding of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Additional query parameters to send with the request. |
||
Custom Headers |
Object |
Additional HTTP headers to send with the request. |
||
Target Variable |
String |
Name of the variable that stores 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. |
#[payload] |
|
Error Mappings |
Array of Error Mapping |
Set of error mappings. |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
INFORMATICA-B360:BAD_GATEWAY
-
INFORMATICA-B360:BAD_REQUEST
-
INFORMATICA-B360:CLIENT_ERROR
-
INFORMATICA-B360:CONNECTIVITY
-
INFORMATICA-B360:FORBIDDEN
-
INFORMATICA-B360:GATEWAY_TIMEOUT
-
INFORMATICA-B360:NOT_FOUND
-
INFORMATICA-B360:RATE_LIMITED
-
INFORMATICA-B360:REQUEST_TIMEOUT
-
INFORMATICA-B360:RETRY_EXHAUSTED
-
INFORMATICA-B360:SERVER_BUSY
-
INFORMATICA-B360:SERVER_ERROR
-
INFORMATICA-B360:SERVICE_ERROR
-
INFORMATICA-B360:UNAUTHORIZED
Read Entity
<informatica-b360:read-entity>
Fetches a master record.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Business entity or object type identifier (for example, |
x |
|
Business ID |
String |
Unique business identifier of the master record. |
x |
|
Skip Lookup |
Boolean |
Retrieve picklist values from cache instead of the data store. |
false |
|
Show Content Metadata |
Boolean |
Include trust scores and survivorship configuration. |
false |
|
Show Pending |
Boolean |
Retrieve only master records pending review. |
false |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Output Encoding |
String |
The encoding of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Additional query parameters to send with the request. |
||
Custom Headers |
Object |
Additional HTTP headers to send with the request. |
||
Target Variable |
String |
Name of the variable that stores 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. |
#[payload] |
|
Error Mappings |
Array of Error Mapping |
Set of error mappings. |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
INFORMATICA-B360:BAD_GATEWAY
-
INFORMATICA-B360:BAD_REQUEST
-
INFORMATICA-B360:CLIENT_ERROR
-
INFORMATICA-B360:CONNECTIVITY
-
INFORMATICA-B360:FORBIDDEN
-
INFORMATICA-B360:GATEWAY_TIMEOUT
-
INFORMATICA-B360:NOT_FOUND
-
INFORMATICA-B360:RATE_LIMITED
-
INFORMATICA-B360:REQUEST_TIMEOUT
-
INFORMATICA-B360:RETRY_EXHAUSTED
-
INFORMATICA-B360:SERVER_BUSY
-
INFORMATICA-B360:SERVER_ERROR
-
INFORMATICA-B360:SERVICE_ERROR
-
INFORMATICA-B360:UNAUTHORIZED
Restore Entity
<informatica-b360:restore-entity>
Recovers a master record that was previously deleted.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Business entity or object type identifier (for example, |
x |
|
Business ID |
String |
Unique business identifier of the deleted master record. |
x |
|
Source System |
String |
Internal ID of the source system. |
x |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Output Encoding |
String |
The encoding of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Additional query parameters to send with the request. |
||
Custom Headers |
Object |
Additional HTTP headers to send with the request. |
||
Target Variable |
String |
Name of the variable that stores 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. |
#[payload] |
|
Error Mappings |
Array of Error Mapping |
Set of error mappings. |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
INFORMATICA-B360:BAD_GATEWAY
-
INFORMATICA-B360:BAD_REQUEST
-
INFORMATICA-B360:CLIENT_ERROR
-
INFORMATICA-B360:CONNECTIVITY
-
INFORMATICA-B360:FORBIDDEN
-
INFORMATICA-B360:GATEWAY_TIMEOUT
-
INFORMATICA-B360:NOT_FOUND
-
INFORMATICA-B360:RATE_LIMITED
-
INFORMATICA-B360:REQUEST_TIMEOUT
-
INFORMATICA-B360:RETRY_EXHAUSTED
-
INFORMATICA-B360:SERVER_BUSY
-
INFORMATICA-B360:SERVER_ERROR
-
INFORMATICA-B360:SERVICE_ERROR
-
INFORMATICA-B360:UNAUTHORIZED
Search
<informatica-b360:search>
Runs a search against a business entity type.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Business entity GUID (for example, |
x |
|
Query |
Any |
Search query body in JSON format with |
x |
|
Page Size |
Number |
Number of records per page (maximum 10000). |
50 |
|
Record Offset |
Number |
Number of records to skip before returning results. |
0 |
|
Records To Return |
Number |
Total number of records to return ( |
-1 |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes iterable results. Repeatable iteration is the default behavior. |
||
Custom Query Parameters |
Object |
Additional query parameters to send with the request. |
||
Custom Headers |
Object |
Additional HTTP headers to send with the request. |
||
Target Variable |
String |
Name of the variable that stores 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. |
#[payload] |
|
Error Mappings |
Array of Error Mapping |
Set of error mappings. |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
INFORMATICA-B360:BAD_GATEWAY
-
INFORMATICA-B360:BAD_REQUEST
-
INFORMATICA-B360:CLIENT_ERROR
-
INFORMATICA-B360:CONNECTIVITY
-
INFORMATICA-B360:FORBIDDEN
-
INFORMATICA-B360:GATEWAY_TIMEOUT
-
INFORMATICA-B360:NOT_FOUND
-
INFORMATICA-B360:RATE_LIMITED
-
INFORMATICA-B360:REQUEST_TIMEOUT
-
INFORMATICA-B360:RETRY_EXHAUSTED
-
INFORMATICA-B360:SERVER_BUSY
-
INFORMATICA-B360:SERVER_ERROR
-
INFORMATICA-B360:SERVICE_ERROR
-
INFORMATICA-B360:UNAUTHORIZED
Search Match V1
<informatica-b360:search-match-v1>
Invokes Informatica Business 360 match (fuzzy matching) for a record against a published match model on the selected object type.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Business entity GUID for an entity with a published match model (for example, |
x |
|
Payload |
Any |
JSON body with |
x |
|
Match Model |
String |
Unique identifier of a published match model. |
||
Version |
Number |
Match model version number (defaults to the latest version). |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Output Encoding |
String |
The encoding of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Additional query parameters to send with the request. |
||
Custom Headers |
Object |
Additional HTTP headers to send with the request. |
||
Target Variable |
String |
Name of the variable that stores 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. |
#[payload] |
|
Error Mappings |
Array of Error Mapping |
Set of error mappings. |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
INFORMATICA-B360:BAD_GATEWAY
-
INFORMATICA-B360:BAD_REQUEST
-
INFORMATICA-B360:CLIENT_ERROR
-
INFORMATICA-B360:CONNECTIVITY
-
INFORMATICA-B360:FORBIDDEN
-
INFORMATICA-B360:GATEWAY_TIMEOUT
-
INFORMATICA-B360:NOT_FOUND
-
INFORMATICA-B360:RATE_LIMITED
-
INFORMATICA-B360:REQUEST_TIMEOUT
-
INFORMATICA-B360:RETRY_EXHAUSTED
-
INFORMATICA-B360:SERVER_BUSY
-
INFORMATICA-B360:SERVER_ERROR
-
INFORMATICA-B360:SERVICE_ERROR
-
INFORMATICA-B360:UNAUTHORIZED
Update Entity
<informatica-b360:update-entity>
Replaces an existing master record with the full payload.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Business entity or object type identifier (for example, |
x |
|
Business ID |
String |
Unique business identifier of the master record. |
x |
|
Source System |
String |
Internal ID of the source system. |
x |
|
Payload |
Any |
Request body for the update operation. |
x |
|
Resolve Crosswalk |
Boolean |
Standardize picklist values based on source system configuration. |
false |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Output Encoding |
String |
The encoding of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
Additional query parameters to send with the request. |
||
Custom Headers |
Object |
Additional HTTP headers to send with the request. |
||
Target Variable |
String |
Name of the variable that stores 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. |
#[payload] |
|
Error Mappings |
Array of Error Mapping |
Set of error mappings. |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
INFORMATICA-B360:BAD_GATEWAY
-
INFORMATICA-B360:BAD_REQUEST
-
INFORMATICA-B360:CLIENT_ERROR
-
INFORMATICA-B360:CONNECTIVITY
-
INFORMATICA-B360:FORBIDDEN
-
INFORMATICA-B360:GATEWAY_TIMEOUT
-
INFORMATICA-B360:NOT_FOUND
-
INFORMATICA-B360:RATE_LIMITED
-
INFORMATICA-B360:REQUEST_TIMEOUT
-
INFORMATICA-B360:RETRY_EXHAUSTED
-
INFORMATICA-B360:SERVER_BUSY
-
INFORMATICA-B360:SERVER_ERROR
-
INFORMATICA-B360:SERVICE_ERROR
-
INFORMATICA-B360:UNAUTHORIZED
Types
TLS
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
Trust store configuration for verifying server certificates. |
|||
Key Store |
Key store configuration for client certificate authentication. |
|||
Revocation Check |
Certificate revocation checking configuration. |
Trust Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom OCSP Responder
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Default Header
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Key |
String |
HTTP header name. |
x |
|
Value |
String |
HTTP header value. |
x |
Default Query Param
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Key |
String |
Query parameter name. |
x |
|
Value |
String |
Query parameter value. |
x |
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 does not 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. |
||
Blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
||
Count |
Number |
How many reconnection attempts to make. |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
Blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
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 is considered eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
Time unit for the Max Idle Time field. |
HTTP Response Attributes
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Headers |
Object |
HTTP response headers. |
||
Reason Phrase |
String |
HTTP reason phrase for the status code. |
||
Status Code |
Number |
HTTP status code of the response. |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
||
Max Buffer Size |
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. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed. |
Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the In Memory Size field. |
Error Mapping
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Source |
Enumeration, one of:
|
Source error type to map from. |
||
Target |
String |
Target error type identifier for the mapping. |
x |
Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The number of instances initially allowed in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment field, with an upper limit of Max Buffer Size. The default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
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. |
Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects |
Number |
The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the In Memory Objects field. |
Default
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host |
String |
Proxy server hostname or IP address. |
x |
|
Port |
Number |
Proxy server port number. |
x |
|
Username |
String |
Username for proxy authentication. |
||
Password |
String |
Password for proxy authentication. |
||
Non Proxy Hosts |
String |
Comma-separated list of hosts that bypass the proxy. |
NTLM
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Ntlm Domain |
String |
NTLM domain name for proxy authentication. |
x |
|
Host |
String |
Proxy server hostname or IP address. |
x |
|
Port |
Number |
Proxy server port number. |
x |
|
Username |
String |
Username for proxy authentication. |
||
Password |
String |
Password for proxy authentication. |
||
Non Proxy Hosts |
String |
Comma-separated list of hosts that bypass the proxy. |



