Configuration

On the Configuration tab you can specify information to connect to SAP API Business Hub for downloading and testing of public SAP SuccessFactors APIs and to connect to the production tenant. The Configuration tab has the following sections: General, Repository, Tenant, and Advanced.

General

In the General panel, you can specify the package where the shared resource is stored in the Package field and provide a short description for this shared resource in the Description field. The panel also shows the shared resource name which you defined when creating the shared resource.
Note: The General panel on the Configuration and the Schema tabs are the same.

Repository

In the Repository panel of the Configuration tab, you can specify the options for connecting to the SAP API Business Hub for downloading SAP SuccessFactors APIs and testing the APIs in an SAP-provided sandbox. The following table lists the configurations in the Repository panel:
Field Module Property Description
URL Yes URL of SAP API Business Hub.

Default value: https://api.sap.com

Warning: The URL property is editable. However, modify this field only if there is a change in the SAP API Business Hub URL.
User Name Yes The user name to log in to the SAP API Business Hub.
Password Yes The password to log in to the SAP API Business Hub.
Note: After you provide the repository credentials, you can download the SAP SuccessFactors APIs from the Schema tab.

Tenant

In the Tenant panel of the Configuration tab, you can specify the connection information for the plug-in runtime to call the SAP SuccessFactors APIs in the production tenant.
Field Module Property Description
Product Type No The type of the SAP product.

Default value: SAP SuccessFactors

Type No The type of tenant. The plug-in provides the following types:
  • Sandbox. (Default)
    Note: For SAP SuccessFactors, all the operations (GET, POST, PUT and DELETE) are supported in the sandbox.
  • Production
The following fields are available when the Type is Production.
URL Yes URL of production tenant
Authentication Type No The type of authentication.
The plug-in supports the following authentication types:
  • Basic Authentication
  • OAuth 2.0
User Name Yes This field is required. The user name to connect to the tenant. The tenant User name is provided in the username@companyID format.
Password Yes This field is required. The user password to connect to the tenant.
Company ID Yes If you have opted for Basic Authentication and User Name is in the username@companyID format, this field is optional. This field is mandatory in the following cases:
  • If you are using Basic Authentication and User Name is not in the username@companyID format.
  • If you are using OAuth 2.0 authentication.

OAuth 2.0

In the OAuth 2.0 panel of the Configuration tab, you can specify additional connection information that is required when the Authentication Type is OAuth 2.0.
Field Module Property Description
API Key Yes The API Key obtained from the SAP SuccessFactors tenant.
User ID Yes User ID of the SAP SuccessFactors tenant.
API URL Yes The API URL needed for SAP SuccessFactors OAuth authentication. For example, https://apisalesdemo8.successfactors.com/.
X509 Certificate Yes Download the X.509 certificate from the SAP SuccessFactors tenant.

Advanced

In the Advanced panel of the Configuration tab, you can specify additional information about the number of threads needed for processing requests.
Field Module Property Description
Service No. of Threads Yes The number of concurrent threads for processing requests to the activity.
Default value: 8. (A value less than 1 is automatically changed to the default value.)
Note: See the Job Tuning section for more information about how to configure this field.
Related concepts