NetSuite Connector 11.1 Reference
Anypoint Connector for NetSuite synchronizes data and automates business processes between NetSuite and third party applications, either on-premises or in the cloud. The connector makes use of the SuiteTalk WSDL to provide SOAP based integration to generate NetSuite business objects, make use of different authentication levels, and support error handling.
Release Notes: NetSuite Connector Release Notes
Configurations
Config
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types to provide to this configuration. |
x |
||
Name |
String |
The identifier of this element used to reference it in other components |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
|||
Show warnings as errors |
Boolean |
When this preference is enabled, warning messages generated by NetSuite are treated as errors that cause an exception, resulting in rejection of the request. |
false |
|
Disable mandatory custom field validation |
Boolean |
This preference affects the handling of custom fields that are configured in the UI to be mandatory:
|
false |
|
Disable system notes for custom fields |
Boolean |
System notes are system-generated records that track changes to a record, including changes to specific field values. This preference lets you disable the creation of system notes for changes to custom fields. Depending on your integration, using this preference can increase performance. |
false |
|
Ignore read-only fields |
Boolean |
This preference affects the way the system behaves when you mistakenly submit a value for a read-only field. If you set this preference to |
false |
|
Run server SuiteScript and trigger workflows |
Boolean |
Controls SuiteScript and trigger workflows per request:
|
false |
|
Customizations Separator |
String |
Separator used to generate the keys required to provided better support for custom fields and records. If the script ID of the customization that defines a custom field or record contains the separator default character, set up a new ID and regenerate the metadata. |
__ |
Connection Types
The connection types to provide to this configuration.
Token-Based Authentication
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Maximum Connections |
Number |
The maximum number of connections that can be active to execute the HTTP requests. The default value, |
-1 |
|
Read Timeout |
Number |
Specifies the amount of time that the client waits for a response before it times out. Use |
60000 |
|
Read Timeout Unit |
Enumeration, one of:
|
The time unit for Read Timeout. |
MILLISECONDS |
|
Connection Timeout |
Number |
Specifies the amount of time that the client attempts to establish a connection before it times out. Use |
60000 |
|
Connection Timeout Unit |
Enumeration, one of:
|
The time unit for Connection Timeout. |
MILLISECONDS |
|
Base Netsuite Address |
String |
The base address to use to connect to NetSuite. The default value is the main NetSuite site. This is used to automatically obtain the endpoint for the service based on the credentials configured, and will need no change. |
||
SOAP Port |
String |
The SOAP Port path to use to connect to NetSuite, this is relative to the base address. The default value corresponds to the port obtained from the WSDL used in the version of the connector. |
x |
|
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 |
|||
Host |
String |
The hostname of the HTTP proxy, for example, |
||
Port |
Number |
The port number of the HTTP proxy, for example, |
||
Username |
String |
The username to supply to the HTTP proxy on every request to NetSuite. This field is optional because a user might want to pass through an unauthenticated HTTP proxy. |
||
Password |
String |
The password to supply to the HTTP proxy on every request to NetSuite. This field is optional because a user might want to pass through an unauthenticated HTTP proxy. |
||
Non proxied hosts |
String |
A list of comma-separated hosts against which the proxy should not be used |
||
Consumer Key |
String |
The consumer key value for the enabled token-based authentication integration record |
x |
|
Consumer Secret |
String |
The consumer secret value for the token-based authentication integration record |
x |
|
Token ID |
String |
The token ID representing the unique combination of a user and integration generated within the NetSuite environment |
x |
|
Token Secret |
String |
The respective token secret for the user/integration pair |
x |
|
Account Id |
String |
NetSuite SuiteTalk WebService account ID. |
x |
|
Signature Algorithm |
String |
The algorithm used to compute the SHA hash signature |
HMAC_SHA256 |
|
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
Add
<netsuite:add>
Creates a new record.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The message to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add List
<netsuite:add-list>
Creates one or more new records.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The add list request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Async Add List
<netsuite:async-add-list>
An asynchronous request equivalent to Add List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which places it in a processing queue and handles it asynchronously with other requests. All available jobs for each polling period are processed contiguously, with no waiting period for an available job.
Once a job is initiated, NetSuite returns a job ID in the web services response. Your client application can check the status and result of the request by referencing the job ID.
| Asynchronous request job IDs are valid for 30 days. |
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The Async Add List request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Async Delete List
<netsuite:async-delete-list>
An asynchronous request equivalent to the Delete List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which places it in a processing queue and handles it asynchronously with other requests. All available jobs for each polling period are processed contiguously, with no waiting period for an available job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client application can check the status and result of the request by referencing the job ID.
| Asynchronous request job IDs are valid for 30 days. |
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The Async Delete List request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Async Get List
<netsuite:async-get-list>
An asynchronous request equivalent to the Get List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which places it in a processing queue and handles it asynchronously with other requests. All available jobs for each polling period are processed contiguously, with no waiting period for an available job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client application can check the status and result of the request by referencing the job ID.
| Asynchronous request job IDs are valid for 30 days. |
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The Async Get List request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Async Initialize List
<netsuite:async-initialize-list>
An asynchronous request equivalent to the Initialize List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which places it in a processing queue and handles it asynchronously with other requests. All available jobs for each polling period are processed contiguously, with no waiting period for an available job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client application can check the status and result of the request by referencing the job ID.
| Asynchronous request job IDs are valid for 30 days. |
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The Async Initialize List request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Async Search
<netsuite:async-search>
An asynchronous request equivalent to the Search operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which places it in a processing queue and handles it asynchronously with other requests. All available jobs for each polling period are processed contiguously, with no waiting period for an available job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client application can check the status and result of the request by referencing the job ID.
| Asynchronous request job IDs are valid for 30 days. |
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
The type of search that renders the output metadata. |
||
Message |
Any |
The Async Search request to complete. |
#[payload] |
|
Body Fields Only |
Boolean |
Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to |
true |
|
Return Search Columns |
Boolean |
If |
true |
|
Page Size |
Number |
Maximum amount of results per page. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Async Update List
<netsuite:async-update-list>
An asynchronous request equivalent to the Update List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which places it in a processing queue and handles it asynchronously with other requests. All available jobs for each polling period are processed contiguously, with no waiting period for an available job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client application can check the status and result of the request by referencing the job ID.
| Asynchronous request job IDs are valid for 30 days. |
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The Async Update List request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Async Upsert List
<netsuite:async-upsert-list>
An asynchronous request equivalent to the Upsert List operation.
In asynchronous requests, your client application sends a request to the SuiteTalk platform, which places it in a processing queue and handles it asynchronously with other requests. All available jobs for each polling period are processed contiguously, with no waiting period for an available job.
Once a job is initiated, SuiteTalk returns a job ID in the web services response. Your client application can check the status and result of the request by referencing the job ID.
| Asynchronous request job IDs are valid for 30 days. |
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The Async Upsert List request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Attach
<netsuite:attach>
Defines a relationship between two records.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The attach request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Change Email
<netsuite:change-email>
Changes the email address for the account.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
New Email |
String |
Your new email address. |
x |
|
Current Credentials |
String |
Your current credentials. |
x |
|
Just This Account |
Boolean |
Whether to change this account only. |
true |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Change Password
<netsuite:change-password>
Changes the password for the account.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
New Password |
String |
The new password. |
x |
|
Current Password |
String |
Your current credentials. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Check Async Status
<netsuite:check-async-status>
Checks whether a particular asynchronous job finished processing.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job Id |
String |
The ID of the job. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete
<netsuite:delete>
Delete one or more record instances. Not all records can be deleted. For more information, see the NetSuite documentation.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The delete request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Ref Type |
String |
|||
Type |
String |
|||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete List
<netsuite:delete-list>
Deletes one or more records. Not all records can be deleted. For more information, see the NetSuite documentation.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The delete list request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Ref Type |
String |
|||
Type |
String |
|||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Detach
<netsuite:detach>
Deletes a relationship between two records.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The detach request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get
<netsuite:get>
Retrieves a record by providing the unique ID that identifies the record.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
#[payload] |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Ref Type |
String |
|||
Type |
String |
|||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Account Governance Info
<netsuite:get-account-governance-info>
Get the account concurrency limit and the unallocated concurrency limit.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All
<netsuite:get-all>
Retrieves a list of all records of the specified type.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
|||
Message |
Any |
The get All request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Async Result
<netsuite:get-async-result>
Returns the result of the specified job if it finished processing.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job Id |
String |
The ID of the job. |
x |
|
Page Index |
Number |
The page number of the asynchronous result. |
1 |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Budget Exchange Rate
<netsuite:get-budget-exchange-rate>
Gets and filters all data related to the Budget Exchange Rates table. This table maintains exchange rates between the root-parent and child subsidiaries for use in the budgeting process.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The Get Budget Exchange Rate request, which contains a budgetExchangeRateFilter. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Currency Rate
<netsuite:get-currency-rate>
Gets the exchange rate between two currencies based on the specified certain date.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
Accepts the argument CurrencyRateFilter, which specifies what to return in the results. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Customization Id
<netsuite:get-customization-id>
Returns the IDs of available customizations for a given customization type.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
Customization type |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Data Center Urls
<netsuite:get-data-center-urls>
Obtains the NetSuite data center URL for the account.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Deleted
<netsuite:get-deleted>
Returns a list of deleted records for the given record type and date range.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Filter |
Any |
Filters the results |
#[payload] |
|
Limit |
Number |
The maximum amount of results to return from this call |
-1 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Output
Type |
Array of Message of [String] payload and [Netsuite Soap Attributes] attributes |
Get Integration Governance Info
<netsuite:get-integration-governance-info>
Get the concurrency limit for the integration (integrationConcurrencyLimit) and the limit type (limitType), which can be:
-
_integrationSpecific, when a limit has been allocated.
-
_internal, when it is an internal application. In this case the limit is not displayed.
-
_accountLimit, when no specific limit has been allocated to the integration.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Item Availability
<netsuite:get-item-availability>
Returns the availability for a given item record reference. If the Multi-Location Inventory feature is enabled, connector returns results for all locations.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The GetItem Availability Request type, which contains an itemAvailabilityFilter |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get List
<netsuite:get-list>
Retrieves a list of one or more records by providing the unique ids that identify those records.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The get list request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Ref Type |
String |
|||
Type |
String |
|||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Posting Transaction Summary
<netsuite:get-posting-transaction-summary>
Retrieves a summary of the data posted to the general ledger in an account. You can use the available filters and fields to generate reports that are similar to what you see when you run financial reports such as a Trial Balance, Balance Sheet, or an Income Statement.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Fields |
Any |
Fields for the operation body |
||
Filters |
Any |
Filters for the operation body |
||
Operation Id |
String |
Operation ID |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Output
Type |
Array of Message of [String] payload and [Netsuite Soap Attributes] attributes |
Get Saved Search
<netsuite:get-saved-search>
Retrieves a list of existing saved search IDs on a per-record-type basis.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Search Type |
String |
The targeted search type. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Select Value
<netsuite:get-select-value>
Returns valid select options for a particular RecordRef, CustomRecordRef, or enumerated static field.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Description |
Any |
The get select value request to complete. |
#[payload] |
|
Page Size |
Number |
10 |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Output
Type |
Array of Message of [String] payload and [Netsuite Soap Attributes] attributes |
Get Server Time
<netsuite:get-server-time>
Returns the NetSuite server time in GMT, regardless of a user’s time zone.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Initialize
<netsuite:initialize>
Pre-populates fields on transaction line items with values from a related record.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The initialize request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Initialize List
<netsuite:initialize-list>
Pre-populates fields on transaction line items with values from related records.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The initialize list request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Search
<netsuite:search>
Executes a search on a specific record type based on a set of criteria. This processor has been enhanced with a paging mechanism. Searches can be Basic, Advanced, or Join searches. See SearchRecord for all the available searches.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
The type of search to render the output metadata. |
||
Message |
Any |
The search request to complete. |
#[payload] |
|
Page Size |
Number |
Maximum amount of results per page. |
10 |
|
Limit |
Number |
Limits the amount of results produced. Limit <=0 means no limit |
-1 |
|
Body Fields Only |
Boolean |
Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to |
true |
|
Return Search Columns |
Boolean |
Defaults to |
true |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Output
Type |
Array of Message of [String] payload and [Netsuite Soap Attributes] attributes |
Update
<netsuite:update>
Updates an existing record.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The update record request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Invitee Status
<netsuite:update-invitee-status>
Sets a new invitation status for a given event.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The update invitee status request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Invitee Status List
<netsuite:update-invitee-status-list>
Sets multiple new invitation statuses for a given event.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Message |
Any |
The update invitee status list request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update List
<netsuite:update-list>
Updates one or more instances of a record type. If there are multiple records, they can either be of the same record type or different record types.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The update list request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Upsert
<netsuite:upsert>
Adds a new instance or updates a record instance in NetSuite. This operation is similar to both the Add and Update operations, but you can run Upsert without first determining whether a record exists in NetSuite.
Identify a record by its external ID and its record type. If a record of the specified type with a matching external ID exists in the system, it is updated. If it does not exist, a new record is created. Because the external ID is mandatory for this operation, Upsert is supported only for records that support the external ID field. This operation prohibits the passing of internal ID values.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The Upsert request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Upsert List
<netsuite:upsert-list>
Adds or updates one or more instances of a record type in NetSuite. This operation is similar to both the Add List and Update List operations, but you can run Upsert List without first determining whether the record types exist in NetSuite.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
The record type for the operation. |
||
Message |
Any |
The Upsert List request to complete. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
On Deleted Object
<netsuite:deleted-object-listener>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start Date Time |
DateTime |
Specify a local date. If this field is empty, this operation retrieves the selected objects from the time when the Mule app started. |
||
Page Size |
Number |
Maximum amount of results per page. |
10 |
|
Body Fields Only |
Boolean |
Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to |
true |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling |
x |
|
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
On Modified Object
<netsuite:modified-object-listener>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start Date Time |
DateTime |
Specify a local date. If this field is empty, this operation retrieves the selected objects from the time the Mule app started. |
||
Page Size |
Number |
Maximum amount of results per page. |
10 |
|
Body Fields Only |
Boolean |
Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to |
true |
|
Object Type |
String |
The type of record that will be retrieved when modified. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling |
x |
|
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
On New Object
<netsuite:new-object-listener>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start Date Time |
DateTime |
Specify a local date. If this field is empty, this operation will retrieve the selected objects from the time the Mule app was started. |
||
Page Size |
Number |
Maximum amount of results per page. |
10 |
|
Body Fields Only |
Boolean |
Returns the information in the record’s body fields only, which significantly improves performance. Fields in associated lists or sublists are not returned. If you set this field to |
true |
|
Object Type |
String |
The type of record that will be retrieved when modified. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling |
x |
|
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Types
Tls
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom Ocsp Responder
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
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 |
The reconnection strategy to use. |
Reconnect
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If |
||
Count |
Number |
How many reconnection attempts to make. |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If |
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:
|
A time unit that qualifies the maxIdleTime attribute |
Netsuite Soap Attributes
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Soap Headers |
Object |
|||
Transport Additional Data |
Object |
|||
Transport Headers |
Object |
Redelivery Policy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Redelivery Count |
Number |
The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message |
||
Message Digest Algorithm |
String |
The secure hashing algorithm to use. If not set, the default is SHA-256. |
||
Message Identifier |
Defines which strategy is used to identify the messages. |
|||
Object Store |
ObjectStore |
The object store where the redelivery counter for each message is stored. |
Redelivery Policy Message Identifier
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Use Secure Hash |
Boolean |
Whether to use a secure hash algorithm to identify a redelivered message. |
||
Id Expression |
String |
Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
File store repeatable streams require buffering, and there are different buffering strategies. Mule keeps a portion of contents in memory. If the stream contents are larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The number of instances to initially keep 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 |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects |
Number |
The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |