Query Ticket activity

An activity that retrieves one or more tickets from HubSpot.


Query Ticket activity

Configure the Query Ticket activity

Prerequisites

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 the Process Builder, in the Activity Library, open the HubSpot tab.

    Open HubSpot tab
  3. On the HubSpot tab, drag the Query Ticket activity onto your process.

    Drag Query Ticket activity

General Configuration

Specifies the basic settings for the Query Ticket 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

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

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

Query Ticket Configuration

Specifies the information about the ticket to retrieve from HubSpot.

Figure: Query Ticket Configuration screen

Query Ticket Configuration screen

Fields

Field NameDefinition

HubSpot

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

Create Add Token icon

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

By Ticket ID / Filter Condition

Function:
Specifies whether to retrieve information about one or more tickets with a ticket ID or a SQL WHERE clause.
Accepted Values:
Default Value:
Ticket ID
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?

Ticket ID

Function:
Specifies the ID of the ticket whose information to retrieve.

The ticket ID comes from HubSpot.

Accepted Values:
A ticket ID from HubSpot.
Default Value:
None
Accepts Process Data 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?

Map Response To App Schema

Function:
Maps information about the ticket from the HubSpot data model to your process schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

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

Default Value:
None
Example:
Refer to:

Query Ticket Configuration > Where tab

Shows the WHERE clause for your query.

Figure: Query Ticket Configuration > Where tab

Query Ticket Configuration Where tab

Good to Know

Fields

Field NameDefinition

HubSpot

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

Create Add Token icon

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

By Ticket ID / Filter Condition

Function:
Specifies whether to retrieve information about one or more tickets with a ticket ID or a SQL WHERE clause.
Accepted Values:
Default Value:
Ticket ID
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?

Code Snippet

Function:
Shows the SQL code snippet that is created when you configure the filter condition for your query.

You can configure the filter condition on the Query Ticket Configuration > Where tab > Create Conditions screen.

Accepted Values:
Read only.
Default Value:
None

Create Create icon

Opens this Screen:
Query Ticket Configuration > Where tab > Create Conditions
Function of this Screen:
Specifies a filter condition to retrieve information about one or more tickets from HubSpot.

Edit Edit icon

Function:
Lets you change the query.

Delete Delete icon

Function:
Deletes the condition row.

Query Ticket Configuration > Where tab > Create Conditions

Specifies a filter condition to retrieve information about one or more tickets from HubSpot.

Figure: Query Ticket Configuration > Where tab > Create Conditions

Query Ticket Configuration Where tab Create Conditions

Fields

Field NameDefinition

Add group Add Group icon

Function:
Creates a new conditional expression group.

Select Nest Type

Function:
Specifies the use of logical AND and OR operators to nest conditions to filter the record.

You must set the condition first, before you specify the nest type.

Accepted Values:
  • And - Specifies the logical AND operator.
  • Or - Specifies the logical OR operator.
Default Value:
Or

Add expression Add Expression icon

Function:
Creates a condition row.

Delete Delete icon

Function:
Deletes the condition row.

Column

Function:
Specifies the name of the column from HubSpot to use in your query.
Accepted Values:
A column name from the list.

When you select the access token from the HubSpot field, this field shows the column names associated with the access token.

Default Value:
None
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

Function:
Specifies the operator to use in your query.
Accepted Values:
  • is equal to
  • is not equal to
  • is less than
  • is less than or equal to
  • is greater than
  • is greater than or equal to
  • is present
  • is blank
  • contains
  • does not contain
Default Value:
is equal to

Value

Function:
Specifies the value for the column.
Accepted Values:
A valid column value.
Default Value:
None
Accepts Process Data 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?

Back Back icon

Function:
Saves your rule and goes back to the activity configuration screen.

Query Ticket Configuration > Response tab

Specifies how to store the information about one or more tickets from HubSpot to your process schema.

Figure: Query Ticket Configuration > Response tab

Query Ticket Configuration Response tab

Fields

Field NameDefinition

HubSpot

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

Create Add Token icon

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

By Ticket ID / Filter Condition

Function:
Specifies whether to retrieve information about one or more tickets with a ticket ID or a SQL WHERE clause.
Accepted Values:
Default Value:
Ticket ID
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 To This Variable / Map Response To App Schema

Function:
Specifies where to store the response from HubSpot.
Accepted Values:
  • Store Response To This VariableSelect this option if you want to store the information from HubSpot to a variable in the AgilePoint NX app.

    In the text field, specify a variable that accepts an alphanumeric string in JSON format.

  • Map Response To App SchemaSelect this option if you want to map the information from the HubSpot data model to your process schema.

    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.

    Because the query can return more than one result, the parent node in the external data source must be mapped to a node in the AgilePoint NX process schema that is a repeating schema element. The child nodes in both data models must also be mapped, but child nodes in AgilePoint NX inherit the repeating behavior from their parent node.

Default Value:
Map Response To App Schema
Accepts Process Data 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?