Execute Query activity

An activity that executes a cypher query in Neo4j.


Execute Query activity

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

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

    Execute Query activity

General Configuration

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

Execute Query Configuration

Specifies the configuration to execute a cypher query in Neo4j.

Figure: Execute Query Configuration screen

Execute Query Configuration screen

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:

Cypher Query

Description:
Specifies the cypher query string to execute in Neo4j.
Allowed Values:
A cypher query string.
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?

Simulate

Function:
Runs the cypher query string and returns the response.

Enter Response Payload / Store Response In This Variable

Description:
Specifies where to store the response from Neo4j.
Allowed Values:
  • Enter Response PayloadSpecifies 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.

  • Store Response In This VariableSelect this option if you want to store the information from Neo4j to a variable in the AgilePoint NX app.

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

Default Value:
Enter Response Payload
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?