SAP ERP

Configure for event subscription

If you have enabled the event subscription, enter the following values in the Event Subscription Details section:

1. Select any one of the following authentication types for the event listener.
   • Google Authentication. If you enable this option, follow the steps in Authenticate by using JSON Web Tokens to configure the authentication for ABAP SDK. Also, ensure that the service account has roles/connectors.listener role whose access token is used for authentication.
   • API Key Authentication. If you select this option, you must have created an API key, and then saved the key as a Secret Manager secret. For more information, see Create an API key.
2. Enter the event type field name. This field identifies the type of event associated with the incoming event request.

   {
   "event_type": "user.created",
   ...
   // other request fields
   ...
   }

3. Select Enable private connectivity for secured connectivity between your backend application and your connection. If you select this option, you must perform additional configuration steps after creating the connection. For more information, see Private connectivity for event subscription.
4. Enter the dead-letter configuration. If you configure dead-letter, the connection writes the unprocessed events to the specified Pub/Sub topic. Enter the following details:
   1. Dead-letter project ID: The Google Cloud project ID where you have configured the dead-letter Pub/Sub topic.
   2. Dead-letter topic: The Pub/Sub topic where you want to write the details of the unprocessed event.

Connection configuration samples

The following sections lists the sample values for the various fields when you create the SAP ERP connection and the parameters required for the different connection types.

Connecting to a distributed SAP System

If you connect to a distributed SAP system, such as a system using load balancing, you must specify the following additional connection properties. An administrator can obtain these connection properties on the Connection tab of the System Entry Properties dialog in the SAP system.

• System Id: Specify the value that you obtained from the SystemId property. The System Id is the System Id/R3Name of the SAP system. The system Id is a string with a maximum of three characters.
• Message Server: Set this property to the value that you obtained from the MessageServer property. If a value is specified in the SAProuter box, prepend the value in the SAProuter box to the value of the MessageServer connection string property. The MessageServer property must be specified when connecting to an SAP system using load balancing.
• Group: Set this property to the value that you obtained from the Group/Server property. The Group property specifies the logon group being used. The default value is PUBLIC.

Connecting to a Custom Application Server

If you connect to an SAP system with a dedicated application server or a custom application server, you must specify the following additional connection properties. An administrator can obtain these connection properties from the SAP system.

• System Id: Specify the value that you obtained from the SystemId property. This is the System Id or R3Name of the SAP system. The system Id is a string with a maximum of three characters.
• Host: Specify the value that you obtained from the Application Server.

  This specifies the host name of the target system. This value can be a regular host name, IP address, or SAP router address.

• System Number: Specify the value that you obtained from the SystemNumber property.

  The SystemNumber property defines the target system.

Configuring Secure Network Connections

If the administrator has configured Secure Network Communication (SNC), you must set the following additional properties. From the SAP system, you can obtain the following SNC connection string properties on the Network tab of the System Entry Properties dialog.

• SNC Mode: If the "Activate Secure Network Connections" checkbox is enabled in SAP, set the SNC Mode connection property to True. Else, set the SNC Mode connection property to False.

  The SNCMode connection property is a boolean value that determines if you are using SNC. The default value is False.

• SNC PartnerName: The SNC PartnerName specifies the application server's SNC name. For example: p:CN=IDS, OU=IT, O=CSW, C=DE
• SNC Name: Optional. The SNCName property specifies the name of the SNC connection. Set this property to make sure that the correct SNC name is used for the connection.
• SNC Qop: Set this property to the selected option in the Secure Network Settings section. For example, if the Integrity option is selected, set the SNCQop property to 3.

  The SNCQop property specifies the level (or quality) of data protection. If this property is not specified, the integer -1 is set for this property. Valid values are 1, 2, 3, 8, or 9, which correspond to the protection levels.

• SNC_Lib object ID: Set this property to the path and filename of your SNC library. Specify the full path to the security library you are using, such as C:\Secude\secude.xll.

