SuccessFactors Delete

On this page

Snap Type:

Write

Description:

This Snap provides the ability to remove 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 most 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: Employee Central (EC) – ApprenticeSchool or ApprenticeSchool

Default value: [None]

Key parameter:

Required. This property enables you to specify the key entities to a specific entity such as externalCode for the Employee Central (EC) - ApprenticeSchool entity.

Example: externalCode

Default value: [None]

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.

Warning: Please be aware that after the first run and new metadata have been refreshed, please deselect 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

Example

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

Configuring a SuccessFactors Delete Snap to delete a record via entity Employee Central (EC) - Jobprofile:

 

 

Implementing an example pipeline to delete a job profile via entity Employee Central (EC) - Jobprofile:

The following pipeline shows how you can use SuccessFactors Delete Snap to delete a job profile via Employee Central (EC) - Jobprofile API entity in the Success Factors data center. Firstly, the input JSON-formatted data which contains the job profile externalCode that will be deleted. Next, a Mapper Snap is applied in between of JSON Generator snap and SuccessFactors Delete Snap to map the data from JSON Generator snap to SuccessFactors Delete snap as the input for SuccessFactors Delete snap. Notice that the input document is not mandatory for this snap, you can also assign an external code directly to the Field value. 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

Snap Pack History

Initial Release (15/11/2019)

  • Introduced in this release

 

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