Skip to main content
Version: Current

Get Record

Description​

Retrieves a single record from an SAP Business Object using its unique record identifier.

The activity uses SAP OData APIs and supports SAP systems that expose OData services, including SAP HANA Cloud and SAP on-premises environments.

Use Get Record when the identifier of the record is already known. To retrieve multiple records or search for records using filter criteria, use the Get Records activity.

Common Capabilities​

Process Data Support​

info

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 you want to access.

The available services are retrieved based on the selected SAP connection.

Business Object​

The Business Object containing the record you want to retrieve.

The available Business Objects depend on the selected Service.

Record Identifier​

The unique identifier of the record to retrieve.

You can provide the identifier directly or configure it dynamically using Process Data.

OData Version​

Specifies the OData protocol version used to communicate with the selected SAP service.

OptionDescription
AutoAutomatically determines the appropriate OData version based on the configured connection URL. This is the default option.
OData V2Uses the OData V2 protocol to communicate with the SAP service.
OData V4Uses the OData V4 protocol to communicate with the SAP service.
tip

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.

Wait All Incoming​

Execution Control

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​

Error Handling Strategy

Defines how the workflow behaves if this activity encounters a runtime error.

Supported strategies include:

  • Fault
  • Continue
  • Suspend
  • Retry

Learn more → Error Handling

Fields​

The Fields tab allows you to select the fields to retrieve from the selected SAP Business Object.

The available fields are dynamically populated based on the selected Business Object.

Select only the fields required by your workflow to avoid retrieving unnecessary data.

The values of the selected fields are returned as part of the Record output and can be accessed by downstream activities.

Output​

Record​

The SAP Business Object record retrieved using the specified Record Identifier.

The Record contains the fields selected in the Fields tab and can be used by downstream activities through Activity Outputs.

Error Message​

Contains information about any error encountered while retrieving the record.

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 available fields in the Fields tab depend on the selected Business Object.

  • The authenticated SAP user must have permission to read the selected Business Object.

  • Auto is the default OData Version and automatically determines the appropriate OData version based on the configured connection URL.

  • Use Get Record when the unique identifier of the record is known.

  • Use Get Records when multiple records need to be retrieved or records need to be selected using filter criteria.