# mulesoft NetSuite OpenAir Connector - Full Documentation
---
product: NetSuite OpenAir Connector
version: 2.0
is-latest-version: true
---
# NetSuite OpenAir 2.0 Examples
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
This example shows how to add, modify, read, and delete two customers from the NetSuite OpenAir
instance by using the same request. This example contains five flows:
1. The first flow configures a template for the input.
2. The second flow adds two customers from the input.
3. The third flow modifies the customer information of the two customers.
4. The fourth flow retrieves the modified customer information of the two customers.
5. The fifth flow deletes the two customers.
The following screenshot shows the flows in Anypoint Studio:

## Create the First Flow
The first flow configures an HTML template for the input to later use when adding, modifying,
reading, and deleting the two customers. Configuring this flow involves creating a new Mule project,
configuring the HTTP **Listener** source, and adding the **Parse Template** component.
### Configure the HTTP Listener Source
Configure the HTTP **Listener** source to initiate a Mule flow when a call is made to the default
path (`/`):
1. Create a new Mule project in Studio.
2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.
3. In the properties window, click **+** next to the **Connector configuration** field to add a
global element.
4. In the **Display Name** field, enter `Listener` and accept the default values.
### Add the Parse Template Component
Add the **Parse Template** component to create a template for an HTML form (`form.html`), which is
located in the main resources folder. The example uses this form to later add, modify, read, and
delete the two customers:
1. From the **Mule Palette** view, select **Core** and drag the **Parse Template** component next
to the **Listener** source.
2. In the **Location** field, enter `form.html`.
## Create the Second Flow
The second flow adds the two customers from the customer name and company input values. Configuring
this flow involves configuring the HTTP **Listener** source, adding the **Logger** component, adding
the **Transform Message** component, adding the **Add** operation, adding another **Transform
Message** component, and adding another **Logger** component.
### Configure the HTTP Listener Source
Configure the HTTP **Listener** source to initiate a Mule flow when a call is made to the `/add`
path:
1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.
2. In the properties window, click **+** next to the **Connector configuration** field to add a
global element.
3. In the **Display Name** field, enter `Listener`.
4. In the **Path** field, enter `/add`.
### Add the Logger Component
Add the **Logger** component to log the payload:
1. From the **Mule Palette** view, select **Core** and drag the **Logger** component next to the
**Listener** source.
2. In the **Message** field, enter `payload`.
### Add the Transform Message Component
Add the **Transform Message** component to transform the customer name and company input values of
the two customers to XML to add them later:
1. From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
next to the **Logger** component.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/xml
ns ns0 http://namespaces.soaplite.com/perl
---
{
ArrayOfoaBase: {
oaBase: {
ns0#oaCustomer: {
name: payload.customerName_1,
company: payload.customerCompany_1
},
ns0#oaCustomer: {
name: payload.customerName_2,
company: payload.customerCompany_2
}
}
}
}
```
### Add the Add Operation
Add the **Add** operation to add the two customers:
1. From the **Mule Palette** view, select **NetSuite OpenAir** and drag the **Add** operation next
to the **Transform Message** component.
2. In the properties window, complete the following fields:
| Field | Value |
|---|
oaObject | oaCustomer
|
Request | payload
|
### Add Another Transform Message Component
Add another **Transform Message** component to transform the customer name and company input values
of the two customers to JSON:
1. From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
next to the **Add** operation.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/json
ns ns0 http://namespaces.soaplite.com/perl
---
{
customerID_1: payload.ns0#ArrayOfUpdateResult.*updateResult[0].id,
customerID_2: payload.ns0#ArrayOfUpdateResult.*updateResult[1].id
}
```
### Add Another Logger Component
Add another **Logger** component to log the payload:
1. From the **Mule Palette** view, select **Core** and drag the **Logger** component next to the
**Transform Message** component.
2. In the **Message** field, enter `payload`.
## Create the Third Flow
The third flow modifies the customer information of the two customers. Configuring this flow
involves configuring the HTTP **Listener** source, adding the **Logger** component, adding the
**Transform Message** component, adding the **Modify** operation, adding another **Transform
Message** component, and adding another **Logger** component.
### Configure the HTTP Listener Source
Configure the HTTP **Listener** source to initiate a Mule flow when a call is made to the `/modify`
path:
1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.
2. In the properties window, click **+** next to the **Connector configuration** field to add a
global element.
3. In the **Display Name** field, enter `Listener`.
4. In the **Path** field, enter `/modify`.
### Add the Logger Component
Add the **Logger** component to log the payload:
1. From the **Mule Palette** view, select **Core** and drag the **Logger** component next to the
**Listener** source.
2. In the **Message** field, enter `payload`.
### Add the Transform Message Component
Add the **Transform Message** component to transform the customer name and company input values of
the two customers to XML to modify them later:
1. From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
next to the **Logger** component.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/xml
ns ns0 http://namespaces.soaplite.com/perl
---
//Some output fields where skipped as the structure is too deep (more than 2 levels).
//To add missing fields click on the scaffold icon (second on the toolbar).
{
modifyRequest: {
ArrayOfoaBase: {
oaBase : {
ns0#oaCustomer: {
id: payload.modifyCustomerID_1,
name: payload.modifyCustomerName_1,
company: payload.modifyCustomerCompany_1
},
ns0#oaCustomer: {
id: payload.modifyCustomerID_2,
name: payload.modifyCustomerName_2,
company: payload.modifyCustomerCompany_2
}
}
}
}
}
```
### Add the Modify Operation
Add the **Modify** operation to modify the customer information of the two customers:
1. From the **Mule Palette** view, select **NetSuite OpenAir** and drag the **Modify** operation
next to the **Transform Message** component.
2. In the properties window, complete the following fields:
| Field | Value |
|---|
oaObject | oaCustomer
|
Request | payload
|
### Add Another Transform Message Component
Add another **Transform Message** component to transform the modified customer name and company
values of the two customers to JSON:
1. From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
next to the **Modify** operation.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/json
ns ns0 http://namespaces.soaplite.com/perl
---
{
customerID_1: payload.ns0#ArrayOfUpdateResult.*updateResult[0].id,
customerStatus_1: payload.ns0#ArrayOfUpdateResult.*updateResult[0].status,
customerID_2: payload.ns0#ArrayOfUpdateResult.*updateResult[1].id,
customerStatus_2: payload.ns0#ArrayOfUpdateResult.*updateResult[1].status
}
```
### Add Another Logger Component
Add another **Logger** component to log the payload:
1. From the **Mule Palette** view, select **Core** and drag the **Logger** component next to the
**Transform Message** component.
2. In the **Message** field, enter `payload`.
## Create the Fourth Flow
The fourth flow retrieves the modified customer information of the two customers. Configuring this
flow involves configuring the HTTP **Listener** source, adding the **Logger** component, adding the
**Transform Message** component, adding the **Read** operation, adding another **Transform Message**
component, and adding another **Logger** component.
### Configure the HTTP Listener Source
Configure the HTTP **Listener** source to initiate a Mule flow when a call is made to the `/read`
path:
1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.
2. In the properties window, click **+** next to the **Connector configuration** field to add a
global element.
3. In the **Display Name** field, enter `Listener`.
4. In the **Path** field, enter `/read`.
### Add the Logger Component
Add the **Logger** component to log the payload:
1. From the **Mule Palette** view, select **Core** and drag the **Logger** component next to the
**Listener** source.
2. In the **Message** field, enter `payload`.
### Add the Transform Message Component
Add the **Transform Message** component to transform the customer name and company input values of
the two customers to XML to read them later:
1. From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
next to the **Logger** component.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/xml
ns ns0 http://namespaces.soaplite.com/perl
---
{
ns0#ArrayOfReadRequest: {
readRequest: {
method: "equal to",
fields: "id,name,company",
"type": "Customer",
objects :{
oaBase: {
oaCustomer: {
id: payload.readCustomerID_1
}
}
}
},
readRequest: {
method: "equal to",
fields: "id,name,company",
"type": "Customer",
objects :{
oaBase: {
oaCustomer: {
id: payload.readCustomerID_2
}
}
}
}
}
}
```
### Add the Read Operation
Add the **Read** operation to retrieve the modified customer information of the two customers:
1. From the **Mule Palette** view, select **NetSuite OpenAir** and drag the **Read** operation next
to the **Transform Message** component.
2. In the properties window, complete the following fields:
| Field | Value |
|---|
oaObject | oaCustomer
|
Request | payload
|
### Add Another Transform Message Component
Add another **Transform Message** component to transform the modified customer name and company
values of the two customers to JSON:
1. From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
next to the **Read** operation.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/json
ns ns0 http://namespaces.soaplite.com/perl
---
{
customerID_1: payload.ns0#ArrayOfReadResult.*readResult[0].objects.oaBase.oaCustomer.id,
customerName_1: payload.ns0#ArrayOfReadResult.*readResult[0].objects.oaBase.oaCustomer.name,
customerCompany_1: payload.ns0#ArrayOfReadResult.*readResult[0].objects.oaBase.oaCustomer.company,
customerID_2: payload.ns0#ArrayOfReadResult.*readResult[1].objects.oaBase.oaCustomer.id,
customerName_2: payload.ns0#ArrayOfReadResult.*readResult[1].objects.oaBase.oaCustomer.name,
customerCompany_2: payload.ns0#ArrayOfReadResult.*readResult[1].objects.oaBase.oaCustomer.company
}
```
### Add Another Logger Component
Add another **Logger** component to log the payload:
1. From the **Mule Palette** view, select **Core** and drag the **Logger** component next to the
**Transform Message** component.
2. In the **Message** field, enter `payload`.
## Create the Fifth Flow
The fifth flow deletes the customer information of the two customers. Configuring this flow involves
configuring the HTTP **Listener** source, adding the **Logger** component, adding the **Transform
Message** component, adding the **Delete** operation, adding another **Transform Message**
component, and adding another **Logger** component.
### Configure the HTTP Listener Source
Configure the HTTP **Listener** source to initiate a Mule flow when a call is made to the `/delete`
path:
1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.
2. In the properties window, click **+** next to the **Connector configuration** field to add a
global element.
3. In the **Display Name** field, enter `Listener`.
4. In the **Path** field, enter `/delete`.
### Add the Logger Component
Add the **Logger** component to log the payload:
1. From the **Mule Palette** view, select **Core** and drag the **Logger** component next to the
**Listener** source.
2. In the **Message** field, enter `payload`.
### Add the Transform Message Component
Add the **Transform Message** component to transform the customer name and company input values of
the two customers to XML to delete them later:
1. From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
next to the **Logger** component.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/xml
ns ns0 http://namespaces.soaplite.com/perl
---
{
ArrayOfoaBase: {
oaBase: {
ns0#oaCustomer: {
id: payload.deleteCustomerID_1
},
ns0#oaCustomer: {
id: payload.deleteCustomerID_2
}
}
}
}
```
### Add the Delete Operation
Add the **Delete** operation to delete the customer information of the two customers:
1. From the **Mule Palette** view, select **NetSuite OpenAir** and drag the **Delete** operation
next to the **Transform Message** component.
2. In the properties window, complete the following fields:
| Field | Value |
|---|
oaObject | oaCustomer
|
Request | payload
|
### Add Another Transform Message Component
Add another **Transform Message** component to transform the customer name and company values of the
two customers to JSON:
1. From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
next to the **Delete** operation.
2. In the properties window, overlay the brackets in the **Output** section with this DataWeave
code:
```dataweave
%dw 2.0
output application/json
ns ns0 http://namespaces.soaplite.com/perl
---
{
Status1: payload.ns0#ArrayOfUpdateResult.*updateResult[0].status,
Status2: payload.ns0#ArrayOfUpdateResult.*updateResult[1].status
}
```
### Add Another Logger Component
Add another **Logger** component to log the payload:
1. From the **Mule Palette** view, select **Core** and drag the **Logger** component next to the
**Transform Message** component.
2. In the **Message** field, enter `payload`.
## XML for the Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite OpenAir Connector
version: 2.0
is-latest-version: true
---
# NetSuite OpenAir Connector
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
NetSuite OpenAir Connector v2.0
Anypoint Connector for NetSuite OpenAir (NetSuite OpenAir Connector) is a closed-source enterprise
connector that provides a connection between OpenAir and third-party software.
Release Notes:
[NetSuite OpenAir Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-openair-connector-release-notes-mule-4)
Exchange:
[NetSuite OpenAir Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-netsuite-openair-connector/)
## Before You Begin
To use this information, you must be familiar with NetSuite OpenAir, Mule runtime engine (Mule),
Anypoint Connectors, Anypoint Studio, Mule concepts, elements in a Mule flow, and Global Elements.
To use this connector, you need:
- A NetSuite OpenAir instance
- A set of valid credentials, including username, password, companyID, API namespace, and key.
- A MuleSoft Enterprise License
OpenAir complex types are limited to a set of OpenAir operations. See the OpenAir documentation for
information about its object types. For example, object `oaActualCost` works with `read`, `add`,
`modify`, and `upsert` methods, while object `oaApproval` works only with the `submit` method.
## POM File Information
```xml
com.mulesoft.connectors
mule-netsuite-openair-connector
x.x.x
mule-plugin
```
Replace `x.x.x` with the version that corresponds to the connector you are using.
To obtain the most up-to-date `pom.xml` file information, access the connector in
[Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**.
## Add the Connector to Your Project
Anypoint Studio provides two ways to add the connector to your Studio project: from the Exchange
button in the Studio taskbar or from the Mule Palette view.
### Add the Connector Using Exchange
1. In Studio, create a Mule project.
2. Click the Exchange icon **(X)** in the upper-left of the Studio task bar.
3. In Exchange, click **Login** and supply your Anypoint Platform username and password.
4. In Exchange, search for "openair".
5. Select the connector and click **Add to project**.
6. Follow the prompts to install the connector.
### Add the Connector in Studio
1. In Studio, create a Mule project.
2. In the Mule Palette view, click **(X) Search in Exchange**.
3. In **Add Modules to Project**, type "openair" in the search field.
4. Click this connector’s name in **Available modules**.
5. Click **Add**.
6. Click **Finish**.
## Configure in Studio
1. Drag the connector operation to the Studio Canvas.
2. Configure the Global Element for the connector:

3. If needed, configure a connection:

1. Enable the automatic reconnection feature.
2. Access the OpenAir Global Element configuration window from Studio.
3. Click the **Advanced** tab (next to Connection).
4. Select the **Standard** option in Reconnection Strategy.
5. Adjust the **Frequency (ms)** and **Reconnection Attempts** fields accordingly.
## Log HTTP Requests and Responses
To log the HTTP interactions of the connector with NetSuite OpenAir, configure the log4j2.xml file
for the Mule app as follows, and use a Logger component in your project to display the results:
```xml
```
## See Also
- [NetSuite OpenAir SOAP API Guide (PDF)](https://www.netsuitesuiteprojectspro.com/download/XMLAndSOAPAPI.pdf)
- [Salesforce Help](https://help.salesforce.com)
---
product: NetSuite OpenAir Connector
version: 2.0
is-latest-version: true
---
# NetSuite OpenAir Connector Reference
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
NetSuite OpenAir Connector v2.0
Release Notes:
[NetSuite OpenAir Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-openair-connector-release-notes-mule-4)
## 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 | | | | x |
Username | | | | x |
Password | | | | x |
Api Namespace | | | | x |
Api Key | | | | x |
Endpoint | | Open Enpoint. Default value: https://sandbox.openair.com/soap | https://sandbox.openair.com/soap
| |
Connection Timeout | | Connection Timeout. Default value: 300 seconds | 300 | |
Read Timeout | | 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 | | |
## Associated Operations
- [Add](#add)
- [Create Account](#createAccount)
- [Create User](#createUser)
- [Delete](#delete)
- [Get Crystal Info](#getCrystalInfo)
- [Make URL](#makeUrl)
- [Modify](#modify)
- [Read](#read)
- [Run Report](#runReport)
- [Server Time](#serverTime)
- [Server Time With Timezone](#serverTimeWithTimezone)
- [Submit](#submit)
- [Upsert](#upsert)
- [Who am I](#whoAmI)
## Operations
## 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 | | oaObject to add. | | x |
Request | | Request containing the add request. | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | Request containing the create account request | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | Request containing the create user request | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | oaObject to Delete | | x |
Request | | Request containing the delete request | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | Request containing the makeURL request | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
Modifies an OpenAir object.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
oaObject | | OpenAir Object to modify. | | x |
Request | | Request containing the modify request. | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | oaObject to read. | | x |
Request | | Request containing the read request. | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
Runs a defined Report.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Request | | Request containing the RunReport request. | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
Returns the current server time.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
Request | | Request containing the server time request. | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
Submits an OpenAir object for approval.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | The name of the configuration to use. | | x |
oaObject | | oaObject for submission | | x |
Request | | Request containing the Submit request. | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | oaObject to upsert. | | x |
Request | | Request containing the upsert request. | #[payload]
| |
Streaming Strategy | | Configure to use repeatable streams. | | |
Target Variable | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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
``
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 | | The name of a variable in which to store the output of the operation. | | |
Target Value | | 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
### For Configurations
- [Default Configuration](#config)
### 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 | | 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 | | How often to reconnect (in milliseconds). | | |
Count | | The number of reconnection attempts to make. | | |
blocking | | If false, the reconnection strategy runs in a separate, non-blocking thread. | | |
### Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often in milliseconds to reconnect. | | |
blocking | | If false, the reconnection strategy runs in a separate, non-blocking thread. | | |
## Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|
Max Idle Time | | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration. | | |
Time Unit | 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 | | 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 | | 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 | | 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 | | The unit in which all these attributes are expressed | | |
## Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|
Max In Memory Size | | 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 | | The unit in which maxInMemorySize is expressed | | |
## See Also
[Salesforce Help](https://help.salesforce.com)