Input 

Document

• Min:0

• Max:1

• Mapper Snap

• Copy Snap

• CSV Parser

• JSON Parser

A document containing data that can be used to filter entities that need to be retrieved in SuccessFactors. 

Output

Document

• Min:1

• Max:1

• Mapper Snap

• Copy Snap

• XML Formatter

• JSON Formatter

A document containing the data retrieved from a SuccessFactors entity.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Field Name

Field Type

Description

Default Value

Example 

Label

Default Value:
Example:

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

Default Value:
Example:

String

Required. This property enables you to select a business object from the list of business objects for SuccessFactors API. SuccessFactors stores data in multiple table structures, which are commonly known as Entities, there are various entities for Foundation as well as Personal/Employment Objects. 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.

N/A

Foundation/Platform (PLT) – User or User

Query Type

Default Value:
Example:

String

Specify the query type. Options available include:

• Expand

• Custom Query

N/A

N/A

Expand Level

Default Value:
Example:

Integer

Specify the sublevel of the business object you want to access. The business object would be expanded until the sublevel selected. Option available include:

• 0

• 1

• 2

The filed is only available if the query type is selected as 'Expand'.

0

N/A

Query

Default Value:
Example:

String

Specify the custom query 

The filed is only available if the query type is selected as 'Custom Query'.

N/A

N/A

Key parameter

Fieldset

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

N/A

N/A

Field name

Default Value:
Example:

String

Specify the names of key Parameter (reference parameter) fields.

N/A

userId

Field value

Default Value:
Example:

Any

Specify the values of key Parameter (reference parameter) fields. The data type of this field depends on what Field name you selected or entered which can be String, Integer, Boolean, etc.

N/A

test_id

URL parameters

Fieldset

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

The filed is only available if the query type is selected as 'Expand'.

N/A

N/A

Parameter name

Default Value:
Example:

String

Specify the names of the URL parameters.

fromDate

fromDate

Parameter value

Default Value:
Example:

Any

Specify the values for service operation fields. The data type of this field depends on what Field name you selected or entered which can be String, Integer, Boolean, etc.

N/A

2020-01-01

Filter records

Fieldset

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

The filed is only available if the query type is selected as 'Expand'.

N/A

N/A

Field name

Default Value:
Example:

String

Specify the system parameter $filter fields to be included in the output.

N/A

userId

Operation

Default Value:
Example:

String

Specify the comparison operator for the system parameter $filter.

Equals

Equals

Field value

Default Value:
Example:

Any

Enter the values of specified input $filter fields. The data type of this field depends on what Field name you selected or entered which can be String, Integer, Boolean, etc.

N/A

test123

Condition

Default Value:
Example:

String

Specify the logical operator for the system parameter $filter.

Or

Or

Output field selection

Default Value:
Example:

String

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

N/A

userId, country

Order by

Fieldset

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

The filed is only available if the query type is selected as 'Expand'.

N/A

N/A

Element

Default Value:
Example:

String

Specify the fields that will be displayed by descending or ascending order.

N/A

country

Order by type

Default Value:
Example:

String

Specify the Order Type (Ascending or Descending order).

Ascending

descending

Output fields advanced options

Default Value:
Example:

N/A

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

The filed is only available if the query type is selected as 'Expand'.

N/A

N/A

Output entry limit

Default Value:
Example:

Integer

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

N/A

10

Output entry    offset

Integer

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

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

Note that if the field “Automatic pagination” is selected, then the field “Output entry limit” should not be set or used. Either keep the field “Output entry limit”, or check the “Automatic pagination”. In case both are used, a validation exception will be thrown.

The filed is only available if the query type is selected as 'Expand'.

Deselected

N/A

Allow empty query result

Checkbox

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.

Selected

N/A

Refresh metadata

Checkbox

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.

Deselected

N/A

Pass through

Checkbox

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

Selected

N/A

Connection details

Configure the connection details.

Connection

timeout

Integer

Required. This property enables you to set the connection timeout duration of seconds

300

N/A

Number of

retries

Integer

Required. This property enables you to set the maximum number of re-connections if the connection is failed or timeout.

3

N/A

Retry interval

(seconds)

Integer

Required. This property enables you to set the interval in seconds between reconnections.

1

N/A

Snap Execution

Default Value: Validate & Execute
Example: Execute Only

Dropdown list

Controls whether or not a snap executes. 

N/A

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

key/value parameters must not be empty.

Please enter a valid value for key/value parameters.

The input entity does not exist.

An invalid entity has been entered.

Please click the suggestion dropdown button and select the entity.

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

"Output entry limit" cannot be implemented together with "Automatic pagination".

Please either select the "Automatic pagination" or fill the "Output entry limit" field

Empty result found.

There is no data coming back from the API call

Please enable the "Allow empty query result" checkbox.

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

The input key parameters entered for a specific entity is not existing in the system. 

Please check your input key parameters and change the key parameters to existing ones.