The ConsumeSAPSuccessFactorsODataService Activity

You can use SAP SuccessFactors to interact with third-party applications and use the OData Rest services to perform operations on SAP SuccessFactors entities. SuccessFactors uses OData for extracting and manipulating most data entities. The ConsumeSAPSuccessFactorsODataService Activity helps you consume the OData entities from TIBCO ActiveMatrix BusinessWorks. The following operations are supported by SAP SuccessFactors: GET, PUT, POST, and DELETE.

General

The General tab contains the following fields.

Field Module Property? Description
Name No The name to be displayed as the label for the activity in the process.
SAP SaaS Connection Yes Click to select an SAP SaaS Connection shared resource. The SAP SaaS Connection shared resource establishes connections between the plug-in and the SAP SuccessFactors.

If no matching SAP SaaS Connection shared resources are found, click Create Shared Resource to create one. For more details, see Creating and Configuring the SAP SaaS Connection Resource.

SAP SuccessFactors API No Click Fetch API to fetch the SAP SuccessFactors APIs that you had previously downloaded from the Schema tab.
Service No After fetching the SAP SuccessFactors API, select a service.
Note:

Underscores are used only for parameters. If the service node name contains an underscore (_), the underscore is automatically removed from the displayed service name.

Operation No Select the operation. The operation visible depends on the type of the service. It can be one of the following: GET, PUT, POST, and DELETE.

Description

On the Description tab, provide a short description for the activity.

Input

The input is generated based on the SAP SuccessFactors API Service and the Operation selected by the user.

The Input tab displays the input schema of the activity as a tree structure. The information in the schema varies based on the fields selected on the General tab. You must enter information as required for any mandatory fields.

Output

The Output tab shows the response of the invoked service. The Output tab displays the output schema of the activity as a tree structure. The output is read-only. The information in the schema varies based on the fields selected on the General tab.
Output Item Data Type Description
ResultCount Integer This ResultCount field from Output counts how many records are returned after the ConsumeSAPSuccessFactorsODataService activity is invoked.

Fault

The Fault tab lists exceptions that are thrown by this activity. There are two types of exceptions thrown by the ConsumeSAPSuccessFactorsODataService activity:
  • SFSystemFault: Thrown when the error originates from the SAP SuccessFactors system.
  • SFPluginFault: Thrown when the error originates from the plug-in.
Error Schema Element Datatype Description
msg string The error message returned by the plug-in.
msgCode string The error code returned by the plug-in.