Query Records (NetSuite) activity

An activity that uses a SQL WHERE clause to query one or more entity records in NetSuite.


Query Records activity

Configure the Query Records activity

To configure the Query Records activity, do the procedure in this topic.

Prerequisites

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the NetSuite NetSuite icon tab.
      2. On the NetSuite NetSuite icon tab, drag the Query Records Query Records icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a CRM Activity.

  2. Click Query Records Query Records icon.
  3. Complete the fields on these screens.
    1. Query Record Configuration > Column tab.
    2. Query Record Configuration > Where tab.
    3. Query Record Configuration > Output Mapping tab.
    4. Query Record Configuration > Test tab.

    For more information, refer to Get Entity Records from NetSuite with a SQL Query.

  4. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Query Records activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Connection Timeout (Seconds)

Function:
Specifies the number of seconds permitted to complete an action before the connection stops.
Accepted Values:
An integer that represents a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

Query Records Configuration > Column tab

Specifies the entity columns to query.

Figure: Query Records Configuration > Column tab

Query Records Configuration Column tab

Fields

Field Name Definition

NetSuite

Function:
Specifies the access token that connects to your NetSuite application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Add Token Add Token icon

Opens this Screen:
Access Token for NetSuite
Function of this Screen:
Configure an access token to connect to NetSuite.

Entities / Custom Record Types

Function:
Specifies whether to query a record for a standard NetSuite entity, or a record for a custom record type.
Accepted Values:
  • Entities - Lets you select a standard NetSuite entity from which to query the records.
  • Custom Entities - Lets you select a custom record type from which to query the records.
Default Value:
Entities

Entity Name

Function:
Specifies the name of an entity from which to get records.
To Open this Field:
  1. On the Query Records Configuration screen, select Entities.
Accepted Values:
An entity name from the list.
Default Value:
None.

When you select the NetSuite access token, the name of entities show in the Entity Name field.

Record Type

Function:
Specifies the name of a custom record type from which to get records.
To Open this Field:
  1. On the Query Records Configuration screen, click Custom Record Types.
Accepted Values:
A custom record type from the list.
Default Value:
None.

When you select the NetSuite access token, the name of custom record types show in the Record Type field.

Entity Column Fields

Function:
Shows all the columns for the entity specified in the Entity Name field.
Accepted Values:
The list of columns for your entity.
Default Value:
None

Configured Column Field

Function:
Specifies the columns from the entity to use in your query.
Accepted Values:
A list of columns moved from the Entity Column Fields list.

Use the left and right arrow buttons to add and remove columns in this list.

Default Value:
None

Left Arrow Left Arrow icon

Function:
Moves the selected fields from the Configured Column Fields box to the Entity Column Fields box.

Right Arrow Right Arrow icon

Function:
Moves the selected fields from the Entity Column Fields box to the Configured Column Fields box.

Select All

Function:
Selects all the fields.

Query Records Configuration > Where tab

Configures a SQL where clause to filter the results of a query in NetSuite. It gets only the records that obey the rules in the WHERE clause.

Figure: Query Records Configuration > Where tab

Query Records Configuration Where tab

Fields

Field Name Definition

NetSuite

Function:
Specifies the access token that connects to your NetSuite application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Add Token Add Token icon

Opens this Screen:
Access Token for NetSuite
Function of this Screen:
Configure an access token to connect to NetSuite.

Entities / Custom Record Types

Function:
Specifies whether to query a record for a standard NetSuite entity, or a record for a custom record type.
Accepted Values:
  • Entities - Lets you select a standard NetSuite entity from which to query the records.
  • Custom Entities - Lets you select a custom record type from which to query the records.
Default Value:
Entities

Entity Name

Function:
Specifies the name of an entity from which to get records.
To Open this Field:
  1. On the Query Records Configuration screen, select Entities.
Accepted Values:
An entity name from the list.
Default Value:
None.

When you select the NetSuite access token, the name of entities show in the Entity Name field.

Record Type

Function:
Specifies the name of a custom record type from which to get records.
To Open this Field:
  1. On the Query Records Configuration screen, click Custom Record Types.
