Query Node activity

An activity that retrieves information about one or more nodes from Neo4j.


Query Node activity

Configure the Query Node activity

Examples

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

    Open Neo4j tab
  3. On the Neo4j tab, drag the Query Node activity onto your process.

    Query Node activity

General Configuration

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

Query Node Configuration > Query Filter tab

Specifies the information about the node to retrieve from Neo4j.

Figure: Query Node Configuration > Query Filter tab

Query Node Configuration Query Filter tab

Fields

Field NameDefinition

Neo4j
Description:
Specifies the access token that connects to Neo4j.
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 Token for Neo4j
Function of this Screen:
Configure an access token to connect to Neo4j.
Example:
Refer to:

Label
Description:
Specifies the name of the node whose information to retrieve.
Allowed Values:
  • A node from the list.

    When you select the access token from the Neo4j field, this field shows the node names associated with the access token.

  • One line of text (a string) that represents a node name from Neo4j.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Condition
Description:
Specifies the cypher formula to retrieve the node from Neo4j.
Allowed Values:
A cypher formula.
Default Value:
None
Example:
Refer to:

Properties
Description:
Shows a list of property names from the node in Neo4j. You can use the property names from this field to specify the condition in the Condition field.

When you select the node in the Label field, this field shows the property names associated with the node.

Allowed Values:
A property name from the list.
Default Value:
None
Example:
Refer to:

Filter Filter icon
Function:
Shows the items in the list based on the values you enter.
To Open this Field:
  1. Click Filter Filter icon.
  2. On the filter screen, select your operator.
  3. Enter the values to show in your list.
Allowed Values:
  • Is equal to
  • Is not equal to
  • Starts with
  • Contains
  • Does not contain
  • Ends with
Default Value:
Is equal to

Map Response To App Schema / Enter Response Payload
Description:
Specifies where to store the response from Neo4j.
Allowed Values:
  • Map Response To App Schema – Select this option if you want to map the information from the Neo4j 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.

  • Enter Response Payload – Specifies a payload to use to map the response to the AgilePoint process schema.

    Click Map Response to open the Schema Mapper.

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

Default Value:
Map Response To App Schema
Example:
Refer to:
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 Node Configuration > Sort & Pagination tab

Configures the filter criteria to retrieve information about one or more nodes from Neo4j.

Figure: Query Node Configuration > Sort & Pagination tab

Query Node Configuration Sort Pagination tab

Fields

Field NameDefinition

Neo4j
Description:
Specifies the access token that connects to Neo4j.
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 Token for Neo4j
Function of this Screen:
Configure an access token to connect to Neo4j.
Example:
Refer to:

Label
Description:
Specifies the name of the node whose information to retrieve.
Allowed Values:
  • A node from the list.

    When you select the access token from the Neo4j field, this field shows the node names associated with the access token.

  • One line of text (a string) that represents a node name from Neo4j.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Order By
Description:
Specifies the name of the property to make a sequence for the query results.
Allowed Values:
A property name from the list.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:

Distinct
Description:
Specifies the name of the property for which to retrieve unique values.
Allowed Values:
A property name from the list.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:

Sort By
Description:
Specifies the sort order for the result set.
Allowed Values:
  • Ascending
  • Descending
Default Value:
Ascending.
Example:
Refer to:

Row Limit
Description:
Specifies the maximum number of nodes to retrieve from Neo4j.
Allowed Values:
An integer.

Range:

  • 1-10000
Default Value:
10000
Accepts Variables:
No
Example:
Refer to:

Skip
Description:
Specifies how many nodes to ignore from the top of the query results.
Allowed Values:
An integer.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:

Map Response To App Schema / Enter Response Payload
Description:
Specifies where to store the response from Neo4j.
Allowed Values:
  • Map Response To App Schema – Select this option if you want to map the information from the Neo4j 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.

  • Enter Response Payload – Specifies a payload to use to map the response to the AgilePoint process schema.

    Click Map Response to open the Schema Mapper.

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

Default Value:
Map Response To App Schema
Example:
Refer to:
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?