ApplicationServer connection type

For application server connectivity, the Private Service Connect and load balancer must be configured with the SAP system IP and port 33XX in the network endpoint group (NEG) and health check. Where XX is the system or instance number of the SAP system used. The following table lists the sample configuration values for the ApplicationServer connection type. Refer to the connection creation interface in the console to know the mandatory and optional fields.

GroupServer connection type

For loadbalancing/Group server connectivity, the Private Service Connect and load balancer must be configured with the SAP system IP and port 33XX in the network endpoint group (NEG) and health check. Where XX is the system or instance number of the SAP system used. The following table lists the sample configuration values for the GroupServer connection type. Refer to the connection creation interface in the console to know the mandatory and optional fields.

X509 certificate connection type

For Secure Network Communications (SNC) with X509 connectivity, the Private Service Connect and load balancer must be configured with the SAP system IP and port 48XX in the network endpoint group (NEG) and health check. Where XX is the system or instance number of the SAP system used. The following table lists the sample configuration values for the X509 certificate connection type. Refer to the connection creation interface in the console to know the mandatory and optional fields.

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 provides information about the RFCs and lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

Using RFCs

This section provides information about the required RFCs and using the RFCs.

Required RFCs

If any of the required RFCS are not available, then some or all functionality might not work. T-Code SE37 can be used to view available function modules in SAP.

The following RFCs are used by the SAP ERP connector.

• DDIF_FIELDINFO_GET
• RFC_GET_FUNCTION_INTERFACE
• RFC_GET_STRUCTURE_DEFINITION
• RFC_GET_SYSTEM_INFO
• RFC_GET_UNICODE_STRUCTURE
• RFC_READ_TABLE
• SLDAG_CHECK_FOR_UNICODE

Read large data

This section describes the approach that you need to follow to read large data from your SAP backend.

The SAP ERP connector uses the SAP RFC_READ_TABLE function to get data from SAP tables, and this function has a fixed size of 512 bytes. It can buffer for each row of data, and thus you cannot select more columns than the amount that would fit in this buffer. If you select more than 512 bytes, the DATA_BUFFER_EXCEEDED exception will occur when running your integration; indicating that you have exceeded the maximum buffer size allowed per row, and need to select fewer columns.

To overcome this issue, you can include the code for a Custom RFC_READ_TABLE, which is similar to the SAP RFC_READ_TABLE, but with a larger buffer to address the DATA_BUFFER_EXCEEDED issue.

Using a custom read-table function

The connector supports a Custom RFC_READ_TABLE that is similar to the SAP RFC_READ_TABLE but has a larger buffer so that it can address the DATA_BUFFER_EXCEEDED issue.

Create a custom RFC_READ_TABLE in your SAP backend

Follow the steps below to use the sample custom RFC_READ_TABLE.

1. Use the RFC_READ_TABLE function as a template for the new function: Select transaction code SE37 and the SDTX Function Group and copy RFC_READ_TABLE to a new function group or your working function group. In this example, RFC_READ_TABLE is copied to the Z_CUSTOM_RFC_TABLE.
2. In the Attributes tab of the SAP page, select Remote Enabled Module.
3. In the Tables tab, set the DATA parameter to CHAR8000 (you may need to right-click, and then click Display -> Change).
4. In the Source Code tab, enter the custom read-table RFC code. For reference, see sample Z_CUSTOM_RFC_TABLE_function.txt.
5. Click Save.
6. Define the imports, tables, and exceptions as documented in the provided custom read table.
7. Activate the function module.

Custom read-table for ABAP 7.52

If you are using ABAP 7.52 or above, refer to the sample Z_CUSTOM_RFC_TABLE_function_ABAP752.txt. The sample function is designed for ABAP version 7.52 and above. It is similar to the Z_CUSTOM_RFC_TABLE function, but it takes advantage of newly available keywords in ABAP 7.52 to perform pagination within the database instead of in the ABAP script itself. This makes pagination far more efficient, and improves the performance when working with large tables. It is recommended to use the Z_CUSTOM_RFC_TABLE_752 RFC when possible.

