SuccessFactors Read

Snap Type:

Read

Description:

This Snap provides the ability to retrieve data objects from your SuccessFactors instance.

Prerequisites:

None

Support and limitations:

Ultra pipelines: Works in Ultra Pipelines.

Spark mode: Not supported in Spark mode.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to access to the endpoint. See SuccessFactors Account for information on setting up this type of account.

Views:

Input
This Snap has at most one document input view.

Output
This snap has at most one document output view.

Error
This Snap has one optional error view and might produce documents in the view if the input data causes an error in the REST API.

Settings

Label:

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Entity:

Required. This property enables you to define an entity of the API. This field will be shown dynamically from different users’ accounts from the suggestion dropdown. Users are allowed either to choose an entity from suggestion dropdown or type an entity manually. The entity is shown as [category name] – [entity name] in the dropdown. But it is also allowed to type only [entity name] in this field.

Example: Foundation/Platform (PLT) – User or User

Default value: [None]

Key parameter:

This property enables you to specify the key fields to a specific entity such as userId for the Foundation/Platform (PLT) – User entity.

Example: userId

Default value: [None]

URL parameters:

This property enables you to Specify the names and values of the URL parameters.

Example: fromDate=’2019-01-01’

Default value: [None]

Filter records:

This property enables you to filter the results from the API response based on the customer selected fields.

Example: userId equals ‘test123’ or userId less than ‘b’

Default value: [None]

Output field selection:

This property enables you to select fields to be included in the output. If not selected, all fields will be returned.

Example: userId, country

Default value: [None]

Order by:

This property enables you to order the resulting records based on specified elements. The order types to be selected are either ascending or descending.

Example: country descending

Default value: [None]

Output fields advanced options

Output entry limit
This property enables you to select the number of records the query should return.

Example: 10

Default value: [None]

Output entry offset
This property enables you to skip the number of records the query should return.

Example: 10

Default value: [None]

Automatic pagination:

By default, SuccessFactors returns a maximum of 1000 records per page. If this field is selected, all matching records will be automatically returned (beyond the 1000 records).

Default value: Not selected

Process empty result:

This property enables you to determine if the empty result will be shown in the output views. If not selected, an error will be thrown when the empty result is found.

Default value: Selected

Refresh metadata:

If selected, the Snap will refresh the cache and show refreshed metadata results including new entities/parameters added or old entities/parameters deleted. This is handy in cases where changes are made to the data set outside of SnapLogic, such as a new data set created, existing data set deleted, and so on. In such cases, enabling this property will refresh the cache and display updated content.Please be aware that after the first run and new metadata has been refreshed, please de-select this checkbox.

Default value: Not selected

Pass through:

This property enables you to "pass through" the data from an incoming document and merge it into the new document being written to the output. If selected, the input document will be passed through to the output view under the key 'original'.

Default value: Selected

Connection details:

Connection timeout
Required. This property enables you to set the connection timeout duration of seconds.
Default value: [300]

Number of retries
Required. This property enables you to set the maximum number of re-connections if the connection is failed or timeout.
Default value: [3]

Retry interval (seconds)
Required. This property enables you to set the interval in seconds between reconnections.
Default value: [1]