# mulesoft Microsoft Dynamics AX 2012 Connector - Full Documentation

<!-- document id=10f57f6088f4f6926af9517b18c566124e47f807b1ec3a336731d4a8fe5b911b url=/mulesoft/current/en-us/microsoft-dynamics-ax-connector/latest/index.md -->

---
product: Microsoft Dynamics AX 2012 Connector
version: 2.0
is-latest-version: true
---

# Microsoft Dynamics AX 2012 Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Microsoft Dynamics AX 2012 Connector v2.0

Anypoint Connector for Microsoft Dynamics AX 2012 (Dynamics AX 2012 Connector) enables Mule apps to
interact with the Microsoft Dynamics AX Query Service.

This connector supports the following operations:

- Run a query against an AOT table.

- Run an AOT static query.

- Call an AIF Document Service.

The connector supports Microsoft Dynamics AX 2012.

## Before You Begin

To use this connector, you must be familiar with:

- Microsoft Dynamics AX

- Mule, Mule concepts, elements in a Mule flow, and Global Elements

- Anypoint Connectors

- Anypoint Studio

Before creating an app, you must have:

- Microsoft login credentials to test your connection to your target resource

- Anypoint Windows Gateway Services installed

For software requirements and compatibility information, see the Connector Release Notes.

## POM File Information

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-microsoft-dynamics-ax-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information, access the connector in
[Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**.

### Windows Gateway Services for Anypoint Platform

The Windows Gateway Services agent performs protocol translation when calling the Dynamics AX System
Services. The Dynamics AX System Services (Metadata Service, Query Service) use the net.tcp protocol
which is not implemented in Java. To execute requests, the connector routes the requests through the
Windows Gateway Services as shown in the following image:

![Microsoft Dynamics AX Connector global elements properties config window on General tab](/mulesoft/current/en-us/microsoft-dynamics-ax-connector/latest/_images/ms-dynamics-ax-protocol-translation.png)

1.  The connector sends an HTTP request to the Windows Gateway Services.

2.  The Windows Gateway Services receives the HTTP request.

3.  The Windows Gateway Services executes the request against the Dynamics AX System Services using
    the netTcp protocol.

4.  The Windows Gateway Services receives the response from the Dynamics AX System Services.

5.  The Windows Gateway Services sends the response to the connector over HTTP.

6.  The connector receives the response.

All communication between the Anypoint Platform and Windows Gateway Services is authenticated and
secured by SSL.

## Connect in Anypoint Studio 7

You can use this connector in Anypoint Studio by first downloading it from Exchange and configuring
it as needed.

## Add the Connector to a Studio Project

Anypoint Studio provides two ways to add the connector to your Studio project: from the Exchange
button in the Studio taskbar or from the Mule Palette view.

### Add the Connector Using Exchange

1.  In Studio, create a Mule project.

2.  Click the Exchange icon **(X)** in the upper-left of the Studio task bar.

3.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

4.  In Exchange, search for "ax".

5.  Select the connector and click **Add to project**.

6.  Follow the prompts to install the connector.

### Add the Connector in Studio

1.  In Studio, create a Mule project.

2.  In the Mule Palette view, click **(X) Search in Exchange**.

3.  In **Add Modules to Project**, type "ax" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure in Studio

1.  Drag a connector operation to the Studio Canvas.

    ![Query Table operation](/mulesoft/current/en-us/microsoft-dynamics-ax-connector/latest/_images/ms-dynamics-ax-component.png)

2.  For general settings complete these fields:

    ![Global Elements Properties General configuration tab](/mulesoft/current/en-us/microsoft-dynamics-ax-connector/latest/_images/ms-dynamics-ax-any-config.png)

    - Company: Sets the company to use within all calls.

    - Language: Sets the language to use within all calls.

    - Log on as user: Sets the user to use within all calls.

    - Message id: Sets the message ID to use within all calls.

    - Partition key: Sets the partition key to use within all calls.

      Connection parameters:

      <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><p>Username</p></td><td><p>The username to connect to Dynamics AX.</p></td></tr><tr><td><p>Password</p></td><td><p>The password to connect to Dynamics AX.</p></td></tr><tr><td><p>AOS Server Name</p></td><td><p>The name or IP of the server where the Application Object Server is running.</p></td></tr><tr><td><p>AOS Services WSDL Port</p></td><td><p>The port number that the Services WSDL run on. Default is <code>8101</code>.</p></td></tr><tr><td><p>Gateway Router Service Url</p></td><td><p>The address (host and port) of the Windows Gateway Services. This address is usually similar to <code>https://myserver.com:9333/router</code></p></td></tr></tbody></table>

For advanced connection complete these fields:

![Microsoft Dynamics AX Connector global elements properties config window on Advanced tab](/mulesoft/current/en-us/microsoft-dynamics-ax-connector/latest/_images/ms-dynamics-ax-any-advanced-config.png)

- AOS Endpoint Port (Optional) - Use this configuration to override the service endpoint that is in
  the services' WSDL document.

- Connection timeout - Used to set connection timeout for connector requests. This optional value is
  in milliseconds (0 for unlimited timeout).

- Receive timeout - Use to set reception timeout for connector requests. This optional value is in
  milliseconds.

## Use Case: Query Table

1.  Add an HTTP Listener to the flow.

2.  Click the green plus sign to configure it.

3.  Set Host to localhost and Port to 8080.

4.  Click OK.

5.  Add Query Table operation from Microsoft Dynamics AX pallette.

6.  Configure connection by clicking on the green plus sign

7.  Set the above mentioned fields

8.  Complete the Query parameter with `dsql:Select Name from ProjTable`

9.  Add a Transform Message and set it with following:

    ```dataweave
    %dw 2.0
    output application/json
    payload
    ```

10. Perform a curl to `localhost:8080`

## Use Case XML

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns:microsoft-dynamics-ax="http://www.mulesoft.org/schema/mule/microsoft-dynamics-ax"
      xmlns:http="http://www.mulesoft.org/schema/mule/http"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
      http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/microsoft-dynamics-ax
http://www.mulesoft.org/schema/mule/microsoft-dynamics-ax/current/mule-microsoft-dynamics-ax.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
    <configuration-properties file="mule-app.properties"/>

    <http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config">
        <http:listener-connection host="localhost" port="8082"/>
    </http:listener-config>

    <microsoft-dynamics-ax:dynamics-ax-config name="Microsoft_Dynamics_AX_Dynamics_AX"
         doc:name="Microsoft Dynamics AX Dynamics AX">
        <microsoft-dynamics-ax:soap-connection disableCnCheck="true"
         gatewayRouterServiceAddress="${gateway-connection-config.gatewayRouterServiceAddress}"
         username="${gateway-connection-config.username}"
         password="${gateway-connection-config.password}"
         aosServerName="${gateway-connection-config.aosServerName}"
         aosWsdlPort="${gateway-connection-config.aosWsdlPort}"/>
    </microsoft-dynamics-ax:dynamics-ax-config>

    <flow name="dynamics-old-ax-demoFlow2">
        <http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/query"/>
        <set-payload value="#[attributes.queryParams.queryToExecute]" doc:name="Set Payload"/>
        <microsoft-dynamics-ax:query-table itemsPerPage="5" doc:name="Query table"
              config-ref="Microsoft_Dynamics_AX_Dynamics_AX">
            <microsoft-dynamics-ax:query>#[payload]</microsoft-dynamics-ax:query>
        </microsoft-dynamics-ax:query-table>
        <ee:transform doc:name="Transform Message">
            <ee:message>
                <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
            </ee:message>
        </ee:transform>
    </flow>

</mule>
```

## See Also

- [Windows Gateway Services Configuration Guide](https://docs.mulesoft.com/connectors/windows-gateway-services/windows-gateway-services-guide-mule4)

- Run a query against an
  [AOT table](https://learn.microsoft.com/en-us/dynamicsax-2012/developer/tables-overview?redirectedfrom=MSDN)

- Run an
  [AOT static query](https://learn.microsoft.com/en-us/dynamicsax-2012/developer/queries-in-the-aot-for-data-access?redirectedfrom=MSDN)

- Call an
  [AIF Document Service](https://learn.microsoft.com/en-us/dynamicsax-2012/appuser-itpro/aif-document-services?redirectedfrom=MSDN)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=b26c6e0b9318b5739155970ee45cc40b3093f5b320b9ecd67858f76f5a9101d3 url=/mulesoft/current/en-us/microsoft-dynamics-ax-connector/latest/ms-dynamics-ax-connector-reference.md -->

---
product: Microsoft Dynamics AX 2012 Connector
version: 2.0
is-latest-version: true
---

# Microsoft Dynamics AX 2012 Connector Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Microsoft Dynamics AX 2012 Connector v2.0

Release Notes:
[Microsoft Dynamics AX 2012 Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/ms-dynamics-ax-connector-release-notes-mule-4)

## Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p>Gateway Username Password</p></div></div></td><td><p>The connection types that can be provided to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p>ExpirationPolicy</p></div></div></td><td><p>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 as it sees fit.</p></td><td></td><td></td></tr></tbody></table>

## Gateway Username Password Connection Type

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Disable SSL Certificate validation</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this it is possible to disable the CN (Common Name) check. Note: this is not recommended for production environments.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Gateway Router Service Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address of the gateway service that routes the requests to the CRM instance (<code>https://mygateway.com/router</code>).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Aos Endpoint Port</p></td><td><div><div><p>String</p></div></div></td><td><p>For overriding the port returned in the Service’s WSDL.</p></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Used to set connection timeout for connector requests. This optional value is in milliseconds (0 for unlimited timeout).</p></td><td></td><td></td></tr><tr><td><p>Receive Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Use to set receiving timeout for connector requests. This optional value is in milliseconds (0 for unlimited timeout).</p></td><td></td><td></td></tr><tr><td><p>Company</p></td><td><div><div><p>String</p></div></div></td><td><p>Sets the company to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.company' outbound property).</p></td><td></td><td></td></tr><tr><td><p>Language</p></td><td><div><div><p>String</p></div></div></td><td><p>Sets the language to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.language' outbound property).</p></td><td></td><td></td></tr><tr><td><p>Logon As User</p></td><td><div><div><p>String</p></div></div></td><td><p>Sets the user to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.logonAsUser' outbound property).</p></td><td></td><td></td></tr><tr><td><p>Message Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sets the message id to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.messageId' outbound property).</p></td><td></td><td></td></tr><tr><td><p>Partition Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Sets the partition key to use within all calls (this setting can be overridden using the 'dynamicsax.callcontext.partitionKey' outbound property).</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Aos Server Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The Application Object Server (AOS) WSDL server name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Aos Wsdl Port</p></td><td><div><div><p>String</p></div></div></td><td><p>The Application Object Server (AOS) WSDL port.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p>Reconnection</p></div></div></td><td><p>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</p></td><td></td><td></td></tr></tbody></table>

## Associated Operations

- Invoke Document Service Operation

- Query Table

- Static Query

## Invoke Document Service Operation

`<microsoft-dynamics-ax:invoke-document-service-operation>`

Executes a Document Service operation.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Action Input</p></td><td><div><div><p>Binary</p></div></div></td><td></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p>Repeatable In Memory Iterable Type</p></li><li><p>Repeatable File Store Stream Type</p></li></ul></div></div></td><td><p>Configure to use repeatable and their behavior.</p></td><td></td><td></td></tr><tr><td><p>Service</p></td><td><div><div><p>String</p></div></div></td><td><p>The service group name (first level metadata key)</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Action</p></td><td><div><div><p>String</p></div></div></td><td><p>The action name (second level metadata key)</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation’s output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression will be stored in the target variable</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>Reconnect</p></li><li><p>Reconnect Forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- dynamics-ax-config

### Throws

- MICROSOFT-DYNAMICS-AX:CONNECTIVITY

- MICROSOFT-DYNAMICS-AX:INVALID\_SESSION

- MICROSOFT-DYNAMICS-AX:RETRY\_EXHAUSTED

- MICROSOFT-DYNAMICS-AX:TRANSACTION

- MICROSOFT-DYNAMICS-AX:TRANSFORMATION

- MICROSOFT-DYNAMICS-AX:UNKNOWN

- MICROSOFT-DYNAMICS-AX:VALIDATION

## Query Table

`<microsoft-dynamics-ax:query-table>`

Create a new record.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Query</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Items Per Page</p></td><td><div><div><p>Number</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p>Repeatable In Memory Iterable</p></li><li><p>Repeatable File Store Iterable</p></li></ul></div></div></td><td><p>Configure to use repeatable and their behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation’s output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression will be stored in the target variable</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>Reconnect</p></li><li><p>Reconnect Forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- dynamics-ax-config

### Throws

- MICROSOFT-DYNAMICS-AX:CONNECTIVITY

- MICROSOFT-DYNAMICS-AX:INVALID\_SESSION

- MICROSOFT-DYNAMICS-AX:TRANSACTION

- MICROSOFT-DYNAMICS-AX:TRANSFORMATION

- MICROSOFT-DYNAMICS-AX:UNKNOWN

- MICROSOFT-DYNAMICS-AX:VALIDATION

## Static Query

`<microsoft-dynamics-ax:static-query>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Static Query Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Ranges</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Items Per Page</p></td><td><div><div><p>Number</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p>Repeatable In Memory Stream</p></li><li><p>Repeatable File Store Iterable</p></li></ul></div></div></td><td><p>Configure to use repeatable and their behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation’s output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression will be stored in the target variable</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>Reconnect</p></li><li><p>Reconnect Forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- dynamics-ax-config

### Throws

- MICROSOFT-DYNAMICS-AX:CONNECTIVITY

- MICROSOFT-DYNAMICS-AX:INVALID\_SESSION

- MICROSOFT-DYNAMICS-AX:TRANSACTION

- MICROSOFT-DYNAMICS-AX:TRANSFORMATION

- MICROSOFT-DYNAMICS-AX:UNKNOWN

- MICROSOFT-DYNAMICS-AX:VALIDATION

## Reconnection Type

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>Reconnect</p></li><li><p>Reconnect Forever</p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

## Expiration Policy Type

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>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</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute</p></td><td></td><td></td></tr></tbody></table>

## Repeatable In Memory Stream Type

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is 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 it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is by how much will be buffer size by expanded 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.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is 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 or equal to zero means no limit.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which all these attributes are expressed</p></td><td></td><td></td></tr></tbody></table>

## Repeatable File Store Stream Type

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

## Repeatable In Memory Iterable Type

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of instances to initially allow to keep in memory to consume the stream and provide random access to the stream. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>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, and to raise a STREAM_MAXIMUM_SIZE_EXCEEDED error when the buffer gets full. Default value is 100 instances.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is 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 or equal to zero means no limit.</p></td><td></td><td></td></tr></tbody></table>

## Repeatable File Store Iterable Type

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)