SAP SuccessFactors (Connection Definition File Format)
SAP SuccessFactors connection properties are set and retrieved in the connection definition file format and stored as a .json file. A connection definition file must not exceed 25MB.
Users with the DW Integrator role can create SAP SuccessFactors connections and set any connections properties (see SAP SuccessFactors Connections) using connection type specific syntax. To obtain detailed information about the connection syntax, you can read an appropriate connection from your space and write the output to a file using the --get option (see Read Connection Details).
|
Parameter |
Connection Property |
Description |
|---|---|---|
|
name |
Technical Name |
[required] Enter the technical name of the connection. The technical name can only contain alphanumeric characters and underscores (_). It cannot start or end with underscore (_). The name must be unique within the space. |
|
businessName |
Business Name |
[optional] Enter a descriptive name to help users identify the object. This name can be changed at any time. |
|
description |
Description |
[optional] Provide more information to help users understand the object. |
|
package |
Package |
[optional] Enter an existing package to facilitate transport between tenants (see Transporting Content Between Tenants). Default value: none |
|
url |
URL |
[required] Enter the OData service provider URL of the SAP SuccessFactors service that you want to access.
The syntax for the URL is:
|
|
version |
Version |
[required] Enter the OData version used to implement the SAP SuccessFactors OData service (V2 or V4; see the URL). |
|
authType |
Authentication Type |
[required] Enter the authentication type to use to connect to the OData endpoint.
You can enter:
|
|
oauth2GrantType |
OAuth Grant Type |
If you have entered OAuth2 as authType: [required] Enter SAML Bearer as the grant type used to retrieve an access token. |
|
oauth2TokenEndpoint |
OAuth Token Endpoint |
If you have entered OAuth2 as authType: [required] Enter the SAP SuccessFactors API endpoint used to request an access token: <SAP SuccessFactors API Server>/oauth/token. |
|
oauth2Scope |
OAuth Scope |
If you have entered OAuth2 as authType: [optional] Enter an OAuth scope to restrict the access rights of the issued OAuth token, if applicable. |
|
oauth2CompanyId |
OAuth Company ID |
If you have entered OAuth2 as authType: [required] Enter the SAP SuccessFactors company ID (identifying the SAP SuccessFactors system on the SAP SuccessFactors API server) to use to request an access token. |
|
clientId |
Client ID |
If you have entered OAuth2 as authType: [required] Enter the API key received when registering SAP Datasphere as OAuth2 client application in SAP SuccessFactors. |
|
samlAssertion |
SAML Assertion |
If you have entered OAuth2 as authType:
[required] Enter a valid SAML assertion that has been generated for authentication.
|
|
username |
User Name |
If you have entered Basic as authType: [required] Enter the user name in <username@companyID> format. |
|
password |
Password |
If you have entered Basic as authType: [required] Enter the password. |