SAP SuccessFactors Connector 5.0 Reference | MuleSoft Documentation
# SAP SuccessFactors Connector 5.0 Reference
Anypoint Connector for SAP SuccessFactors (SuccessFactors Connector) provides full support to query, create, update, and delete entities using the OData API exposed by SuccessFactors.
## Default Configuration
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection | 
  * Basic Authentication - Deprecated
  * OAuth SAML Bearer Assertion Authentication

| The connection types to provide to this configuration.  
Time Zone | The timezone with which the Date objects returned from SuccessFactors are converted.  
The identifier of this element used to reference it in other components  
Expiration Policy |  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 instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.  
## Basic Authentication - Deprecated
This connection type is deprecated. Use OAuth SAML Bearer Assertion Authentication instead.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Proxy Configuration |  One of:
  * Default Proxy Configuration

| Proxy configuration.  
Data Center’s EndPoint URL | Data center’s endpoint URL. If the new data centers don’t appear in the dropdown list, you can manually enter the value of the new data center.  
Use Persistent Connections | If `false`, each connection is closed after the first request completes.  
Max Connections | The maximum number of outbound connections to keep open concurrently. By default, the number of connections is unlimited.  
Connection Idle Timeout | The number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled.  
Connection Idle Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Connection idle timeout unit for the request  
Stream Response | Whether or not to stream received responses, which means that processing continues as soon as all headers are parsed and the body is streamed as it is received. When enabled, the response must eventually be read since, depending on the configured buffer size, the response might not fit into memory and processing stops until space is available.  
Response Buffer Size | The space in bytes for the buffer where the HTTP response is stored.  
Connection timeout | Connection timeout for the request  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Connection timeout unit for the request  
Default headers |  Array of Default Header | Default HTTP headers to include in the message.  
Default query parameters |  Array of Default Query Param | Default Query parameters to include in the request.  
Company ID | The Company ID  
User Name | The user name  
Password | The password  
Enable Session Reuse | Boolean to enable the **Session Reuse** feature. By default, it is false.  
TLS Configuration | Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the `tls:context` child element of the `listener-config`.  
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.  
## OAuth SAML Bearer Assertion Authentication
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Proxy Configuration |  One of:
  * Default Proxy Configuration

| Proxy configuration.  
Object Store |  ObjectStore | Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.  
Data Center’s EndPoint URL | Data center’s endpoint URL. If the new data centers don’t appear in the dropdown list, you can manually enter the value of the new data center.  
Use Persistent Connections | If false, each connection is closed after the first request is completed.  
Max Connections | The maximum number of outbound connections to keep open concurrently. By default, the number of connections is unlimited.  
Connection Idle Timeout | The number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled.  
Connection Idle Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Connection idle timeout unit for the request.  
Stream Response | Whether or not to stream received responses, which means that processing continues as soon as all headers are parsed and the body is streamed as it is received. When enabled, the response must eventually be read since, depending on the configured buffer size, the response might not fit into memory and processing stops until space is available.  
Response Buffer Size | The space in bytes for the buffer where the HTTP response will be stored.  
Connection timeout | Connection timeout for the request.  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Connection timeout unit for the request.  
Default headers |  Array of Default Header | Default HTTP headers to include in the message.  
Default query parameters |  Array of Default Query Param | Default Query parameters to include in the request.  
Client Id | The client ID to use for OAuth.  
The user ID used for OAuth.  
The company id. | The company ID used in SuccessFactors.  
The token url | The token URL that is passed to the identity provider to generate the OAuth Bearer token. | `https://api4.successfactors.com/oauth/token`  
Key Store | Allows to select the keystore file.  
Store Password | Corresponding keystore password.  
Type of the keystore.  
Certificate Alias | Alias name for the certificate stored in the keystore.  
The scopes.  
TLS Configuration | Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the `tls:context` child element of the `listener-config`.  
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.  
## List of Operations
  *   *   * Get Entity By ID
  * 

## Create Entity
`<successfactors:create-entity>`
Creates a new entity, the type of which is defined by the **Entity Set Name**.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Entity Set Name | Entity set name to which the created entity belongs.  
Properties | Properties of the entity. | #[payload]  
Target Variable | The name of a variable in which to place the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the **Target variable**. | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Response Attributes  
---|---  
### For Configurations
  * Default Configuration


### Throws
  * SUCCESSFACTORS:BAD_REQUEST
  * SUCCESSFACTORS:CONNECTIVITY
  * SUCCESSFACTORS:INVALID_INPUT
  * SUCCESSFACTORS:INVALID_PAGE_SIZE
  * SUCCESSFACTORS:METADATA_ERROR
  * SUCCESSFACTORS:NOT_FOUND
  * SUCCESSFACTORS:PARSE_ERROR
  * SUCCESSFACTORS:RETRY_EXHAUSTED
  * SUCCESSFACTORS:SERVER_ERROR
  * SUCCESSFACTORS:TIMEOUT
  * SUCCESSFACTORS:UNAUTHORIZED


