Get Records
Description
Retrieves a collection of records from 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.
Use Get Records when you need to retrieve multiple records from a Business Object. You can select the fields to retrieve, apply filter conditions, control the number of records returned, and define the sort order.
To retrieve a specific record when its unique identifier is known, use the Get Record activity.
Common settings
Use Process Data to bind supported inputs to workflow values or upstream outputs. See Common Activity Features for shared execution, error-handling, and output-persistence settings. Availability depends on the activity.
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 records you want to retrieve.
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
Maximum HTTP request duration in seconds. The default 0 uses the selected connection's timeout. Set a positive value to override it for this activity.
Execution settings
Configure Wait All Incoming when execution paths converge, and On Error for failure handling. Select Inherit where available to use the workflow-level error policy.
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 for each record in the Records output and can be accessed by downstream activities.
Filter
The Filter tab allows you to define conditions that determine which records are retrieved from the selected SAP Business Object.
Use filter conditions when you want to retrieve only records that match specific criteria instead of retrieving all available records.
The available fields for defining filter conditions depend on the selected Business Object.
Apply appropriate filter conditions whenever possible to reduce the amount of data retrieved from SAP.
Record Limit
The Record Limit tab controls the number of records retrieved from SAP and supports retrieving records in pages.
Read All
Determines whether all records matching the configured filter conditions are retrieved.
When Read All is enabled, the activity retrieves all matching records without requiring you to specify a particular page.
When Read All is disabled, use Page Number and Page Size to control which records are retrieved.
Max Records
Limits total records when Read All is enabled. The default 0 imposes no configured record cap. Read All follows server-supplied next-page links; Page Number and Page Size apply only when Read All is disabled.
Related data (Expand)
Specify supported navigation properties to include related data with each record.
Page Number
Specifies the page of records to retrieve.
The default value is 1.
This property is available when Read All is disabled.
Page Size
Specifies the maximum number of records to retrieve for the specified page.
The default value is 100.
This property is available when Read All is disabled.
Use Read All carefully when working with Business Objects that may contain a large number of records.
For large datasets, use filtering and pagination to retrieve only the records required by the workflow.
Sort Direction
The Sort Direction tab allows you to define the order in which records are returned.
Configure the required Business Object field and sort direction to control the ordering of the retrieved records.
Sorting can be used together with filtering and record limits to retrieve a specific ordered set of SAP records.
Output
Records
A collection of SAP Business Object records retrieved from the selected SAP service.
Each record contains the fields selected in the Fields tab.
The collection can be used by downstream activities through Activity Outputs.
Remarks
-
The available Business Objects depend on the selected Service.
-
The available fields in the Fields and Filter tabs depend on the selected Business Object.
-
The authenticated SAP user must have permission to read the selected Business Object.
-
Use filters to restrict the records retrieved when only a subset of the Business Object data is required.
-
Use Read All when all records matching the configured filter conditions need to be retrieved.
-
For large datasets, use Page Number and Page Size instead of retrieving all records.
-
Use Get Records when multiple records need to be retrieved or selected using filter criteria.
-
Use Get Record when the unique identifier of the required record is known.
Example: Retrieve a page
Select the service and Business Object, configure the required fields, and add a filter for the records needed. Leave Read All off, set Page Number to 1, and Page Size to 20. Set Sort Direction to a stable key order, such as PurchaseOrder ASC for an object with that key.
Process Records, then request page 2 with the same filter and order. A page beyond the matching records returns no items. Include a unique key in the sort to avoid ambiguous ordering among equal values, and avoid changing the matching set while paging.