SuccessFactors Update

On this page

Snap Type

Write

Description

This Snap provides the ability to update data objects from SuccessFactors Data Center server to a selected item.

Prerequisites

None

Support and limitations

Ultra pipelines: Works in Ultra Pipelines.

Spark mode: Not supported in Spark mode.

Account

This Snap uses account references created on the Accounts page of SnapLogic Manager to access to the endpoint. See SuccessFactors Account for information on setting up this type of account.

Views

Input
This Snap has at least one document input view.

Output
This snap has at most one document output view.

Error
This Snap has one optional error view and might produce documents in the view if the input data causes an error in the REST API.

Settings

Label

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.

Entity:

Required. This property enables you to define an entity of the API. 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.

Example: Foundation/Platform (PLT) – User or User

Default value: [None]

Key parameter:

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

 

Example: userId

Default value: [None]

Updating method:

Required. This property enables you to specify if the Replace or Merge updating approach is implemented.

Replace method enables you to replace the existing(matching) data in an entity, so all the property values in this entity either take the values provided in the request body or are reset to their default value if no data is provided in the request.

Merge method enables you to only update the properties provided in the request body and the data not mentioned in the request body will remain as such.

 

Default value: [Replace]

Refresh metadata:

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.

 

Default value: Not selected

Pass through:

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.

 

Default value: Not selected

Execute during preview:

This property enables you to execute the Snap during the Save operation so that the output view can produce the preview data.

 

Default value: Not selected

Updating method

Success Factors Snap supports two ways of updating – Replace and Merge.
By Replace method, the existing data in an entity will be replaced, so all the property values in this entity either take the values provided in the request body or are reset to their default value if no data is provided in the request. By Merge method, only the properties provided in the request body will be updated and the data not mentioned in the request body will be kept in current status [1]

Example

The example assumes that you have configured & authorized a valid SuccessFactors Account (see SuccessFactors Account).

Configuring a SuccessFactors Create Snap to update the information of a user via entity Foundation/Platform (PLT) - User:

 

 

 

 

Implementing an example pipeline to update the information of a user via entity Foundation/Platform (PLT) - User:

The following pipeline shows how you can use SuccessFactors Update Snap to update data for a user via Foundation/Platform (PLT) - User API entity in the Success Factors data center. Firstly, the input json-formatted data which is the new data that will be updated of a user is generated by the JSON Generator Snap. Next, a Mapper Snap is applied in between of JSON Generator snap and SuccessFactors Update Snap to map the data from JSON Generator snap to SuccessFactors Update snap as the input for SuccessFactors Update snap. The input schema is provided by SuccessFactors Update Snap. The updating method here is defined as Merge. Additionally, a JSON Formatter snap and a File Writer snap are applied to format and record data in a new file.

 

A successful validation or execution of the Snap gives the following output preview showing the query results:

 

Downloads

  File Modified

File SuccessFactors_1.0.0_Update_User_TC7_UpdateUser.slp

Nov 06, 2019 by Rojo Publisher

History

Introduced in this release (15/11/2019)

  • Introduced in this release

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Have feedback? Email helpdesk@rojoconsultancy.com © Rojo Consultancy