## Delete Entity
`<successfactors:delete-entity>`
This operation deletes the entry for a specified entity.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Entity Set Name | Name of the entity set from which to delete the entity  
Key Properties | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### For Configurations
  * Default Configuration
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Response Attributes  
---|---  
### For Configurations
  * Default Configuration


### Throws
  * SUCCESSFACTORS:BAD_REQUEST
  * SUCCESSFACTORS:CONNECTIVITY
  * SUCCESSFACTORS:INVALID_INPUT
  * SUCCESSFACTORS:INVALID_PAGE_SIZE
  * SUCCESSFACTORS:METADATA_ERROR
  * SUCCESSFACTORS:NOT_FOUND
  * SUCCESSFACTORS:PARSE_ERROR
  * SUCCESSFACTORS:RETRY_EXHAUSTED
  * SUCCESSFACTORS:SERVER_ERROR
  * SUCCESSFACTORS:TIMEOUT
  * SUCCESSFACTORS:UNAUTHORIZED


## Delete Entity
`<successfactors:delete-entity>`
This operation deletes the entry for a specified entity.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Entity Set Name | Name of the entity set from which to delete the entity  
Key Properties | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### For Configurations
  * Default Configuration


### Throws
  * SUCCESSFACTORS:BAD_REQUEST
  * SUCCESSFACTORS:CONNECTIVITY
  * SUCCESSFACTORS:INVALID_INPUT
  * SUCCESSFACTORS:INVALID_PAGE_SIZE
  * SUCCESSFACTORS:METADATA_ERROR
  * SUCCESSFACTORS:NOT_FOUND
  * SUCCESSFACTORS:PARSE_ERROR
  * SUCCESSFACTORS:RETRY_EXHAUSTED
  * SUCCESSFACTORS:SERVER_ERROR
  * SUCCESSFACTORS:TIMEOUT
  * SUCCESSFACTORS:UNAUTHORIZED


## Get Entity By ID
`<successfactors:get-entity-by-id>`
Retrieves an entity by its specified key from the resource path of the URI.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Value of a `$select` System Query Option is a comma-separated list of selection clauses, each of which can be a Property name, Navigation Property name, or asterisk (*) character.  
The syntax of an `$expand` query option is a comma-separated list of Navigation Properties.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Entity Set Name | Entity set name to search using the entity with the given key.  
Key Properties | #[payload]  
Target Variable | Name of a variable in which to place the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the **Target variable**. | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Response Attributes  
---|---  
### For Configurations
  * Default Configuration


### Throws
  * SUCCESSFACTORS:BAD_REQUEST
  * SUCCESSFACTORS:CONNECTIVITY
  * SUCCESSFACTORS:INVALID_INPUT
  * SUCCESSFACTORS:INVALID_PAGE_SIZE
  * SUCCESSFACTORS:METADATA_ERROR
  * SUCCESSFACTORS:NOT_FOUND
  * SUCCESSFACTORS:PARSE_ERROR
  * SUCCESSFACTORS:RETRY_EXHAUSTED
  * SUCCESSFACTORS:SERVER_ERROR
  * SUCCESSFACTORS:TIMEOUT
  * SUCCESSFACTORS:UNAUTHORIZED


## Query
`<successfactors:query>`
This operation queries entities of a specified type.
You might receive duplicate records when using the **Query** operation with pagination. Use the **Idempotent** filter to remove any duplicates received.   
---  
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Entity Set Name | Name of the entity set in which to query.  
Pagination Type |  Enumeration, one of:
  * CLIENT
  * CURSOR
  * SNAPSHOT

|  Pagination type used by the **Query** operation:
  * `CLIENT` Uses query options on the client side to create an offset that restricts the amount of data returned from the server.
  * `CURSOR` Maintains a database cursor on the server throughout pagination HTTP requests. The `CURSOR` pagination type does not support `$orderby`.
  * `SNAPSHOT` Is a server-side pagination that works by keeping a list of all business keys of the dataset on the server. The `SNAPSHOT` pagination type does not support `$top` or `$skip`.

  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In-Memory Iterable
  * Repeatable File Store Iterable
  * Non-repeatable Stream

| Configure the streaming strategy for the connector.  
One of:
  *   *   *   *   *   *   *   *   * 
