Create Record
Description
Creates a new record in an SAP Business Object.
The activity uses SAP OData APIs and supports SAP systems that expose OData services, including SAP S/4HANA Cloud and SAP S/4HANA On-Premises environments.
After selecting the SAP Service and Business Object, you can map values to the fields of the new record. When the selected Business Object supports related child entities, you can also configure line items to create the complete business object structure in a single operation.
Common Capabilities
Process Data Support
This activity supports dynamic configuration using variables from the Process Data drawer.
You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.
Learn more → Using Process Data
Design-Time Configuration
Display Text
A user-defined name for the activity, displayed on the workflow canvas to help identify its purpose.
Connection Name
The configured SAP connection used to access the SAP system.
The connection determines the SAP system and the OData services available to the activity.
If you have not yet created or configured an SAP connection, see SAP Connection.
Service
The SAP OData service containing the Business Object in which you want to create a record.
The available services are retrieved based on the selected SAP connection.
Business Object
The Business Object in which the new record is created.
The available Business Objects depend on the selected Service.
OData Version
Specifies the OData protocol version used to communicate with the selected SAP service.
| Option | Description |
|---|---|
| Auto | Automatically determines the appropriate OData version based on the configured connection URL. This is the default option. |
| OData V2 | Uses the OData V2 protocol to communicate with the SAP service. |
| OData V4 | Uses the OData V4 protocol to communicate with the SAP service. |
Use the default Auto option unless you specifically need to force the activity to use OData V2 or OData V4.
Timeout
Specifies the maximum amount of time, in seconds, that the activity waits for the SAP OData request to complete.
If the request does not complete within the configured duration, the activity times out.
Ignore Business Errors
Determines how the activity handles business-level errors returned by SAP within an otherwise successful response.
SAP OData services may return an HTTP 200 OK response even when the requested operation fails because of a business validation error, such as a missing required field or an invalid value. In such cases, SAP may include the business error details in the RETURN structure of the response payload.
| Option | Behavior |
|---|---|
| Disabled (default) | Inspects successful responses for SAP business errors. If a business error is detected in the RETURN structure, the activity throws an exception and the configured error handling strategy is applied. |
| Enabled | Ignores business errors embedded in the successful response and does not throw an exception. The workflow continues, allowing the returned record to be inspected and the business error to be handled through workflow logic. |
Enable Ignore Business Errors when you want to handle SAP business validation errors within the workflow instead of treating them as activity failures.
For example, you can inspect the returned Record and use conditions to determine how the workflow should proceed.
This option applies to business errors returned within a successful SAP response. Transport, authentication, connectivity, HTTP, and other runtime errors are still handled as activity errors.
Wait All Incoming
Controls how this activity behaves when multiple incoming execution paths converge.
Determines whether the activity executes when:
- Any incoming path completes, or
- All relevant incoming paths complete before execution
Learn more → Execution Control
On Error
Defines how the workflow behaves if this activity encounters a runtime error.
Supported strategies include:
- Fault
- Continue
- Suspend
- Retry
Field Mapping
The Field Mapping tab allows you to specify the values for the fields of the SAP Business Object being created.
The available fields are determined by the selected Business Object.
Values can be provided directly or dynamically using Process Data, including Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.
The configured field mappings are used to construct the new SAP Business Object record.
Map only the fields required to create the record. The mandatory fields depend on the selected SAP Business Object and the configuration of the SAP service.
Line Items
The Line Items tab allows you to create related child records along with the main Business Object.
The available line item types are determined by the relationships exposed by the selected SAP Business Object.
For example, when creating a Sales Contract, the available related entities may include:
- Items
- Partners
- Pricing Elements
- Text
The actual line item types available depend on the selected SAP Service and Business Object.
Each supported line item can be configured using one of the following methods.
Fixed Rows
Use Fixed rows when the number of line items is known while designing the workflow.
Add the required rows and configure the field values for each row individually.
This is useful when the workflow always creates a known or fixed number of related records.
Repeat for Each
Use Repeat for each when line items need to be generated dynamically from a collection.
Configure a collection from Process Data and map the fields of each item in the collection to the corresponding SAP line item fields.
At runtime, IB-X iterates through the collection and creates the corresponding line items as part of the SAP record.
Use Fixed rows for a known set of line items and Repeat for each when the number of line items is determined dynamically at runtime.
Output
Created Record
The response returned by SAP for the create operation.
When the record is created successfully, this output contains the resulting SAP Business Object record.
When Ignore Business Errors is enabled, the response is returned even when SAP reports a business-level error within the response payload. This allows downstream activities to inspect the returned data and handle the business error through workflow logic.
Error Message
Contains information about an error encountered while executing the activity.
This output can be used by downstream activities to inspect or handle errors as part of the workflow.
Remarks
-
The selected SAP connection must have access to the configured OData service.
-
The available Services depend on the OData services exposed by the connected SAP system.
-
The available Business Objects depend on the selected Service.
-
The fields available for Field Mapping depend on the selected Business Object.
-
The authenticated SAP user must have permission to create records in the selected Business Object.
-
Ensure that all mandatory SAP fields required for creating the selected Business Object are mapped.
-
Related entities available under Line Items depend on the relationships exposed by the selected SAP Business Object.
-
Use Fixed rows when the required line items are known at design time.
-
Use Repeat for each when line items need to be created dynamically from a collection at runtime.
-
SAP may apply additional business validations when creating a record. Ensure that the supplied values satisfy the business rules configured in the SAP system.