Access to RFC_READ_TABLE function

This section provides information about the role to be assigned to a SAP user to access RFC_READ_TABLE function. This function is a remote-enabled function module that allows generic read access to arbitrary tables.

For the tables to be listed under Entities while configuring the SAP ERP Connectors task, you must use the RFC_READ_TABLE function in SAP ERP Connection level and authorized to access the R/3 function RFC_READ_TABLE

Add authorization S_TABU_DIS for activity 03 (display) and auth. group 'SC' for the function RFC_READ_TABLE.

The following are some of the technical limitations of RFC_READ_TABLE:

• Only tables with simple data types can be read. There is no support forSTRING or XSTRING fields.
• The maximum line width is 512 characters.
• Number of returned records is limited by memory thresholds.

BAPI_MATERIAL_SAVEDATA action

This action let you perform specific tasks. For example, you can use it to create or change material master data in SAP ERP.

Input parameters of the BAPI_MATERIAL_SAVEDATA action

Output parameters of the BAPI_MATERIAL_SAVEDATA action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the BAPI_MATERIAL_SAVEDATA action, see Action examples.

ZFM_GCP_MULTIDATA_TAB action

This action let users perform specific tasks. For example, you can create multi datatype data in SAP ERP.

Input parameters of the ZFM_GCP_MULTIDATA_TAB action

Output parameters of the ZFM_GCP_MULTIDATA_TAB action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the ZFM_GCP_MULTIDATA_TAB action, see Action examples.

PushIDoc Action

This action let you perform specific tasks. For example, you can transfer data from SAP to an external system.

Input parameters of the PushIDoc action

Output parameters of the PushIDoc action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the PushIDoc action, 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

Example - Create a record

This example creates a material record by using the BAPI_MATERIAL_SAVEDATA action.

1. In the Configure connector task dialog, click Actions.
2. Select the BAPI_MATERIAL_SAVEDATA action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "HEADDATA": "{\"MATERIAL\":\"000000000000009001\",\"IND_SECTOR\":\"M\",\"MATL_TYPE\":\"HALB\",\"BASIC_VIEW\":\"X\"}",
   "CLIENTDATA" : "{\"MATL_GROUP\":\"00107\",\"BASE_UOM\":\"KG\"}",
   "CLIENTDATAX" : "{\"MATL_GROUP\":\"X\",\"BASE_UOM\":\"X\"}",
   "MATERIALDESCRIPTION" : "{\"LANGU\":\"E\",\"MATL_DESC\":\"Classification Google\"}"
   }

If the action is successful, the BAPI_MATERIAL_SAVEDATA task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"RETURN_TYPE": "S",
"RETURN_ID": "MM",
"RETURN_NUMBER": 356,
"RETURN_MESSAGE": "The material 9001 has been created or extended",
"RETURN_LOG_NO": "",
"RETURN_LOG_MSG_NO": 0,
"RETURN_MESSAGE_V1": "9001",
"RETURN_FIELD": "",
"RETURN_SYSTEM": "T90CLNT090",
"RESULT_TABLE": null
}]

Example - Update a record

This example updates a material record by using the BAPI_MATERIAL_SAVEDATA action.

1. In the Configure connector task dialog, click Actions.
2. Select the BAPI_MATERIAL_SAVEDATA action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "HEADDATA": "{\"MATERIAL\":\"000000000000009000\",\"IND_SECTOR\":\"A\",\"MATL_TYPE\":\"FHMI\",\"BASIC_VIEW\":\"X\"}",
   "CLIENTDATA": "{\"MATL_GROUP\":\"013\",\"BASE_UOM\":\"ST\"}",
   "CLIENTDATAX": "{\"MATL_GROUP\":\"X\",\"BASE_UOM\":\"X\"}",
   "MATERIALDESCRIPTION": "{\"LANGU\":\"E\",\"MATL_DESC\":\"Classification Googlecloud\"}"
   }

If the action is successful, the BAPI_MATERIAL_SAVEDATA task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"RETURN_TYPE": "S",
"RETURN_ID": "MM",
"RETURN_NUMBER": 356,
"RETURN_MESSAGE": "The material 9000 has been created or extended",
"RETURN_LOG_NO": "",
"RETURN_LOG_MSG_NO": 0,
"RETURN_MESSAGE_V1": "9000",
"RETURN_PARAMETER": "",
"RETURN_ROW": 0,
"RETURN_FIELD": "",
"RETURN_SYSTEM": "T90CLNT090",
"RESULT_TABLE": null
}]

Example - Delete a record

This example deletes a material record by using the BAPI_MATERIAL_SAVEDATA action.

1. In the Configure connector task dialog, click Actions.
2. Select the BAPI_MATERIAL_SAVEDATA action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "HEADDATA": "{\"MATERIAL\":\"000000000000009000\",\"BASIC_VIEW\":\"X\"}",
   "CLIENTDATA": "{\"DEL_FLAG\":\"X\"}",
   "CLIENTDATAX": "{\"DEL_FLAG\":\"X\"}"
   }

If the action is successful, the BAPI_MATERIAL_SAVEDATA task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"RETURN_TYPE": "S",
"RETURN_ID": "MM",
"RETURN_NUMBER": 356,
"RETURN_LOG_NO": "",
"RETURN_LOG_MSG_NO": 0,
"RETURN_MESSAGE_V1": "9000",
"RETURN_PARAMETER": "",
"RETURN_ROW": 0,
"RETURN_FIELD": "",
"RETURN_SYSTEM": "T90CLNT090",
"RESULT_TABLE": null
}]

Example - Create multidata type data

This example creates multidata type data by using the ZFM_GCP_MULTIDATA_TAB action.

1. In the Configure connector task dialog, click Actions.
2. Select the ZFM_GCP_MULTIDATA_TAB action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "T_TABLE": "{\"ZACCP\":\"111\",\"ZCHAR\":\"CHARACTER1\",\"ZCLNT\":\"100\",\"ZCUKY\":\"INR\",\"ZCURR\": 200,\"ZDATS\": \"20231213\",\"ZINT1\": 45,\"ZINT2\":54,\"ZDEC\": 0.12,\"ZFLTP\": 1234,\"ZLANG\":\"E\",\"ZNUMC\":\"110\",\"ZPREC\": 3,\"ZQUAN\": 188.0,\"ZRAW\":\"01010008010101050401\",\"ZTIMS\": \"103056\",\"ZUNIT\":\"11\",\"ZINT4P\": 45,\"ZINT4\": 54,\"ZLRAW\":\"0101000801010105040100030101010300040000\"}",
   "IM_INPUT_1": "{\"ZACCP\":\"222\",\"ZCHAR\":\"CHARACTER1\",\"ZCLNT\":\"100\",\"ZCUKY\":\"INR\",\"ZCURR\": 200,\"ZDATS\": \"20231213\",\"ZINT1\": 45,\"ZINT2\":54,\"ZDEC\": 0.12,\"ZFLTP\": 1234,\"ZLANG\":\"E\",\"ZNUMC\":\"110\",\"ZPREC\": 3,\"ZQUAN\": 188.0,\"ZRAW\":\"01010008010101050401\",\"ZTIMS\": \"103056\",\"ZUNIT\":\"11\",\"ZINT4P\": 45,\"ZINT4\": 54,\"ZLRAW\":\"0101000801010105040100030101010300040000\"}",
   "IM_INPUT_2": "{\"ZSTRING\": \"HI Google\",\"ZSSTRING\": \"HI Google How are you\"}"
   }

