In this article
...
- A valid SuccessFactors host server.
- A valid User ID and password.The required roles are assigned to the user to account with the roles required to perform the Delete operation on the selected entity.
...
- Works in Ultra Pipelines.
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 | Document |
|
| A document containing the data that need to be retrieved. |
| Output | Document |
|
| A document containing the data retrieved from the target table. |
...
| 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 of the API. The values in the suggestion drop-down are displayed dynamically from different users’ accounts. You can either choose an entity from the suggestion drop-down or type an entity manually. The entity is shown as | N/A | Employee Central (EC) – JobProfile or JobProfile | ||||||||||||||||
Key parameter | Fieldset | Required.This property enables you to specify the key fields to a specific entity such as userId for the Employee Central (EC) - JobProfile entity. | N/A | externalCode | ||||||||||||||||
| Field name | ||||||||||||||||||||
| Field value | ||||||||||||||||||||
Refresh metadata | CheckboxCheck 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.
| Deselected | N/A | ||||||||||||||||
Pass through | CheckboxCheck 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 ' | Selected | N/A | ||||||||||||||||
If selected, the Snap performs a limited execution (up to 50 records) during Pipeline validation and a full execution (all records) during Pipeline execution.
| Execute during preview | Checkbox |
| Check box |
| Execute only | N/A |
For more information about the OData based API, see OData Version 4.0 documentationDocumentation.
Troubleshooting
| 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
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.
| Info |
|---|
An input document is not mandatory for this snap, you can also assign an external code directly to the Field field value. |
The configuration image below shows the data to be deleted under the Key parameter fieldset of the SuccessFactors Delete Snap is shown below.
A successful validation or execution of the Snap Pipeline gives the following output preview, showing the results.
Finally, an XML Formatter Snap and a File Writer Snap is applied to format and save the returned data in a new file. The configuration of the File Writer Snap is shown below 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.
Downloads
| Note | ||
|---|---|---|
| ||
|
...