SAP SuccessFactors policy

A SAP SuccessFactors policy contains the connection details that are used by a SAP SuccessFactors Request node when connecting to SAP SuccessFactors.

You can use a SAP SuccessFactors Request node in a message flow to connect IBM® App Connect Enterprise to SAP SuccessFactors and issue requests to perform actions on objects such as job applications, job application interviews, job requisitions, candidates, and onboarding candidate information. The SAP SuccessFactors policy controls, at run time, access to the SAP SuccessFactors application.

The SAP SuccessFactors policy is created when you configure a connection between a SAP SuccessFactors Request node and SAP SuccessFactors by using the Connector Discovery wizard. During the process of discovery, account credentials are stored in the vault and connection details are stored in a SAP SuccessFactors policy. The policy is created with a type of SAP SuccessFactors, and the name of the policy is returned to the SAP SuccessFactors Request node and specified in the Connection tab of the node, in the format {policyProjectName}:policyName.

You can also create, update, or delete a SAP SuccessFactors policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy a SAP SuccessFactors policy, all message flows that are using the policy will be stopped and restarted.

For more information about using SAP SuccessFactors policies, see Using SAP SuccessFactors with IBM App Connect Enterprise.

Table 1. Properties of the SAP SuccessFactors policy
Property	Property name in .policyxml file	Description of properties
Credential Name	credentialName	This property specifies the name of the credential that will be used for the connection to SAP SuccessFactors. The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider.
SAP SuccessFactors Authentication method	authenticationMethod	This property specifies the type of authentication that is used for the connection between IBM App Connect Enterprise and SAP SuccessFactors. This property can be set to `BASIC` or `OAUTH2_PASSWORD`.
SAP SuccessFactors Application Type	applicationType	This property is reserved for future use and must be set to the value `online`.
SAP SuccessFactors Application Version	applicationVersion	This property is reserved for future use and must be set to the value `v1`.
Server URL	domainName	This property specifies the URL of the API server that makes runtime calls.
Allow self-signed certificates	isTlsEnabled	This property specifies whether self-signed certificates are allowed. Set to `true` if you want to be able to accept self-signed certificates that are trusted and used only in a nonproduction environment. Default is `false`.
Override server URL	endpointUrl	This optional property specifies an override value for the host and port in the OpenAPI definition, in the format `<http or https>://<host_name>:<port>`. This property is required if you want to connect to an endpoint in a private network by using the private network client, or if you want to override the server URL. If you are not using the private network client or do not require an override, leave this field blank to use the host name and port in the OpenAPI definition.