If the action is successful, the ZFM_GCP_MULTIDATA_TAB task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"EX_OUTPUT_1_ZACCP": 222,
"EX_OUTPUT_1_ZCHAR": "CHARACTER1",
"EX_OUTPUT_1_ZCLNT": "100",
"EX_OUTPUT_1_ZCUKY": "INR",
"EX_OUTPUT_1_ZCURR": 200,
"EX_OUTPUT_1_ZDATS": "2023-12-13",
"EX_OUTPUT_1_ZRAW": "01010008010101050401",
"EX_OUTPUT_1_ZTIMS": "10:30:56",
"EX_OUTPUT_1_ZUNIT": "11",
"EX_OUTPUT_1_ZINT4P": 45,
"EX_OUTPUT_1_ZINT4": 54,
"EX_OUTPUT_1_ZLRAW": "0101000801010105040100030101010300040000\u0000",
"EX_OUTPUT_2_ZSTRING": null,
"EX_OUTPUT_2_ZSSTRING": null,
"RESULT_TABLE": null,
"T_TABLE_ZACCP": null,
"T_TABLE_ZCHAR": null,
"T_TABLE_ZCLNT": null,
"T_TABLE_ZQUAN": null,
"T_TABLE_ZRAW": null,
"T_TABLE_ZTIMS": null,
"T_TABLE_ZUNIT": null
},{
"EX_OUTPUT_1_ZACCP": null,
"EX_OUTPUT_1_ZCHAR": null,
"EX_OUTPUT_1_ZCLNT": null,
"EX_OUTPUT_1_ZCUKY": null,
"EX_OUTPUT_1_ZRAW": null,
"T_TABLE_ZLANG": null,
"T_TABLE_ZNUMC": null,
"T_TABLE_ZPREC": null,
"T_TABLE_ZQUAN": null,
"T_TABLE_ZRAW": null,
"T_TABLE_ZTIMS": null,
"T_TABLE_ZUNIT": null
},{
"EX_OUTPUT_1_ZACCP": null,
"EX_OUTPUT_1_ZCHAR": null,
"EX_OUTPUT_1_ZCLNT": null,
"EX_OUTPUT_1_ZCUKY": null,
"EX_OUTPUT_1_ZCURR": null,
"EX_OUTPUT_1_ZDATS": null,
"EX_OUTPUT_1_ZDEC": null,
"EX_OUTPUT_1_ZQUAN": null,
"T_TABLE_ZNUMC": 110,
"T_TABLE_ZPREC": 3,
"T_TABLE_ZQUAN": 188,
"T_TABLE_ZRAW": "01010008010101050401",
"T_TABLE_ZTIMS": "10:30:56",
"T_TABLE_ZUNIT": "11"
}]

Example - Push an IDoc

This example pushes an IDoc to the SAP ERP.

1. In the Configure connector task dialog, click Actions.
2. Select the PushIDoc action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "Content": "\n\n\n EDI_DC40\n 800\n 0000000008604824\n 740\n 53\n 2\n \n MATMAS05\n MATMAS\n ZLS_QA23\n LS\n ZLS_QA23\n SAPSA1\n LS\n SA1CLNT800\n 20230218\n 232556\n\n\n 005\n 000000000000000012\n 20170328\n 42039\n 20170727\n 42039\n KLVC\n FERT\n M\n 02\n BG\n 000\n 002\n 0.000\n 0.000\n KGM\n 0.000\n 0001\n 0.000\n 0.000\n 0.000\n 0.000\n 0.000\n",
   "FileType": "XML",
   "Mode": "ASync"
   }

. If the action is successful, the PushIDoc task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Result": "Success",
"Message": "Push IDoc success"
}]

Entity operation examples

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

Example - List all the records

This example lists all the records in the T001 entity.

1. In the Configure connector task dialog, click Entities.
2. Select T001 from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes (').

Example - Get a record from an entity

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

1. In the Configure connector task dialog, click Entities.
2. Select T001 from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 0001 in the Default Value field.

   Here, 0001 is a unique record ID in the T001 entity.