Input 

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.

Output

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

String

The name of the key parameter (reference parameter) field.

N/A

userId

Any

The value of the key parameter (reference parameter) field. The data type of this field depends on the data type of the field name, such as String, Integer, or Boolean.

N/A

test_id

URL parameters

Fieldset

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

N/A

fromDate=’2019-01-01’

String

The name of the URL parameter.

fromDate

fromDate

Any

The values of the URL parameter. The data type of this field depends on the data type of the field name, such as String, Integer, or Boolean.

N/A

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’

String

The name of the field in the system parameter $filter, which is to be included in the output.

userId

String

The comparison operator for the system parameter $filter.

Equals

Equals

Any

The value of the specified $filter fields. The data type of this field depends on the data type of the field name, such as String, Integer, or Boolean.

N?A

test123

String

The logical operator for the system parameter $filter.

Or

Or

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

String

The fields that will be displayed by descending or ascending order

N/A

country

String

The Order Type (Ascending or Descending order).

Ascending

descending

Output fields advanced options

N/A

Add advanced options to define the limited number of output entries from a specific starting entry index.

N/A

N/A

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

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).

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

If selected, the Snap refreshes the cache and shows the refreshed metadata results including any entities/parameters that were added or deleted. This is useful in cases where changes are made to the dataset outside of SnapLogic, such as when a dataset has been created or deleted, or when there are changes in the metadata of SuccessFactors. 

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

Check box

Execute only

N/A