Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Salesforce Composite Module Documentation Reference

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

OAuth Username Password

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

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 actually purges the instances when it sees fit.

OAuth Username Password Connection Type

Parameters

Name Type Description Default Value Required

Consumer Key

String

Consumer key for Salesforce connected app

x

Consumer Secret

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

Username

String

Username used to initialize the session

x

Password

String

Password used to authenticate the user

x

Security Token

String

User’s security token. It can be omitted if your IP has been whitelisted on Salesforce

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

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.

Host

String

Hostname of the proxy. If this property is not set, no proxy is used, otherwise a proxy ise used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Supported Operations

  • Create SObject Tree

  • Execute Composite Batch

  • Post Create

  • Post Delete

  • Post Get Limits

  • Post Query

  • Post Query All

  • Post Retrieve

  • Post Search

  • Post Update

  • Pre-Create

  • Pre-Delete

  • Pre-Get Limits

  • Pre-Query

  • Pre-Query All

  • Pre-Retrieve

  • Pre-Search

  • Pre-Update

Operations

Create SObject Tree

<salesforce-composite:create-sobject-tree>

Sends a list of SObject trees to Salesforce to create.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

SObject Root Type

String

The sObject type of the root of the trees.

x

SObject Tree

Array of Object

A list of maps representing the list of trees that need to be created.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Execute Composite Batch

<salesforce-composite:execute-composite-batch>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Sub Requests

Array of Object

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Post Create

<salesforce-composite:post-create>

This method provides metadata for the result of a create. It takes as input one record from the result returned by executeCompositeBatch(String, java.util.List) which belongs to create sub-request generated by preCreate(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Result

Object

The result of a create sub-request.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Post Delete

<salesforce-composite:post-delete>

This method provides metadata for the result of a delete. It takes as input one record from the result returned by executeCompositeBatch(String, java.util.List) which belongs to delete sub-request generated by preDelete(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Delete Result

Object

The result of a delete sub-request.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Post Get Limits

<salesforce-composite:post-get-limits>

This method provides metadata for the result of a create. It takes as input one record from the result returned by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List) which belongs to create sub-request generated by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#preCreate(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Get Limits Result

Object

The result of a create sub-request.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Post Query

<salesforce-composite:post-query>

This method provides metadata for the result of a query. It takes as input one record from the result returned by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List) which belongs to query sub-request generated by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#preQuery(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

x

Query Result

Object

The result of a query sub-request.

#[payload]

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure to use repeatable streams and their behavior.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Post Query All

<salesforce-composite:post-query-all>

This method provides metadata for the result of a create. It takes as input one record from the result returned by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List) which belongs to create sub-request generated by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#preCreate(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query Result

Object

The result of a create sub-request.

#[payload]

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure to use repeatable streams and their behavior.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Post Retrieve

<salesforce-composite:post-retrieve>

This method provides metadata for the result of a retrieve. It takes as input one record from the result returned by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List) which belongs to retrieve sub-request generated by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#preRetrieve(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Retrieve Data

Object

The result of a retrieve sub-request.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Post Search

<salesforce-composite:post-search>

This method provides metadata for the result of a search. It takes as input one record from the result returned by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List) which belongs to search sub-request generated by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#preSearch(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Search Result

Object

The result of a search sub-request

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Post Update

<salesforce-composite:post-update>

This method provides metadata for the result of update. It takes as input one record from the result returned by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List) which belongs to update sub-request generated by org.mule.modules.salesforce.composite.SalesforceCompositeConnector#preUpdate(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Result

Object

The result of an update sub-request.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Pre-Create

<salesforce-composite:pre-create>

This method provides metadata for create based on object that is going to be created and generates a sub-request to be given for execution to executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The type of object to create.

x

S Object

Object

The object to create as a map that sticks to metadata for selected type.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Pre-Delete

<salesforce-composite:pre-delete>

This method provides metadata for delete based on object that is going to be deleted and generates a sub-request to be given for execution to executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The type of object to delete.

x

S Object

Object

The map with the ID of the object to delete mapped to the ID key.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Pre-Get Limits

<salesforce-composite:pre-get-limits>

This method provides metadata for getLimits and generates a sub-request to be given for execution to org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Pre-Query

<salesforce-composite:pre-query>

This method provides metadata for query based on object that is going to be queried and generates a sub-request to be given for execution to org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

The query to run in executeCompositeBatch.

x

Parameters

Object

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Pre-Query All

<salesforce-composite:pre-query-all>

This method provides metadata for query based on object that is going to be queried and generates a sub-request to be given for execution to org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

The query to run in executeCompositeBatch.

x

Parameters

Object

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Pre-Retrieve

<salesforce-composite:pre-retrieve>

This method provides metadata for retrieve based on object that is going to be retrieved and generates a sub-request to be given for execution to org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Retrieve Data

Object

The object to retrieve as a map that sticks to metadata for selected type.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Pre-Search

<salesforce-composite:pre-search>

The purpose of this method is to provide the user a way to input a SOSL String and generates a sub-request to be given for execution to org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Search

String

The SOSL string to run in executeCompositeBatch.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Pre-Update

<salesforce-composite:pre-update>

This method provides metadata for creates based on the object to create, and generates a sub-request to be given for execution to org.mule.modules.salesforce.composite.SalesforceCompositeConnector#executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The type of object to create.

x

S Object

Object

The object to create as a map that sticks to metadata for the selected type.

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • composite-config

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

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

  • reconnect

  • reconnect-forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

The number of reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

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:

  • DAYS

  • HOURS

  • MICROSECONDS

  • MILLISECONDS

  • MINUTES

  • NANOSECONDS

  • SECONDS

A time unit that qualifies the maxIdleTime attribute.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially allow in memory to enable the connector to consume the stream and provide random access to its data. If the stream contains more data than can fit in this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

A numeric increment value by how much the buffer can expand beyond its initial size. To indicate no buffer expansion, set to zero or a negative number. If the buffer is set for no expansion and gets full, any attempts to write to the buffer causes the STREAM_MAXIMUM_SIZE_EXCEEDED error. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more memory is used, write attempts causes the STREAM_MAXIMUM_SIZE_EXCEEDED error. To set no limit, set this value to zero or a negative number.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

The maximum number of instances to keep in memory. If more are required, the connector starts buffering the disk contents.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.