Overview

You can use this Snap to retrieve data objects from SuccessFactors Data Center. The Snap provides the ability to read the navigation property by expanding the navigation level. Learn more about SuccessFactors APIs: SuccessFactors Documentation.

Snap Type

SuccessFactors Read Advanced is Read-type Snap that

Prerequisites

Valid SuccessFactors Host server.
Valid User Id.
Valid Password.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations and Known Issues

None.

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps	Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

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.

Snap Settings

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.
Upload icon ( ): Indicates that you can upload files.

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.
Output field selection