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

Field Dependency

Description

Label*

Default Value: SuccessFactors Read Advanced
Example: SuccessFactors Read Advanced

String

N/A

Specify 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*

Default Value: N/A
Example: Foundation/Platform (PLT) – User or User

String/Expression

N/A

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

Query Type

Default Value: N/A
Example:

Dropdown list

N/A

Specify the query type. Available options include:

• Expand

• Custom Query

Expand Level

Default Value: 0
Example: 1

Dropdown list

The field is only available if the Query Type is selected as Expand.

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

Available options include:

• 0

• 1

• 2

Query

Default Value: N/A
Example:

String

The field is only available if the Query Type is selected as Custom Query.

Specify the custom query. 

Key parameter

Use this fieldset to specify the key fields to a specific entity such as userId for the Foundation/Platform (PLT) – User entity.

Field name

Default Value: N/A
Example:

String

N/A

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

Field value

Default Value: N/A
Example:

Any

N/A

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.

URL parameters

Use this fieldset to specify the names and values of the URL parameters.

This fieldset is only available if the Query Type is selected as Expand.

Parameter name

Default Value: fromDate
Example: fromDate

String

N/A

Specify the names of the URL parameters.

Parameter value

Default Value: N/A
Example: 2020-01-01

Any

N/A

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.

Filter records

Use this fieldset to filter the results from the API response based on the customer-selected fields.

The field is only available if the Query Type is selected as Expand.

Field name

Default Value: N/A
Example: userId

String/Expression/Suggestion

N/A

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

Operation

Default Value:
Example: Equals

Dropdown list

N/A

Specify the comparison operator for the system parameter $filter. Available options include:

Field value

Default Value: N/A
Example: test123

String/Expression

N/A

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.

Condition

Default Value:
Example: Or

Dropdown list

N/A

Specify the logical operator for the system parameter $filter. Available options include:

Output field selection

Use this fieldset to select fields to be included in the output. If not selected, all fields will be returned.

Element

Default Value: N/A
Example: userId, country

String/Expression/Suggestion

N/A

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

Order by

Use this fieldset to order the resulting records based on specified elements. The order types to be selected are either ascending or descending.

The field is only available if the Query Type is selected as Expand.

Order by type

Default Value: ascending
Example: descending

String

N/A

Specify the Order Type (Ascending or Descending order).

Output fields advanced options

The field is only available if the Query Type is selected as Expand.

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

Output entry limit

Default Value: N/A
Example: 10

Integer

N/A

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

Output entry offset

Default Value: N/A
Example: 10

Integer

N/A

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

Automatic pagination

Default Value: Deselected

Checkbox

The field is only available if the Query Type is selected as Expand.

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

Allow empty query result

Default Value: Selected

Checkbox

N/A

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.

Refresh metadata

Default Value: Deselected

Checkbox

N/A

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.

Pass through

Default Value: Selected

Checkbox

N/A

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

Connection details

Configure the connection details.

Connection timeout*

Default Value: 300
Example: 100

Integer

N/A

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

Number of retries*

Default Value: 3
Example: 2

Integer

N/A

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

Retry interval (seconds)*

Default Value: 1
Example: 3

Integer

N/A

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

Snap Execution

Default Value: Validate & Execute
Example: Execute Only

Dropdown list

N/A

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.

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. 

SuccessFactors Read Advanced Snap Configuration

Output