SAP S/4HANA v2

SAP S/4HANA is an ERP platform used to work with business partners, sales orders, materials, and other operational business objects through OData services.

The Flowgear SAP S/4HANA Node lets you execute supported query, create, update, and delete operations against the embedded SAP service definitions by using template-selected services and operations in a Workflow. Query responses stay provider-shaped, while create, update, and delete responses add the standard Flowgear result object inside Response.Flowgear.

Revision History

0.0.0.20 - Aligned the connector contract.
0.1.0.0 - Completed the Runtime overhaul with eager first-request startup and lazy bounded continuation.
0.2.0.0 - Corrected mutation payloads and defaults, added sanitized request echoes, and made OData pagination automatic.
0.2.0.1 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.2.0.4 - Maintenance release.

Connection

The Connection stores the SAP host, authentication settings, and request behavior used by the embedded service metadata.

Property Type Description
Host String Required. The host name or IP address of the SAP S/4HANA instance.
Port String Required. The HTTPS port exposed by the SAP Gateway.
Username String Required. The SAP technical or dialog user used for basic authentication.
Password Masked Required. The password associated with the SAP user.
Timeout (seconds) Integer The timeout applied to SAP calls. The default is 30.
Exclude Empty Query Parameters Boolean When true, query parameters with empty values are omitted from requests. The default is true.

Setup Notes

  1. Confirm that the target OData services, for example, API_BUSINESS_PARTNER or API_SALES_ORDER_SRV, are activated and reachable through the SAP Gateway.
  2. Coordinate with the SAP BASIS team to allow Flowgear outbound IP addresses and provision a user with the required permissions.
  3. Confirm HTTPS access to the Gateway host and port, and make sure CSRF token requests are permitted for create, update, and delete operations.
  4. The Connection test requests the SAP Gateway catalog service (/sap/opu/odata/IWFND/CATALOGSERVICE;v=2), so make sure that service is active and that the user can access it.

Methods

The SAP S/4HANA Node exposes separate methods for query, create, update, and delete operations.

Query

Executes a GET-based SAP S/4HANA operation.

Parameter Type Description
Connection Connection The SAP S/4HANA Connection.
Service String The target SAP service, for example, API_SALES_ORDER_SRV.
OperationId String The operation identifier selected from the template.
Options Object Optional route and query parameters for the request.
Return Type Description
Response Array The streamed response items returned by the SAP operation. Query responses do not add Flowgear mutation defaults.

Create

Executes a POST-based SAP S/4HANA operation.

Parameter Type Description
Connection Connection The SAP S/4HANA Connection.
Service String The target SAP service, for example, API_SALES_ORDER_SRV.
OperationId String The operation identifier selected from the template.
Options Object Optional route and query parameters for the request.
Items Array Optional request body items to send to the SAP operation.
Return Type Description
Response Array The streamed response items returned by the SAP operation. Each response item includes Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request inside Response.Flowgear.

Update

Executes a PUT- or PATCH-based SAP S/4HANA operation.

Parameter Type Description
Connection Connection The SAP S/4HANA Connection.
Service String The target SAP service, for example, API_SALES_ORDER_SRV.
OperationId String The operation identifier selected from the template.
Options Object Optional route and query parameters for the request.
Items Array Optional request body items to send to the SAP operation.
Return Type Description
Response Array The streamed response items returned by the SAP operation. Each response item includes Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request inside Response.Flowgear.

Delete

Executes a DELETE-based SAP S/4HANA operation.

Parameter Type Description
Connection Connection The SAP S/4HANA Connection.
Service String The target SAP service, for example, API_SALES_ORDER_SRV.
OperationId String The operation identifier selected from the template.
Options Object Optional route and query parameters for the request.
Return Type Description
Response Array The streamed response items returned by the SAP operation. Each response item includes Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request inside Response.Flowgear.

Usage Notes

  • Use the template picker to select the correct Service and OperationId combination.
  • Query completes the first SAP provider request while the Node invoke is awaited. Additional pages are fetched lazily as the Workflow reads the response stream.
  • Create and Update complete the first batch of up to 100 items while the Node invoke is awaited. Later batches are consumed lazily, and an empty connected input sends no provider request. When Items is not connected, a single request is sent.
  • Delete does not accept Items. It sends a single request built from Options while the Node invoke is awaited.
  • The Node handles SAP OData continuation links internally and hides $top, $skip, $skiptoken, and provider continuation fields from templates and emitted rows.
  • Mutation request echoes use Items when present and Options for bodyless operations. Nested Content values are excluded.
  • CSRF tokens are requested automatically for create, update, and delete operations.
  • If the first SAP query call fails, the Node surfaces that provider error instead of returning a synthetic response row.
  • Set Exclude Empty Query Parameters to true when the target service rejects blank query values.

Known Issues

  • Only basic authentication is supported by this Node.