---
title: "Technical Reference"
canonical: "https://help.agiloft.com/space/HELP/598999075/Technical+Reference"
format: markdown
---
This is the main class of an Agiloft MuleSoft extension, and is the entry point where configurations, connection providers, operations, and sources are declared. A list of [Types](#10) can be found at the bottom of the page.

# 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 | - Basic Connection
- OAuth 2 Connection | The connection types that can be provided to this configuration. |  | **x** |
| Name | String | The identifier of this element, used to reference it in other components. |  | **x** |
| Expiration Policy | 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 will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit. |  |  |

# Connection Types

You can connect with either a basic login and password combination, or with OAuth.

### Basic Connection

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Base URL | String | The server URL. | https://server.agiloft.com/ewws |  |
| KnowledgeBase Name | String | The name of your KB. | CLM Template |  |
| Proxy configuration | Proxy Configuration | Configuration for executing requests through a proxy. |  |  |
| Response Timeout | Number | Specifies the amount of time that the consumer will attempt to execute a request before it times out. | 15 |  |
| Time Unit | Enumeration, one of:<br>- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS | Specifies the time unit of the response timeout parameter. | SECONDS |  |
| Login | String | The username associated with the KB. |  | **x** |
| Password | String | The password associated with the Login. |  | **x** |
| Reconnection | Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, the deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |  |  |

### OAuth 2 Connection

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Base URL | String | The server URL. | https://server.agiloft.com/ewws |  |
| KnowledgeBase Name | String | The name of your KB. | CLM Template |  |
| Proxy configuration | Proxy Configuration | Configuration for executing requests through a proxy. |  |  |
| Response Timeout | Number | Specifies the amount of time that the consumer will attempt to execute a request before it times out. | 15 |  |
| Time Unit | Enumeration, one of:<br>- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS | Specifies the time unit of the response timeout parameter. | SECONDS |  |
| Reconnection | Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, the deployment will fail 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. | https://server.agiloft.com/ewws/oauth |  |
| Access Token Url | String | The service provider’s accessToken endpoint URL. | https://server.agiloft.com/ewws/otoken |  |
| Scopes | String | The OAuth scopes to be requested. If not provided, it will default to those in the annotation. | permissions_for:213 |  |
| Resource Owner ID | String | The resourceOwnerID which each component should use if it doesn’t reference otherwise. |  |  |
| Before | String | The name of a flow to be executed right before starting OAuth. |  |  |
| After | String | The name of a flow to be executed right after an accessToken has been received. |  |  |
| Listener Config | String | A reference 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 OAuth. |  | **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 instead. |  |  |
| Object Store | String | A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one. |  |  |

# Associated Operations

You can use the following calls, which are explained in more detail below.

- [Attach](#1)
- [Attach Remove](#2)
- [Attach Retrieve](http://wiki.agiloft.com#3)
- [Choice List ID](http://wiki.agiloft.com#4)
- [Create](#5)
- [Delete](#6)
- [Query](#7)
- [Unauthorize](#8)
- [Update](#9)

## > Macro (anchor)

Attach

`<agiloft:attach>`

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Table Name | String | The logical table name you plan to use the operation in. |  | **x** |
| ID | Number | The unique record identifier. |  | **x** |
| Field Name | String | The logical field name you plan to use an operation with. |  | **x** |
| File Name | String | The name of a file. |  | **x** |
| Content | Any |  | #[payload] |  |
| Config Ref | ConfigurationProvider | The name of the configuration used to execute this component. |  | **x** |
| Streaming Strategy | - Repeatable In Memory Stream
- Repeatable File Store Stream
- Non Repeatable Stream | Configure if repeatable streams should be used. |  |  |
| Target Variable | String | The name of a variable on which the operation’s output is placed. |  |  |
| Target Value | String | An expression that will be evaluated against the operation’s output. The outcome of the expression will be stored in the target variable. | #[payload] |  |
| Reconnection Strategy | - Reconnect
- Reconnect Forever | A retry strategy, in case of connectivity errors. |  |  |

#### Output

|  |  |
| --- | --- |
| **Type** | Any |

#### Throws

- AGILOFT:CONNECTIVITY
- AGILOFT:INVALID_REQUEST
- AGILOFT:RETRY_EXHAUSTED

## > Macro (anchor)

Attach Remove

`<agiloft:attach-remove>`

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Table Name | String | The logical table name you plan to use the operation in. |  | **x** |
| ID | Number | The unique record identifier. |  | **x** |
| Field Name | String | The logical field name you plan to use an operation with. |  | **x** |
| Position | Number | A sort order for processing, beginning with 0. |  | **x** |
| Config Ref | ConfigurationProvider | The name of the configuration used to execute this component. |  | **x** |
| Streaming Strategy | - Repeatable In Memory Stream
- Repeatable File Store Stream
- Non Repeatable Stream | Configure if repeatable streams should be used. |  |  |
| Target Variable | String | The name of a variable on which the operation’s output will be placed. |  |  |
| Target Value | String | An expression that will be evaluated against the operation’s output. The outcome of the expression will be stored in the target variable. | #[payload] |  |
| Reconnection Strategy | - Reconnect
- Reconnect Forever | A retry strategy in case of connectivity errors. |  |  |

#### Output

|  |  |
| --- | --- |
| **Type** | Any |

#### Throws

- AGILOFT:CONNECTIVITY
- AGILOFT:INVALID_REQUEST
- AGILOFT:RETRY_EXHAUSTED

## > Macro (anchor)

Attach Retrieve

`<agiloft:attach-retrieve>`

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Table Name | String | The logical table name you plan to use the operation in. |  | **x** |
| ID | Number | The unique record identifier. |  | **x** |
| Field Name | String | The logical field name you plan to use an operation with. |  | **x** |
| Position | Number | A sort order for processing, beginning with 0. |  | **x** |
| Config Ref | ConfigurationProvider | The name of the configuration used to execute this component. |  | **x** |
| Streaming Strategy | - Repeatable In Memory Stream
- Repeatable File Store Stream
- non-repeatable-stream | Configure if repeatable streams should be used. |  |  |
| Target Variable | String | The name of a variable on which the operation’s output will be placed. |  |  |
| Target Value | String | An expression that will be evaluated against the operation’s output. The outcome of the expression will be stored in the target variable. | #[payload] |  |
| Reconnection Strategy | - Reconnect
- Reconnect Forever | A retry strategy in case of connectivity errors. |  |  |

#### Output

|  |  |
| --- | --- |
| **Type** | Any |

#### Throws

- AGILOFT:CONNECTIVITY
- AGILOFT:INVALID_REQUEST
- AGILOFT:RETRY_EXHAUSTED

## > Macro (anchor)

Choice List ID

`<agiloft:choice-list-id>`

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Table Name | String | The logical table name you plan to use the operation in. |  | **x** |
| Field Name | String | The logical field name you plan to use an operation with. |  | **x** |
| Choice Value | String | The indicator of a certain choice in a choice list. |  | **x** |
| Config Ref | ConfigurationProvider | The name of the configuration to be used to execute this component |  | **x** |
| Streaming Strategy | - Repeatable In Memory Stream
- Repeatable File Store Stream
- non-repeatable-stream | Configure if repeatable streams should be used. |  |  |
| Target Variable | String | The name of a variable on which the operation’s output will be placed. |  |  |
| Target Value | String | An expression that will be evaluated against the operation’s output. The outcome of the expression will be stored in the target variable. | #[payload] |  |
| Reconnection Strategy | - Reconnect
- Reconnect Forever | A retry strategy in case of connectivity errors. |  |  |

#### Output

|  |  |
| --- | --- |
| **Type** | Any |

#### Throws

- AGILOFT:CONNECTIVITY
- AGILOFT:INVALID_REQUEST
- AGILOFT:RETRY_EXHAUSTED

## > Macro (anchor)

Create

`<agiloft:create>`

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Table Name | String | The logical table name you plan to use the operation in. |  | **x** |
| Field Values | Object | The value you want to create. | #[payload] |  |
| Config Ref | ConfigurationProvider | The name of the configuration used to execute this component. |  | **x** |
| Streaming Strategy | - Repeatable In Memory Stream
- Repeatable File Store Stream
- non-repeatable-stream | Configure if repeatable streams should be used. |  |  |
| Target Variable | String | The name of a variable on which the operation’s output will be placed. |  |  |
| Target Value | String | An expression that will be evaluated against the operation’s output. The outcome of the expression will be stored in the target variable. | #[payload] |  |
| Reconnection Strategy | - Reconnect
- Reconnect Forever | A retry strategy in case of connectivity errors. |  |  |

#### Output

|  |  |
| --- | --- |
| **Type** | Any |

#### Throws

- AGILOFT:CONNECTIVITY
- AGILOFT:INVALID_REQUEST
- AGILOFT:RETRY_EXHAUSTED

## > Macro (anchor)

Delete

`<agiloft:delete>`

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Table Name | String | The logical table name you plan to delete something from. |  | **x** |
| ID | Number | The unique record identifier. |  | **x** |
| Config Ref | ConfigurationProvider | The name of the configuration used to execute this component. |  | **x** |
| Streaming Strategy | - Repeatable In Memory Stream
- Repeatable File Store Stream
- non-repeatable-stream | Configure if repeatable streams should be used. |  |  |
| Target Variable | String | The name of a variable on which the operation’s output will be placed. |  |  |
| Target Value | String | An expression that will be evaluated against the operation’s output. The outcome of the expression will be stored in the target variable. | #[payload] |  |
| Reconnection Strategy | - Reconnect
- Reconnect Forever | A retry strategy in case of connectivity errors. |  |  |

#### Output

|  |  |
| --- | --- |
| **Type** | Any |

#### Throws

- AGILOFT:CONNECTIVITY
- AGILOFT:INVALID_REQUEST
- AGILOFT:RETRY_EXHAUSTED

## > Macro (anchor)

Query

`<agiloft:query>`

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Table Name | String | The logical table name you plan to delete something from. |  | **x** |
| Field Names | Array of String | The logical field name you plan to use an operation with. | #[payload] |  |
| Query Condition | String | The expression used for filtering records. |  |  |
| Saved Search | String | <span style="color: #333333">A predefined Agiloft saved search expression used for filtering records.</span> |  |  |
| Limit | Number | <span style="color: #333333">Sets the max number of records that can be returned. </span> |  |  |
| Page | Number | <span style="color: #333333">Number of a selected page number, if the result was limited with Limit.</span> |  |  |
| Config Ref | ConfigurationProvider | The name of the configuration used to execute this component. |  | **x** |
| Streaming Strategy | - Repeatable In Memory Stream
- Repeatable File Store Stream
- non-repeatable-stream | Configure if repeatable streams should be used. |  |  |
| Target Variable | String | The name of a variable on which the operation’s output will be placed. |  |  |
| Target Value | String | An expression that will be evaluated against the operation’s output. The outcome of the expression will be stored in the target variable. | #[payload] |  |
| Reconnection Strategy | - Reconnect
- Reconnect Forever | A retry strategy in case of connectivity errors. |  |  |

#### Output

|  |  |
| --- | --- |
| **Type** | Any |

#### Throws

- AGILOFT:CONNECTIVITY
- AGILOFT:INVALID_REQUEST
- AGILOFT:RETRY_EXHAUSTED

## > Macro (anchor)

Unauthorize

`<agiloft:unauthorize>`

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 doing the authorization dance again

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Resource Owner ID | String | The ID of the resource owner which access should be invalidated. |  |  |
| Config Ref | ConfigurationProvider | The name of the configuration to be used to execute this component. |  | **x** |


## > Macro (anchor)

Update

`<agiloft:update>`

#### Parameters

| **Name** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Configuration | String | The name of the configuration to use. |  | **x** |
| Table Name | String | The logical table name you plan to delete something from. |  | **x** |
| Field Values | Object | The value you want to update a field with. | #[payload] |  |
| Config Ref | ConfigurationProvider | The name of the configuration to be used to execute this component |  | **x** |
| Streaming Strategy | - Repeatable In Memory Stream
- Repeatable File Store Stream
- non-repeatable-stream | Configure if repeatable streams should be used. |  |  |
| Target Variable | String | The name of a variable on which the operation’s output will be placed. |  |  |
| Target Value | String | An expression that will be evaluated against the operation’s output. The outcome of the expression will be stored in the target variable. | #[payload] |  |
| Reconnection Strategy | - Reconnect
- Reconnect Forever | A retry strategy in case of connectivity errors. |  |  |

#### Output

|  |  |
| --- | --- |
| **Type** | Any |

#### Throws

- AGILOFT:CONNECTIVITY
- AGILOFT:INVALID_REQUEST
- AGILOFT:RETRY_EXHAUSTED

# Types> Macro (anchor)



### Proxy Configuration

| **Field** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Host | String |  |  | x |
| Port | Number |  |  | x |
| User Name | String | Login information. |  |  |
| Password | String | The password associated with User Name. |  |  |

### 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, the deployment will fail 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 it takes to reconnect, in milliseconds. |  |  |
| Blocking | Boolean | If false, the reconnection strategy will run in a separate, non-blocking thread. |  |  |
| Count | Number | The number of reconnection attempts. |  |  |

### Reconnect Forever

| **Field** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Frequency | Number | How often it takes to reconnect, in milliseconds. |  |  |
| Blocking | Boolean | If false, the reconnection strategy will run 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’s considered eligible for expiration. |  |  |
| Time Unit | Enumeration, one of:<br>- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS | A time unit that qualifies the maxIdleTime attribute. |  |  |

### Repeatable In Memory Stream

| **Field** | **Type** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- | --- |
| Initial Buffer Size | Number | This is the amount of memory that will be allocated in order 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. |  |  |
| Buffer Size Increment | Number | This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. |  |  |
| Max Buffer Size | Number | This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |  |  |
| Buffer Unit | Enumeration, one of:<br>- BYTE
- KB
- MB
- GB | 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 then it will start to buffer the content on disk. |  |  |
| Buffer Unit | Enumeration, one of:<br>- BYTE
- KB
- MB
- GB | The unit in which maxInMemorySize is expressed. |  |  |