Accepted Values:
A custom record type from the list.
Default Value:
None.

When you select the NetSuite access token, the name of custom record types show in the Record Type field.

Where Clause Code Snippet Box

Function:
Shows the code snippet for the Where clause AgilePoint creates when you click Save Query. The WHERE clause is specified using the conditions and logical operators.
Accepted Values:
A valid SQL code snippet.

You can change the code in the code snippet box.

Default Value:
The SQL code AgilePoint creates for the WHERE clause.

Column

Function:
Specifies an entity column to use in your query.
Accepted Values:
A valid entity column shown in the list.
Default Value:
None.

When you select the name of the entity, the list of columns shows in Column field.

Comparer

Function:
Specifies the operator to use in your WHERE clause.
Accepted Values:
  • Like
  • Contains
  • DoesNotContain
  • Equal
  • NotEqual
  • BeginsWith
  • DoesNotBeginWith
  • EndsWith
  • DoesNotEndWith
Default Value:
Like

Value

Function:
Specifies the value for the column.
Accepted Values:
A valid column value.
Default Value:
None
Accepts Process Data Variables:
Yes

Save Query

Function:
Saves the code snippet for the Where clause, and shows the code snippet in box.

Query Records Configuration > Output Mapping tab

Maps the columns of the query response to the schema for your process.

Figure: Query Records Configuration > Output Mapping tab

Query Records Configuration Output Mapping tab

Fields

Field Name Definition

NetSuite

Function:
Specifies the access token that connects to your NetSuite application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Add Token Add Token icon

Opens this Screen:
Access Token for NetSuite
Function of this Screen:
Configure an access token to connect to NetSuite.

Entities / Custom Record Types

Function:
Specifies whether to query a record for a standard NetSuite entity, or a record for a custom record type.
Accepted Values:
  • Entities - Lets you select a standard NetSuite entity from which to query the records.
  • Custom Entities - Lets you select a custom record type from which to query the records.
Default Value:
Entities

Entity Name

Function:
Specifies the name of an entity from which to get records.
To Open this Field:
  1. On the Query Records Configuration screen, select Entities.
Accepted Values:
An entity name from the list.
Default Value:
None.

When you select the NetSuite access token, the name of entities show in the Entity Name field.

Record Type

Function:
Specifies the name of a custom record type from which to get records.
To Open this Field:
  1. On the Query Records Configuration screen, click Custom Record Types.
Accepted Values:
A custom record type from the list.
Default Value:
None.

When you select the NetSuite access token, the name of custom record types show in the Record Type field.

Map Response to AgilePoint Schema

Function:
Specifies the connection from the NetSuite API response parameter to your schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Default Value:
None

Query Records Configuration > Test tab

Makes sure your query is valid for NetSuite.

Figure: Query Records Configuration > Test tab

Query Records Configuration Test tab

Fields

Field Name Definition

NetSuite

Function:
Specifies the access token that connects to your NetSuite application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Add Token Add Token icon

Opens this Screen:
Access Token for NetSuite
Function of this Screen:
Configure an access token to connect to NetSuite.

Entities / Custom Record Types

Function:
Specifies whether to query a record for a standard NetSuite entity, or a record for a custom record type.
Accepted Values:
  • Entities - Lets you select a standard NetSuite entity from which to query the records.
  • Custom Entities - Lets you select a custom record type from which to query the records.
Default Value:
Entities

Entity Name

Function:
Specifies the name of an entity from which to get records.
To Open this Field:
  1. On the Query Records Configuration screen, select Entities.
Accepted Values:
An entity name from the list.
Default Value:
None.

When you select the NetSuite access token, the name of entities show in the Entity Name field.

Record Type

Function:
Specifies the name of a custom record type from which to get records.
To Open this Field:
  1. On the Query Records Configuration screen, click Custom Record Types.
Accepted Values:
A custom record type from the list.
Default Value:
None.

When you select the NetSuite access token, the name of custom record types show in the Record Type field.

Execute Query

Function:
Makes sure the query is correct, and shows the necessary error message if an error occurs.

If the query runs successfully, the result shows in the box.