| Filters to apply to the query.  
Order By Values |  Array of Order By Value | Which fields the query is ordered by and their direction.  
Specifies that a response from an OData service should return a subset of the properties.  
The `$expand` parameter indicates a comma-separated list of Navigation Properties.  
Page Size | Chunk size of each query page.  
Maximum amount of records to retrieve.  
Amount of records to skip before retrieving records.  
Target Variable | The name of a variable in which to place the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the **Target variable**. | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Array of Object  
---  
### For Configurations
  * Default Configuration


### Throws
  * SUCCESSFACTORS:BAD_REQUEST
  * SUCCESSFACTORS:CONNECTIVITY
  * SUCCESSFACTORS:INVALID_INPUT
  * SUCCESSFACTORS:INVALID_PAGE_SIZE
  * SUCCESSFACTORS:METADATA_ERROR
  * SUCCESSFACTORS:NOT_FOUND
  * SUCCESSFACTORS:PARSE_ERROR
  * SUCCESSFACTORS:RETRY_EXHAUSTED
  * SUCCESSFACTORS:SERVER_ERROR
  * SUCCESSFACTORS:TIMEOUT
  * SUCCESSFACTORS:UNAUTHORIZED


## Update
`<successfactors:update>`
Updates the existing data in an entity, so all property values in the entity either take the values provided in the request body or are reset to their default value if no data is provided in the request.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Entity Set Name | Entity set name. This value is dynamically loaded from the SuccessFactors OData description file.  
Properties | The properties that are present on the new entity. These properties should contain the key of the entity. | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


### Throws
  * SUCCESSFACTORS:BAD_REQUEST
  * SUCCESSFACTORS:CONNECTIVITY
  * SUCCESSFACTORS:INVALID_INPUT
  * SUCCESSFACTORS:INVALID_PAGE_SIZE
  * SUCCESSFACTORS:METADATA_ERROR
  * SUCCESSFACTORS:NOT_FOUND
  * SUCCESSFACTORS:PARSE_ERROR
  * SUCCESSFACTORS:RETRY_EXHAUSTED
  * SUCCESSFACTORS:SERVER_ERROR
  * SUCCESSFACTORS:TIMEOUT
  * SUCCESSFACTORS:UNAUTHORIZED


## Upsert Entity
`<successfactors:upsert-entity>`
Creates or updates an entity on SuccessFactors, the type of which is defined by the **Entity Set Name** property. This method returns the full SAP SuccessFactors upsert response after it finishes executing.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Entity Set Name | Entity set name. This value is dynamically loaded from SuccessFactors OData description file.  
Properties | Properties that are present on the entity. | #[payload]  
Target Variable | Name of a variable on which to place the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the **Target variable**. | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
**Attributes Type** |  Response Attributes  
---|---  
#### For Configurations.
  * Default Configuration
## Upsert Entity
`<successfactors:upsert-entity>`
Creates or updates an entity on SuccessFactors, the type of which is defined by the **Entity Set Name** property. This method returns the full SAP SuccessFactors upsert response after it finishes executing.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Entity Set Name | Entity set name. This value is dynamically loaded from SuccessFactors OData description file.  
Properties | Properties that are present on the entity. | #[payload]  
Target Variable | Name of a variable on which to place the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the **Target variable**. | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
**Attributes Type** |  Response Attributes  
---|---  
#### For Configurations.
  * Default Configuration


### Throws
  * SUCCESSFACTORS:BAD_REQUEST
  * SUCCESSFACTORS:CONNECTIVITY
  * SUCCESSFACTORS:INVALID_INPUT
  * SUCCESSFACTORS:INVALID_PAGE_SIZE
  * SUCCESSFACTORS:METADATA_ERROR
  * SUCCESSFACTORS:NOT_FOUND
  * SUCCESSFACTORS:PARSE_ERROR
  * SUCCESSFACTORS:RETRY_EXHAUSTED
  * SUCCESSFACTORS:SERVER_ERROR
  * SUCCESSFACTORS:TIMEOUT
  * SUCCESSFACTORS:UNAUTHORIZED


## Types
### Default Header
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The value  
### Default Query Param
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The value  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enabled Protocols | A comma-separated list of protocols enabled for this context  
Enabled Cipher Suites | A comma-separated list of cipher suites enabled for this context  
Trust Store  
Key Store  
Revocation Check | 
  * Standard Revocation Check
  * Custom OCSP Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location to resolve relative to the current classpath and file system (if possible) of the truststore.  
Password | The password used to protect the trust store.  
The type of store used.  
Algorithm | The algorithm used by the truststore.  
Insecure | If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.  
### Key Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location to resolve relative to the current classpath and file system (if possible) of the keystore  
Type of store used  
When the key store contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.  
Key Password | Password used to protect the private key  
Password | Password used to protect the keystore  
Algorithm | The algorithm used by the keystore  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Only End Entities | Verify only the last element of the certificate chain.  
Prefer Crls | Try CRL instead of OCSP first.  
No Fallback | Do not use the secondary checking method (the one not selected previously).  
Soft Fail | Avoid verification failure when the revocation server cannot be reached or is busy.  
### Custom OCSP Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
Cert Alias | Alias of the signing certificate for the OCSP response (must be in the truststore), if present.  
### CRL File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the CRL file  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | 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 Forever

| The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to reconnect (in milliseconds)  
The number of reconnection attempts to make.  
If `false`, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to reconnect (in milliseconds)  
If `false`, the reconnection strategy runs in a separate, non-blocking thread.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | 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:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the maxIdleTime attribute  
### Response Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Status Code  
### Error Mapping
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * REDELIVERY_EXHAUSTED
  * TRANSFORMATION
  * EXPRESSION
  * SECURITY
  * CLIENT_SECURITY
  * SERVER_SECURITY
  * ROUTING
  * CONNECTIVITY
  * RETRY_EXHAUSTED
  * TIMEOUT

  
### Order By Value
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The field by which to order.  
Direction |  Enumeration, one of:
  * ASCENDING
  * DESCENDING
| A time unit that qualifies the maxIdleTime attribute  
### Response Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Status Code  
### Error Mapping
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * REDELIVERY_EXHAUSTED
  * TRANSFORMATION
  * EXPRESSION
  * SECURITY
  * CLIENT_SECURITY
  * SERVER_SECURITY
  * ROUTING
  * CONNECTIVITY
  * RETRY_EXHAUSTED
  * TIMEOUT

  
### Order By Value
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The field by which to order.  
Direction |  Enumeration, one of:
  * ASCENDING
  * DESCENDING

| The direction by which to order. Default is ASCENDING | ASCENDING  
### Repeatable In-Memory Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Initial Buffer Size | This is the amount of instances to initially allow to be kept 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 bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.  
Buffer Size Increment | 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 and that to raise a STREAM_MAXIMUM_SIZE_EXCEEDED error when the buffer gets full. Default value is 100 instances.  
Max Buffer Size | This is the maximum amount of memory to use. If more than that is used then raise a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value lower or equal to zero means no limit.  
### Repeatable File Store Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
In Memory Objects | This is the maximum number of instances to keep in memory. If more than that is required, then it starts to buffer the content on disk.  
Buffer Unit |  Enumeration, one of: | The unit in which maxInMemorySize is expressed  
### Non-repeatable Stream
In some cases, you may want to disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost.
### Default Proxy Configuration
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Host where the proxy requests are sent.  
Port where the proxy requests are sent.  
Username | The username to authenticate against the proxy.  
Password | The password to authenticate against the proxy.  
Non Proxy Hosts | A list of comma separated hosts against which the proxy should not be used.  
### NTLM
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Ntlm Domain | The domain to authenticate against the proxy.  
Host where the proxy requests are sent.  
Port where the proxy requests are sent.  
Username | The username to authenticate against the proxy.  
Password | The password to authenticate against the proxy.  
Non Proxy Hosts | A list of comma separated hosts against which the proxy should not be used.  
### Addition
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Value To Add | The value to add. Accepts a double.  
Field Name | The name of the field on which to operate.  
### Division
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The value by which the field value will be divided. This value should never be 0.  
Field Name | The name of the field on which to operate.  
### Module
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The value by which the field value will be divided. This value should never be 0.  
Field Name | The name of the field on which to operate.  
### Multiplication
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Multiplier | The value by which to multiply the value of the field.  
Field Name | The name of the field on which to operate.  
### Subtraction
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Value To Substract | The value to subtract. Accepts a double.  
Field Name | The name of the field on which to operate.  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Array of String | The list of values against which the field value will be checked.  
Field Name | The name of the field on which to operate.  
### Like
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The expression to evaluate against the field value.  
Field Name | The name of the field on which to operate.  
### Query Value
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Operators |  Array of One of:
  *   *   *   *   *   *   *   *   * 
  
### Equal To
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Compared Value  
Field Name  
### Greater Than
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Compared Value  
Field Name  
### Lesser Than
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Compared Value  
Field Name  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Negative |  One of:
  *   *   *   *   *   *   *   *   * 
  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Operators |  Array of One of:
  *   *   *   *   *   *   *   *   * 
  
### Grouping
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Operator |  One of:
  *   *   *   *   *   *   *   *   * 
  
Field Name  
### Ends With
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Ends With Value | The string value with which the field value should end.  
Field Name | The name of the field on which to operate.  
### Starts With
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Starts With Value | The string value with which the field value should start.  
Field Name | The name of the field on which to operate.  
### To Lowercase
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Field Name  
### To Uppercase
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Field Name  
### Trim
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Field Name  
## See Also
MuleSoft Help Center