Nav

NetSuite OpenAir Connector Reference

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances as it sees fit.

Connection Types

Login Authentication

Parameters

Name Type Description Default Value Required

Company

String

x

Username

String

x

Password

String

x

Api Namespace

String

x

Api Key

String

x

Endpoint

String

Open Enpoint. Default value: https://sandbox.openair.com/soap

https://sandbox.openair.com/soap

Connection Timeout

Number

Connection Timeout. Default value: 300 seconds

300

Read Timeout

Number

Read Timeout: Default value: 270 seconds

270

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

Operations

Add

<openair:add>

Adds data to NetSuite OpenAir instance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

oaObject

String

oaObject to add.

x

Request

Binary

Request containing the add request.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:READ_ERROR

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:UNKNOWN

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:XML_PARSING

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

Create Account

<openair:create-account>

Creates an account in the NetSuite OpenAir instance

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request

Binary

Request containing the create account request

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Create User

<openair:create-user>

Creates a user in the NetSuite OpenAir instance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request

Binary

Request containing the create user request

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Delete

<openair:delete>

Deletes an oaObject from the NetSuite OpenAir instance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

oaObject

String

oaObject to Delete

x

Request

Binary

Request containing the delete request

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Get Crystal Info

<openair:get-crystal-info>

Get Crystal Information from NetSuite OpenAir instance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Make URL

<openair:make-url>

The makeURL creates a valid URL to a specified OpenAir page. It requires a valid user login to succeed.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request

Binary

Request containing the makeURL request

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Modify

<openair:modify>

Modifies an OpenAir object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

oaObject

String

OpenAir Object to modify.

x

Request

Binary

Request containing the modify request.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Read

<openair:read>

Reads data from a NetSuite OpenAir instance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

oaObject

String

oaObject to read.

x

Request

Binary

Request containing the read request.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Run Report

<openair:run-report>

Runs a defined Report.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request

Binary

Request containing the RunReport request.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:READ_ERROR

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:UNKNOWN

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:XML_PARSING

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

Server Time

<openair:server-time>

Returns the current server time.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:READ_ERROR

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:UNKNOWN

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:XML_PARSING

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

Server Time With Timezone

<openair:server-time-with-timezone>

Returns the current server time.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request

Binary

Request containing the server time request.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Submit

<openair:submit>

Submits an OpenAir object for approval.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

oaObject

String

oaObject for submission

x

Request

Binary

Request containing the Submit request.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Upsert

<openair:upsert>

Upserts the oaObject to the NetSuite OpenAir instance. The upsert operation adds or modifies an OpenAir object based on the lookup attributes.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

oaObject

String

oaObject to upsert.

x

Request

Binary

Request containing the upsert request.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Who am I

<openair:who-am-i>

Gets information about the current user.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • OPENAIR:ADD_MODIFY_ERROR

  • OPENAIR:CONNECTIVITY

  • OPENAIR:CREATE_ACCOUNT_ERROR

  • OPENAIR:CREATE_USER_ERROR

  • OPENAIR:DELETE_ERROR

  • OPENAIR:EXECUTION

  • OPENAIR:MAKE_URL_ERROR

  • OPENAIR:OPERATION_FAILED

  • OPENAIR:READ_ERROR

  • OPENAIR:RETRY_EXHAUSTED

  • OPENAIR:SUBMIT_ERROR

  • OPENAIR:UNKNOWN

  • OPENAIR:WSDL_PARSING_PROBLEM

  • OPENAIR:XML_PARSING

Types

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.

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

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.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate 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

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

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.

+