Salesforce Delete Activity¶
A Salesforce Delete activity deletes data in a Salesforce endpoint and is intended to be used as a target to consume data in an operation. After configuring a Salesforce connection, you can configure as many Salesforce activities as you like for each Salesforce connection.
Create a Salesforce Activity¶
An instance of an activity is created from a connection using an activity type.
To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.
An existing activity can be edited from these locations:
- The design canvas (see Component Actions Menu in Design Canvas).
- The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
Configure a Salesforce Delete Activity¶
Follow these steps to configure a Salesforce Delete activity:
- Step 1: Enter a Name Provide a name for the activity.
- Step 2: Review the Data Schemas Any request or response schemas generated from the endpoint are displayed.
Step 1: Enter a Name¶
In this step, you provide a name for the activity.
- Name: Enter a name to use to identify the Salesforce Delete activity. The name must be unique for each Salesforce Delete activity and must not contain forward slashes (
/) or colons (
- Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
- Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
- Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 2: Review the Data Schemas¶
In this step, any request or response schemas generated from the endpoint are displayed:
Data Schema: The request and response data schemas are displayed. Within the node
idson the request side of the structure is a text value as represented by a field, which is intended to be used to provide the Salesforce record ID(s). Later, during the transformation mapping process, you can map to the
idson the target side in order to provide the Salesforce record ID(s) to delete.
The version of Salesforce REST API that is used depends on the Harmony Agent version you are using. See Prerequisites and Supported API Versions for links to documentation on the schema fields.
To refresh a data schema in an existing activity, you must advance through each activity configuration step again, making at least one change (such as adding and removing a character from the end of the name of the activity) to force a refresh of the schema.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Finished: Click to save the configuration for all steps and close the activity configuration.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
After configuring a Salesforce Delete activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.
Once a Salesforce Delete activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.
Salesforce Delete activities can be used as a target with these operation patterns:
- Transformation Pattern
- Two-target Archive Pattern (as the first target only)
- Two-transformation Pattern (as either the first or second target)
Operations that contain a Salesforce activity can have only one Salesforce activity and cannot also contain any other activities except for those associated with the API, Database, File Share, FTP, HTTP, Local Storage, Temporary Storage, or Variable connectors.
A Salesforce activity can be used as an operation step in only a single operation. That is, you cannot reference the same activity multiple times within other operations. Instead, you can make a copy of a Salesforce activity to use elsewhere (see Component Reuse).
Other patterns are not valid using Salesforce Delete activities. See the validation patterns on the Operation Validity page.
A typical use case is to use a Salesforce Delete activity in the Two-transformation Pattern. In this example, the first transformation (Delete Request) creates a request structure that is passed to the Salesforce Delete activity (Delete). The second transformation (Delete Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Delete Response) and a message is then logged by the Write to Operation Log script:
Within a transformation, if using the option to mirror a schema provided by a non-bulk Salesforce activity, then the resulting mirrored schema will automatically be created with an additional root node called
records with the child node(s) mirroring the schema. When fields within the child node(s) are mapped to, the node becomes a loop node to allow all records to be looped through (see Loop Nodes under Data Structures).
Operations that use Salesforce activities can also have operation actions configured to trigger on a SOAP fault — an error resulting from an incorrect message format, header processing, or incompatibility. Operation actions can be configured to run an operation or send an email after a SOAP fault occurs. For instructions on triggering an action on SOAP fault, refer to Operation Actions.
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the operation logs.