Skip to main content
Version: Current

Find SAP Business Object

Description​

Finds Business Objects available within a specified SAP OData service.

Use this activity to discover SAP Business Objects at runtime instead of selecting a specific Business Object while designing the workflow.

Specify the Service Name containing the Business Objects and optionally provide a Search Term to narrow the results.

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 Name​

The SAP OData service in which to search for Business Objects.

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

For dynamic service discovery, the service information returned by the Find SAP Service activity can be used to provide the required Service Name.

OData Version​

Specifies the OData protocol version used when discovering Business Objects from the specified 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.
OData V4Uses the OData V4 protocol.
tip

Use the default Auto option unless you specifically need to use OData V2 or OData V4.

Timeout​

Specifies the maximum amount of time, in seconds, that the activity waits for the SAP request to complete.

If the request does not complete within the configured duration, the activity times out.

Search Term​

An optional value used to search for Business Objects within the specified SAP service.

The activity searches for Business Objects containing the specified term.

For example, specifying:

purchase

returns Business Objects containing purchase in their searchable information.

The search term can be provided directly or configured dynamically using Process Data.

If no search term is provided, the activity returns the available Business Objects discovered within the specified SAP service.

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

Output​

Business Objects​

A collection of SAP Business Objects found within the specified SAP OData service.

When a Search Term is provided, the collection contains the Business Objects matching the specified search criteria.

Each Business Object in the collection contains the following information:

PropertyDescription
NameTechnical name of the SAP Business Object.
Display NameDisplay name of the SAP Business Object.

The returned Business Objects collection can be used by downstream activities through Activity Outputs.

Error Message​

Contains information about any error encountered while searching for SAP Business Objects.

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 specified OData service.

  • Service Name identifies the SAP OData service in which Business Objects are searched.

  • The Business Objects returned by the activity depend on the objects exposed by the specified SAP OData service.

  • Search Term performs a term-based search within the available Business Objects.

  • Leave Search Term empty when you want to retrieve all Business Objects available within the specified service.

  • Each item in the returned Business Objects collection provides the Business Object Name and Display Name.

  • The authenticated SAP user must have sufficient permissions to access the specified OData service.

  • Use Find SAP Service when the required service must first be discovered dynamically.

  • Use the returned Business Objects collection when Business Object discovery needs to be performed dynamically at runtime.