Query Custom Entity (Oracle NetSuite) activity

An activity that uses a WHERE clause to retrieve information from one or more custom entities in Oracle NetSuite.


Query Custom Entity activity

Configure the Query Custom Entity activity

To configure the Query Custom Entity activity, do the procedure in this topic

Examples

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Oracle NetSuite tab.

    Open Oracle NetSuite tab
  3. On the Oracle NetSuite tab, drag the Query Custom Entity activity onto your process.

    Drag Query Custom Entity activity

General Configuration

Specifies the basic settings for the Query Custom Entity activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Connection Timeout (Seconds)

Description:
Specifies the number of seconds permitted to complete an action before the connection stops.
Allowed Values:
An integer.

Represents:

  • A number of seconds
Default Value:
600
Accepts Variables:
No

Query Custom Entity Configuration > Where tab

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

Figure: Query Custom Entity Configuration > Where tab

Query Custom Entity Configuration Where tab

Fields

Field NameDefinition

Oracle NetSuite

Description:
Specifies the access token that connects to your Oracle NetSuite application.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Tokens for Oracle NetSuite
Function of this Screen:
Configure an access token to connect to Oracle NetSuite.
Example:
Refer to:

Custom Entity Internal ID

Description:
Specifies the internal ID of the custom entity whose information to retrieve.
Allowed Values:
An integer that represents a custom entity internal ID.

The custom entity internal ID comes from Oracle NetSuite.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Column Internal ID

Description:
Specifies the internal ID for the column from Oracle NetSuite to use in your query.
Allowed Values:
An integer that represents a column internal ID.

The column internal ID comes from Oracle NetSuite.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Comparer

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

Value

Description:
Specifies the value for the column.
Allowed Values:
A valid column value.
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Query Custom Entity Configuration > Response tab

Retrieves the value from a custom entity in Oracle NetSuite and stores the value in a variable in the AgilePoint NX app.

Figure: Query Custom Entity Configuration > Response tab

Query Custom Entity Configuration Response tab

Fields

Field NameDefinition

Oracle NetSuite

Description:
Specifies the access token that connects to your Oracle NetSuite application.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Tokens for Oracle NetSuite
Function of this Screen:
Configure an access token to connect to Oracle NetSuite.
Example:
Refer to:

Custom Entity Internal ID

Description:
Specifies the internal ID of the custom entity whose information to retrieve.
Allowed Values:
An integer that represents a custom entity internal ID.

The custom entity internal ID comes from Oracle NetSuite.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Add Columns Add Columns icon

Opens this Screen:
Add Custom Property screen
Function of this Screen:
Adds a column for a custom entity in Oracle NetSuite.

Entity Column ID

Description:
Shows the entity columns that are configured on the Add Custom Property screen.
Allowed Values:
Read only.

Store Response In Custom Attribute

Description:
Shows the variables that are configured on the Add Custom Property screen.
Allowed Values:
Read only.

Delete Delete icon

Function:
Deletes the column row.

Add Custom Property

Adds a column for a custom entity in Oracle NetSuite.

Figure: Add Custom Property screen

Add Custom Property screen

Fields

Field NameDefinition

Entity Column ID

Description:
Specifies the ID of the entity column whose information to retrieve.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
No
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Store Response In Custom Attribute

Description:
Specifies a variable to store the value of the entity column. The value is passed from the entity column to the variable specified in this field.
Allowed Values:
A variable that accepts a value of the same data type as the entity column.
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Add

Function:
Adds the specified entity column with the value to the custom entity.

Cancel

Function:
Closes the Add Custom Property screen.