NetSuite Restlet Connector 1.0 Reference

Anypoint Connector for NetSuite Restlet (NetSuite Restlet Connector) synchronizes data and automates business processes between NetSuite and third party applications, either on-premises or in the cloud.

Rest Configuration

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 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

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.

Connection Types

Restlet Login

Name Type Description Default Value Required

Web Service Endpoint

String

The Web Service endpoint.

Read Timeout

Number

Specifies the amount of time that the client will wait for a response before it times out.

60000

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout parameter.

MILLISECONDS

Connection Timeout

Number

Specifies the amount of time in milliseconds that the client attempts to establish a connection before it times out. 0 specifies that the client continues to attempt to open a connection indefinitely.

60000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit for Connection Timeout.

MILLISECONDS

TLS configuration

TLS

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.

Host

String

Hostname of the HTTP proxy, for example localhost. If used, you must also set the Port value.

Port

Number

The port number of the HTTP proxy, for example 3128. The port number must be specified if the Hostname is also specified.

Username

String

The username which should be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy.

Password

String

The password which would be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy.

E-mail

String

The login email of both NetSuite UI and SuiteTalk

x

Password

String

The login password of both the NetSuite UI and SuiteTalk

x

Account

String

NetSuite SuiteTalk WebService account ID

x

Role ID

String

The ID of the role used to login in SuiteTalk, which determines the Processor privileges

x

Application ID

String

The ID related to the Integration record to be used. Integration records are set up on the NetSuite environment.

x

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.

Pooling Profile

Characteristics of the connection pool

Restlet Token

Name Type Description Default Value Required

Web Service Endpoint

String

The Web Service endpoint.

Read Timeout

Number

Specifies the amount of time that the client will wait for a response before it times out.

60000

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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. 0 specifies that the client will continue to attempt to open a connection indefinitely.

60000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit for Connection Timeout.

MILLISECONDS

TLS configuration

TLS

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.

Host

String

Hostname of the HTTP proxy, for example localhost. If used, you must also set the Port value.

Port

Number

The port number of the HTTP proxy, for example 3128. The port number must be specified if the Hostname is also specified.

Username

String

Username that is supplied to the HTTP proxy upon every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy.

Password

String

Password that is supplied to the HTTP proxy upon every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy.

Consumer Key

String

Consumer key value for the token based authentication-enabled integration record that is being used.

x

Consumer Secret

String

Consumer secret value for the token based authentication-enabled integration record that is being used.

x

Token ID

String

Token ID that represents 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

String

NetSuite SuiteTalk WebService account ID.

x

Signature Algorithm

String

Algorithm used to compute the SHA hash signature.

HMAC_SHA_256

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.

Pooling Profile

Characteristics of the connection pool.

Operations

Call RESTlet (DELETE)

<netsuite-restlet:call-restlet-delete>

Calls a NetSuite RESTlet using the DELETE method.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Script

Number

The ID of the deployed script.

x

Deploy

Number

The deploy number corresponding to the script.

x

Data

Object

The input data for the script.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

x

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • NETSUITE-RESTLET:CONNECTIVITY

  • NETSUITE-RESTLET:ERROR_FAULT

  • NETSUITE-RESTLET:MAPPING_ERROR

  • NETSUITE-RESTLET:PARSING_ERROR

  • NETSUITE-RESTLET:RETRY_EXHAUSTED

Call RESTlet (GET)

<netsuite-restlet:call-restlet-get>

Calls a NetSuite RESTlet using the GET method.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Script

Number

The ID of the deployed script.

x

Deploy

Number

The deploy number corresponding to the script.

x

Data

Object

The input data for the script.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

x

Target Variable

String

Name of the variable that stores 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 Object

For Configurations

Throws

  • NETSUITE-RESTLET:CONNECTIVITY

  • NETSUITE-RESTLET:ERROR_FAULT

  • NETSUITE-RESTLET:MAPPING_ERROR

  • NETSUITE-RESTLET:PARSING_ERROR

  • NETSUITE-RESTLET:RETRY_EXHAUSTED

Call RESTlet (POST)

<netsuite-restlet:call-restlet-post>

Calls a NetSuite RESTlet using the POST method.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Script

Number

The ID of the deployed script.

x

Deploy

Number

The deploy number corresponding to the script.

x

Data

Object

The input data for the script.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Target Variable

String

Name of the variable that stores 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 Object

For Configurations

Throws

  • NETSUITE-RESTLET:CONNECTIVITY

  • NETSUITE-RESTLET:ERROR_FAULT

  • NETSUITE-RESTLET:MAPPING_ERROR

  • NETSUITE-RESTLET:PARSING_ERROR

  • NETSUITE-RESTLET:RETRY_EXHAUSTED

Call RESTlet (PUT)

<netsuite-restlet:call-restlet-put>

Calls a NetSuite RESTlet using the PUT method.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Script

Number

The ID of the deployed script.

x

Deploy

Number

The deploy number corresponding to the script.

x

Data

Object

The input data for the script.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Target Variable

String

Name of the variable that stores 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 Object

For Configurations

Throws

  • NETSUITE-RESTLET:CONNECTIVITY

  • NETSUITE-RESTLET:ERROR_FAULT

  • NETSUITE-RESTLET:MAPPING_ERROR

  • NETSUITE-RESTLET:PARSING_ERROR

  • NETSUITE-RESTLET:RETRY_EXHAUSTED

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.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

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 ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)

Disabled

Boolean

Whether pooling should be disabled

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute