Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects ofthe 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 theconnected 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 theEntities list will be empty.

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

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

• Action:An action is a first class function that is made available to the integrationthrough 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 theActions list will be empty.

Action examples

Example - EMPLOYEE_PROCEDURE_HANA

1. In theConfigure connector task dialog, clickActions.
2. Select theEMPLOYEE_PROCEDURE_HANA action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"ID":1}

If the action is successful, theEMPLOYEE_PROCEDURE_HANA task'sconnectorOutputPayload responseparameter will have a value similar to the following:

 [{"EMP_ID": 1.0,"NAME": "Komal","CITY": "UP","SALARY": 7500.0,"DEPARTMENT": "IT" }]

Example - ExecuteCustomQuery Join_GroupBy

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT CUSTOMER.COMPANY, SUM(ORDERS.AMOUNT) AS TotalFROM ORDERSINNER JOIN CUSTOMERON ORDERS.CUSTOMER_ID = CUSTOMER.IDGROUP BY CUSTOMER.COMPANY"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"COMPANY": "google India","TOTAL": 1560.0},{"COMPANY": "IBM India","TOTAL": 4500.0}]

Example - ExecuteCustomQuery Join

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT ID, NAME, AGE, AMOUNT FROM CUSTOMERS JOIN ORDERS ON CUSTOMERS.ID = ORDERS.CUSTOMER_ID"  }]}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{  "ID": 3.0,  "NAME": "Kaushik",  "AGE": 23.0,  "AMOUNT": 3000.0}, {  "ID": 3.0,  "NAME": "Kaushik",  "AGE": 23.0,  "AMOUNT": 1500.0}, {  "ID": 2.0,  "NAME": "Khilan",  "AGE": 25.0,  "AMOUNT": 1560.0}, {  "ID": 4.0,  "NAME": "Chaitali",  "AGE": 25.0,  "AMOUNT": 2060.0}]

Example - ExecuteCustomQuery Groupby_Having_Count

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT COUNT(ID), CITY FROM GCP_HANA_CUSTOM GROUP BY CITY HAVING COUNT(ID) > 1"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

 [{  "COUNT(ID)": 2.0,  "CITY": "Delhi"}]

Example - ExecuteCustomQuery GroupBy

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT COUNT(ID), CITY FROM GCP_HANA_CUSTOM GROUP BY CITY"}

This example will update the ExecuteCustomQuery records. If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{  "COUNT(ID)": 1.0,  "CITY": "Kolkata"}, {  "COUNT(ID)": 1.0,  "CITY": "Katihar"}, {  "COUNT(ID)": 1.0,  "CITY": "Bangalore"}, {  "COUNT(ID)": 2.0,  "CITY": "Delhi"}]

Example - ExecuteCustomQuery GroupBy_OrderBy

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT COUNT(ID), CITY FROM GCP_HANA_CUSTOM GROUP BY CITY ORDER BY COUNT(ID) DESC"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{  "COUNT(ID)": 2.0,  "CITY": "Delhi"}, {  "COUNT(ID)": 1.0,  "CITY": "Kolkata"}, {  "COUNT(ID)": 1.0,  "CITY": "Bangalore"}, {  "COUNT(ID)": 1.0,  "CITY": "Katihar"}]

Example - ExecuteCustomQuery Insert_Table

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "INSERT INTO CUSTOMER VALUES (3, 'IBM India')"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{}]

Example - ExecuteCustomQuery SUM_AggFunc

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT SUM(SALARY) FROM CUSTOMERS"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

 [{"SUM(SALARY)": 12000.0}]

Example - ExecuteCustomQuery AVG_AggFunc

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT AVG(SALARY) FROM CUSTOMERS"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"AVG(SALARY)": 3000.0}]

Example - ExecuteCustomQuery MAX_AggFunc

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT MAX(SALARY) FROM CUSTOMERS"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

 [{"MAX(SALARY)": 6500.0}]

Example - ExecuteCustomQuery MIN_AggFunc

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT MIN(SALARY) FROM CUSTOMERS"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"MIN_SALARY": 1500.0}]

Example - ExecuteCustomQuery COUNT_AggFunc

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT COUNT(*) FROM CUSTOMERS"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"COUNT(*)": 4.0}]

Example - ExecuteCustomQuery CreateTable

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "CREATE TABLE CUSTOMER (ID INT NOT NULL,COMPANY VARCHAR (20))"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{}]

Example - ExecuteCustomQuery AlterTable

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "ALTER TABLE GCP_HANA_CUSTOM ADD CONSTRAINT test PRIMARY KEY (ID)"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{}]

Example - ExecuteCustomQuery TruncateTable

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "TRUNCATE TABLE GCP_HANA_RENAME"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{}]

Example - ExecuteCustomQuery DropTable

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "DROP TABLE GCP_HANA_DROP"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{}]

Example - ExecuteCustomQuery RenameTable

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "RENAME TABLE GCP_HANA_CUSTOM1 TO GCP_HANA_RENAME"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{}]

Example - ExecuteCustomQuery UpdateTable

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "UPDATE CUSTOMERS SET ADDRESS = 'Pune' WHERE ID = 3"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{}]

Example - ExecuteCustomQuery SELECT_DATA_Table

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "SELECT * FROM CUSTOMERS"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{  "ID": 1.0,  "NAME": "Ramesh",  "AGE": 32.0,  "ADDRESS": "Ahmedabad",  "SALARY": 2000.0}, {  "ID": 2.0,  "NAME": "Khilan",  "AGE": 25.0,  "ADDRESS": "Delhi",  "SALARY": 1500.0}, {  "ID": 4.0,  "NAME": "Chaitali",  "AGE": 25.0,  "ADDRESS": "Mumbai",  "SALARY": 6500.0}]

Example - ExecuteCustomQuery DeleteTable

1. In theConfigure connector task dialog, clickActions.
2. Select theExecuteCustomQuery action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"query": "DELETE FROM CUSTOMERS WHERE ID = 3"}

If the action is successful, theExecuteCustomQuery task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{}]

Example - Insert a JSON array into a DB

To bulk insert data from a JSON array into a SAP HANA database table you can use one of the following methods:

Use a custom query with JSON table

Use theExecute Custom Query feature combined with a SAP HANAJSON_TABLE function. This method uses a single query to parse a JSON array and insert all records simultaneously.

To perform a bulk insert with a custom query, do the following:

1. Transform your source data into a single JSON string. For example:

   '[ {"id": 701, "name": "Laptop", "email": "EMAIL_ADDRESS"},{"id": 702, "name": "Keyboard", "email": "EMAIL_ADDRESS"}]'

2. Select the actionExecute Custom Query.
3. Use anINSERT statement that uses theJSON_TABLE function to parse the input string. For example:

   INSERT INTO YOUR_TABLE_NAME (ID, NAME, EMAIL)SELECT    ID,    NAME,    EMAILFROMJSON_TABLE(?, '$[*]'    COLUMNS (        ID INT PATH '$.id',        NAME NVARCHAR(100) PATH '$.name',        EMAIL NVARCHAR(100) PATH '$.email'    )) AS jt;

4. Map the Integration variable containing your JSON string to the single bind parameter?.
5. Execute the query and verify the success of the operation.

Use a For Each Loop task

This method uses Application Integration to loop through the JSON array. For each JSON object in the array, it calls a sub-integration that performs a singleINSERT operation. The iteration happens within the integration itself.

1. Go to theIntegration and create aFor Each Loop task.
2. Locate theList to iterate field and assign your input JSON array variable to this field. The loop will now iterate over each object within this array.
3. UnderSub-integration details, provide theSub-integration name and theAPI trigger ID of the sub-integration you want to call for each iteration.
4. In theExecution Task section, provide aSub-integration variable name.
5. In theSub-integration, use anExecute Custom Query or a pre-configured entity configuration to perform theINSERT operation using the data from the incoming JSON object.

Use a stored procedure

This method uses your database to handle looping and insertion. You must create a stored procedure in SAP HANA that can parse a JSON array and insert the data, and then you can use a connectors task in Application Integration to call the procedure and pass the entire JSON array to it.

To use a stored procedure for bulk insertion, do the following:

1. Create a stored procedure in your SAP HANA database that can parse a JSON array and insert the data.

         {        CREATE PROCEDURE "YOUR_SCHEMA"."SP_INSERT_FROM_JSON" (            IN JSON_STRING CLOB        )        LANGUAGE SQLSCRIPT        SQL SECURITY INVOKER        DEFAULT SCHEMA "YOUR_SCHEMA"        AS        BEGIN            -- Parse JSON string using JSON_TABLE and insert directly into target table            INSERT INTO "YOUR_SCHEMA"."YOUR_TABLE" (ID, NAME, GRADE)            SELECT ID, NAME, GRADE            FROM JSON_TABLE(:JSON_STRING, '$[*]'                COLUMNS (                    ID   INT PATH '$.ID',                    NAME NVARCHAR(100) PATH '$.NAME',                    GRADE FLOAT PATH '$.GRADE'                )            );        END;        }

2. Use theConnectors task in Application Integration to call the procedure and pass the entire JSON array to it. In theConfigure connector task dialog, clickActions.
3. Select the created procedure, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a JSON data value similar to the following in theDefault Value field:

         [        { "ID": 1, "NAME": "Alice", "GRADE": 11.11 },        { "ID": 2, "NAME": "Bob", "GRADE": 22.22 }      ]

If the action is successful, the data will be inserted into the database with the response code of200.

Entity operation examples

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

Example - List all the employees

This example lists all the employees in theEmployee entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectEmployee from theEntity list.
3. Select theList operation, and then clickDone.
4. Optionally, inTask Input section of theConnectors task, you can filter your result set by specifying afilter clause. Specify the filter clause value always within the single quotes ('). For example,City='Bangalore'. You can also specify multiple filter conditions by using the logic operators. For example,City='Bangalore' and region='asia-south2'.

Example - Get a record

This example gets a record with the specified ID from theEmployee entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectEmployee from theEntity list.
3. Select theGet operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickEntityId and then enter12294 in theDefault Value field.

   Here,12294 is a primary key value in theEmployee entity.

Example - Create a record inHana_unicode

This example creates a record in theHana_unicode entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectHana_unicode from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"ID":2.0,"UNICODEDATA":"Unicode データ型はグローバル化されたデータの保存に使用されます","TEST":"Test7"}

   If the integration is successful, your connector task'sconnectorOutputPayload field will have a value similar to the following:

   {"ID":2.0,"UNICODEDATA":"Unicode データ型はグローバル化されたデータの保存に使用されます","TEST":"Test7"}

Example - Create a record inLanguages

This example creates a record in theLanguages entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectLanguages from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"ID":5,"ARABICTEXT":"مرحبا","GERMANTEXT":"Günther","HINDITEXT":"नमस्ते","ENGLISHTEST":"Test1"}

   If the integration is successful, your connector task'sconnectorOutputPayload field will have a value similar to the following:

   {"ID":5.0,"ARABICTEXT":"مرحبا","GERMANTEXT":"Günther","HINDITEXT":"नमस्ते","ENGLISHTEST":"Test1"}

Example - Update a record

This example updates a record in theEmployee entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectEmployee from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"SALARY":9000.0}

5. ClickentityId, and then enter12294 in theDefault Value field.

   If the integration is successful, your connector task'sconnectorOutputPayload field will have a value similar to the following:

   {"SALARY":9000.0}

Example - Delete a record

This example deletes the record with the specified ID in theEmployee entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectEmployee from theEntity list.
3. Select theDelete operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickentityId and then enter10001 in theDefault Value field.