Neo4j

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

ExecuteCustomQuery action

This action lets you execute a custom query.

To create a custom query, follow these steps:

1. Follow the detailed instructions to add a connectors task.
2. When you configure the connector task, in the type of action you want to perform, select Actions.
3. In the Action list, select Execute custom query, and then click Done.

   

4. Expand the Task input section, and then do the following:
   1. In the Timeout after field, enter the number of seconds to wait till the query executes.

      Default value: 180 seconds.

   2. In the Maximum number of rows field, enter the maximum number of rows to be returned from the database.

      Default value: 25.

   3. To update the custom query, click Edit Custom Script. The Script editor dialog opens.

      

   4. In the Script editor dialog, enter the SQL query and click Save.

      You can use a question mark (?) in a SQL statement to represent a single parameter that must be specified in the query parameters list. For example, the following SQL query selects all rows from the Employees table that matches the values specified for the LastName column:

      SELECT * FROM Employees where LastName=?

   5. If you've used question marks in your SQL query, you must add the parameter by clicking + Add Parameter Name for each question mark. While executing the integration, these parameters replace the question marks (?) in the SQL query sequentially. For example, if you have added three question marks (?), then you must add three parameters in order of sequence.

      

      To add query parameters, do the following:

      1. From the Type list, select the data type of the parameter.
      2. In the Value field, enter the value of the parameter.
      3. To add multiple parameters, click + Add Query Parameter.

On successful execution, this action returns the status 200 (OK) with a response body that has the query results.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Create a node

This example shows how to create a new node.

1. In the Configure Connector dialog, select Region, Connection, and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   CREATE (:Movie {title: 'Hey', release_year: 2010})

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter gives a blank payload [ ].

Example - Update a node

This example shows how to update a node.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   match(m:Movie{title: 'Inception'}) set m.release_year=2011 return m

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter value is similar to the following:

[{ "m": "{\"release_year\":2011,\"title\":\"Inception\"}" }]

Example - Delete a node

This example shows how to delete a node.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   match(m:Movie{title: 'hey'}) delete m

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter gives a blank payload [ ].

Example - Create a relationship

This example shows how to create a relationship.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   CREATE(movie:Movie {title: 'bcon'}), (actor:Actor {name: 'leo'})
   CREATE(actor)-[:ACTED_IN]->(movie)
   

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter gives a blank payload [ ].

Example - Update a relationship

This example shows how to update a relationship.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   match(movie:Movie {title: 'demo'}), (actor:Actor {name: 'first'})
   match(actor)-[r:ACTED_IN]->(movie) set actor.name='second',r.year=2024 return actor,r,movie
   

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter value is similar to the following:

[{   "actor": "{\"name\":\"second\"}",   "r": "{\"year\":2024}",   "movie": "{\"title\":\"demo\"}" }]

Example - Delete a relationship

This example shows how to delete a relationship.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   MATCH(movie:Movie {title: 'bcon44'}), (actor:Actor {name: 'jacky'})
   MATCH(actor)-[r:ACTED_IN]->(movie) delete r
   

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter gives a blank payload [ ].

Example - Update a node label

This example shows how to update a node label.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   MATCH (n:Person) where id(n)=18 set n:Actor RETURN n

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter value is similar to the following:

[{ "n": "{\"born\":1962,\"name\":\"Demi Moore\"}" }]

Example - Update relationship type

This example shows how to update a relationship type.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   MATCH (n:Person) where id(n)=18 set n.born=1963 RETURN n

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter value is similar to the following:

[{ "n": "{\"born\":1963,\"name\":\"Demi Moore\"}" }]

Example - Create a datatype

This example shows how to create a datatype.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   CREATE (:Product {unitPrice: 109.50,
   unitsInStock: 390,
   supplierID: "1",
   productID: "dumy-2",
   discontinued: false,
   quantityPerUnit: "10 boxes x 20 bags",
   productName: "productName-1",
   unitsOnOrder: 0,
   reorderLevel: 10,
   supplier: ["1"],
   expiry: Duration("P14DT18H12M"),
   categoryID: "1",
   updatedAt: DateTime("1984-11-11T12:31:14Z")})

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter gives a blank payload [ ].

Example - Update a datatype

This example shows how to update a datatype.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   match(p:Product{productID: "dumy-1"}) set p.duration = Duration("P15DT19H12M"), p.updatedAt=DateTime("1984-11-12T12:31:14Z") return p

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter value is similar to the following:

[{ "p": "{\"unitPrice\":109.5,
\"unitsInStock\":390,
\"supplierID\":\"1\",
\"productID\":\"dumy-1\",
\"discontinued\":false,
\"quantityPerUnit\":\"10 boxes x 20 bags\",
\"productName\":\"productName-1\",
\"unitsOnOrder\":0,
\"duration\":\"P15DT19H12M\",
\"reorderLevel\":10,
\"supplier\":[\"1\"],
\"expiry\":\"P14DT18H12M\",
\"categoryID\":\"1\",
\"updatedAt\":\"1984-11-12T12:31:14Z\"}" }, 
{ "p":"{\"unitPrice\":109.5,
\"unitsInStock\":390,
\"supplierID\":\"1\",
\"productID\":\"dumy-1\",
\"discontinued\":false,
\"quantityPerUnit\":\"10 boxes x 20 bags\",
\"productName\":\"productName-1\",
\"unitsOnOrder\":0,
\"duration\":\"P15DT19H12M\",
\"reorderLevel\":10,
\"supplier\":[\"1\"],
\"expiry\":\"P14DT18H12M\",
\"categoryID\":\"1\",
\"updatedAt\":\"1984-11-12T12:31:14Z\"}" }]

Example - Delete a datatype

This example shows how to delete a datatype.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   match(p:Product{productID: "dumy-2"}) delete p

This example shows how to delete a datatype. If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter gives a blank payload [ ].

Example - Get the count of nodes

This example shows how to get the count of nodes.

1. In the Configure Connector dialog, select Region, Connection and Actions.
2. Select Execute Custom Query from the actions, and then click Done.
3. In the Task Input section of Connector, click on Edit Custom Script and then enter a value similar to the following in the Custom Query field:

   MATCH ()  
   RETURN count(*) AS numNodes

If the action is successful, the Execute Custom Query task's connectorOutputPayload response parameter gives the payload which is similar to the following:

[{
  "numNodes": 6267.0
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all languages

This example shows how to list all languages.

1. In the Configure connector task dialog, click Entities.
2. Select multilanguage_table from the Entity list.
3. Select the List operation, and then click Done.
4. In the Data Mapper section click on Open Data Mapping Editor and, there you can set the filterClause as per your requirement.

Example - Get a language

This example shows how to get a language.

1. In the Configure connector task dialog, click Entities.
2. Select multilanguage_table from the Entity list.
3. Select the Get operation, and then click Done.
4. Set the entity ID to Get single Language. To set the entity ID, in the Data Mapper section, click on Open Data Mapping Editor, and then enter 58.0 in the Input Value field and choose the entityId as Local variable.