SuccessFactors Delete

In this article

Overview

Use this Snap to remove a specific data object from the SuccessFactors Data Center. For more information about SuccessFactors APIs, see SuccessFactors Documentation.

Prerequisites

  • A valid SuccessFactors host server.
  • A valid account with the roles required to perform the Delete operation on the selected entity.

Supported Features

See Snap Support for Ultra Pipelines.

Limitations and Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • CSV Parser
  • JSON Parser

A document containing the key of the selected entity that must be deleted from the SuccessFactors Data Center.


Output

Document

  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • CSV Parser
  • JSON Parser

A document containing the status data to confirm whether the delete operation was successful or not.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 

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 select 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

Employee Central (EC) JobProfile or JobProfile

Key parameter

Fieldset


Required. Lets you specify the key fields to a specific entity such as userId for the Employee Central (EC) - JobProfile entity.

N/A

externalCode

Field nameStringRequired. The name of key parameter (reference parameter) field.N/AuserId
Field valueAnyRequired. The values 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/Atest_id

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. 

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

Deselected

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

Snap execution

Check box

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.

Execute only

N/A

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

Troubleshooting

ErrorReasonResolution

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

Remove Job Profile Data from SuccessFactors Data Center

This example illustrates how you can use SuccessFactors Delete Snap to delete a job profile via the Employee Central (EC) - Jobprofile API entity in the Success Factors Data Center. It assumes that you have configured and authorized a valid SuccessFactors Account (see SuccessFactors Basic Auth Account). 

In the sample Pipeline, the data to be deleted, the job profile externalCode, is provided as input data within the JSON Generator Snap.

 Next, a Mapper Snap is used to map the output from the JSON Generator Snap to the SuccessFactors Delete Snap as input.

An input document is not mandatory for this snap, you can also assign an external code directly to the field value.

The image below shows the data to be deleted under the Key parameter fieldset of the SuccessFactors Delete Snap.

A successful validation of the Snap generates the following output preview, with the status code of 200 confirming a successful deletion.

Finally, an XML Formatter Snap and a File Writer Snap is added downstream to format and save the returned data in a new file.  In the image below, the output is written to the SuccessFactors_Delete_JobProfile.xml file.  

You can view the newly-created file in the target directory using SSH.

Download this Pipeline. 

Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Furnish Pipeline parameters as applicable.

  File Modified

File SuccessFactors_1.0.0_Delete_JobProfile_Example.slp

Apr 23, 2020 by Ritu Sachdeva

Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

February 2024main168 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main155 

Stable

Updated and certified against the current SnapLogic Platform release.

August 2023main150 LatestFixed an issue with the OAuth 2.0 account that was causing it to reload.
August 2023main138 

Stable

Updated and certified against the current SnapLogic Platform release.

May 2023main137 Latest

Introduced the SAP SuccessFactors Read Advanced Snap, which enables you to read objects recursively for objects containing links to traverse through the tree structure. 

May 2023

main130 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023main114 StableUpgraded with the latest SnapLogic Platform release.
November 2022main113 StableUpgraded with the latest SnapLogic Platform release.
August 2022

main111

 StableUpgraded with the latest SnapLogic Platform release.
4.29main108 

Stable

Upgraded with the latest SnapLogic Platform release.
4.28main100 StableAdded a new account type SuccessFactors OAuth2 that enables OAuth2 authentication for all the SuccessFactors Snaps.
4.27main12283  StableUpgraded with the latest SnapLogic Platform release.
4.26main88 StableUpgraded with the latest SnapLogic Platform release.
4.25main73
 
StableNo updates made.
4.24main73
StableNo updates made.
4.23main73 StableNo updates made.
4.22main6403
 
Stable[Docs Update] Adds a use case to automate asset management by integrating SAP SuccessFactors with ServiceNow.
4.21snapsmrc542 StableNo updates made.

4.20

snapsmrc535


Stable

Initial release (September 2019).


See Also