Document

• Min: 0
• Max: 1

• Mapper
• Copy
• CSV Parser
• JSON Parser

A document containing data for filtering entities that need to be retrieved in SuccessFactors.

Document

• Min: 1
• Max: 1

• Mapper
• Copy
• CSV Parser
• JSON Parser

A document containing the data retrieved from a SuccessFactors entity.

Label

String

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.

N/A

N/A

Entity

String

Required. Lets you select an entity (business object) from the list of entities defined for the API. You can either choose an entity from the suggestion drop-down or type an entity manually. The values in the suggestion drop-down are displayed dynamically based on different users’ accounts.

The entity is shown as [category name] – [entity name] in the drop-down; however, you can also type just the [entity name] in this field.

N/A

Foundation/Platform (PLT) – User or User

Key parameter

Fieldset

Lets you specify the key fields for a specific entity, such as userId for the Foundation/Platform (PLT) – User entity.

N/A

userId

URL parameters

Fieldset

Lets you specify the names and values of the parameters included in the URL.

N/A

fromDate=’2019-01-01’

Filter records

Fieldset

Lets you filter the API response based on the customer selected fields.

N/A

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

Output field selection

Fieldset

Lets you select the fields to be included in the output. If not selected, all fields are returned.

N/A

userId, country

Order by

Fieldset

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

N/A

country descending

Output entry limit

Integer

The maximum number of output entries from a specific starting entry index.

N/A

10

Output entry offset

Integer

The number of records the query must skip in the while fetching the results. 

N/A

10

Automatic pagination

String

Deselected

N/A

Allow empty query result

Check box

If selected, empty result are also shown in the output views. Else, an error is displayed when an empty result is found.

Selected

N/A

Refresh metadata

Check box

Deselected

N/A

Pass through

Check box

If selected, lets the data from an incoming document "pass through" and merge into the new document being written to the output. The input document is passed through to the output view under the key 'original'.

Selected

N/A

Connection details

N/A

Required. Specify the Internet connection details.

N/A

N/A

Connection timeout

Integer

Required. The connection timeout duration in seconds.

300

N/A

Number of retries

Integer

Required. The maximum number of reconnection attempts if the connection fails or times out.

3

N/A

Retry interval (seconds)

Integer

Required. The interval in seconds between reconnection attempts.

1

N/A

Snap execution

Check box

Select one of the three modes in which the Snap executes. Available options are:

• Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
• Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.

Execute only

N/A

You have an empty value in the Key/Value field.

Key/value parameters must not be empty.

Enter a valid value for key/value parameters.

The input entity does not exist.

An invalid entity has been entered.

Click the suggestion drop-down in the Entity field and select the entity.

The fields "Automatic pagination" and "Output entry limit" cannot be used at the same time.

The output entry limit cannot be implemented together with automatic pagination.

Either select the Automatic pagination field or specify a value in the Output entry limit field.

Empty result found.

There is no data fetched by the API call.

Select the Allow empty query result check box.

<Entity> with key (‘<key>’) not found!