SuccessFactors Update

SuccessFactors Update

In this article

Overview

Use this Snap to update data in the SuccessFactors Data Center. For more information about SuccessFactors APIs, refer to SuccessFactors Documentation.

Prerequisites

  • A valid SuccessFactors host server.

  • A valid account with the roles required to perform the Update operation on the selected entity.

Supported Features

See Snap Support for Ultra Pipelines.

Limitations and Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 1

  • Max: 1

  • Mapper

  • Copy

  • CSV Parser

  • JSON Parser

A document containing data that must be updated and written into the SuccessFactors Data Center for the selected entity.

Output

Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

  • CSV Parser

  • JSON Parser

A document containing data that confirms whether the update was successful or not. 

Snap Settings

Parameter Name

Data Type

Description

Default Value

Example 

Parameter Name

Data Type

Description

Default Value

Example 

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 define an entity (business object) of 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 the 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

 

Required. Lets you specify the key fields for a specific entity such as userId for the Foundation/Platform (PLT) – User entity.

N/A

userId

Field name

String

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

N/A

userId

Field value

Any

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

Updating method

String

Required. Lets you specify if a Replace or Merge method should be used while performing the update operation.

Replace enables you to replace the existing (matching) data in an entity. All the property values in the 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 enables you to update only the properties provided in the request body and the data not mentioned in the request body remain as is.

Replace

Replace

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. 

  • Refreshing the metadata is a costly operation, and this field must be selected only if the metadata has changed.

  • After the first run and after the metadata has been refreshed, please deselect this checkbox.

Not selected

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

Check box

Execute only

N/A

For more information about the OData based API, see OData Version 4.0 Documentation.

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

The input entity does not exist.

An invalid entity has been entered.

Click the suggestion drop-down in the Entity field and select the entity.

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

key/value parameters must not be empty.

Enter a valid value for key/value parameters.

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

The input key parameters entered for a specific entity do not exist in the system. 

Specify key parameters that exist in the system. 

Examples

Update User Data in SuccessFactors Data Center