ServiceMax Delete Activity¶
A ServiceMax Delete activity deletes data in a ServiceMax endpoint and is intended to be used as a target to consume data in an operation. After configuring a ServiceMax connection, you can configure as many ServiceMax activities as you like for each ServiceMax connection.
During the processing of records for an Upsert activity, if any record fails, no additional changes are processed and all previously processed changes are rolled back. If you want processing to continue when one record fails, consider using a ServiceMax Bulk Delete or Bulk Hard Delete activity.
Create a ServiceMax 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 ServiceMax Delete Activity¶
Follow these steps to configure a ServiceMax 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 ServiceMax Delete activity. The name must be unique for each ServiceMax 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 ServiceMax record ID(s). Later, during the transformation mapping process, you can map to the
idson the target side in order to provide the ServiceMax 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 ServiceMax Delete activity, you can use it within an operation as described below. After running an operation containing a ServiceMax activity on a Private Agent, you can download the operation's success and failure files.
Complete the Operation¶
After configuring a ServiceMax 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 ServiceMax 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.
ServiceMax 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 ServiceMax 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 ServiceMax 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 ServiceMax activity to use elsewhere (see Component Reuse).
Other patterns are not valid using ServiceMax Delete activities. See the validation patterns on the Operation Validity page.
To use a ServiceMax Delete activity, you provide the ServiceMax ID(s) for the record(s) you want to delete during the transformation mapping process. A typical use case is to find the records you want to delete by first setting up a ServiceMax Query activity, get the IDs back from the query, and then use those IDs as the source for the delete activity.
In this example, the first operation Get ServiceMax IDs uses a ServiceMax Query activity in a Transformation Pattern. The ServiceMax Query activity (Query IDs Request) provides data within the operation, which is then received by the transformation (Query IDs to Variable). The Variable Write activity (Write Query Response) is used as the target, receiving data within the operation.
On success of the operation Get ServiceMax IDs, the operation ServiceMax Delete runs. A ServiceMax Delete Activity is used in a Two-transformation Pattern. The Variable Read activity (Read IDs Request) uses the data gathered from the first operation to provide the data within the second operation. The first transformation (Variable to SM Delete) creates a request structure that is passed to the ServiceMax Delete activity (Delete). The second transformation (Delete to Variable) receives the response structure, which is then written to a variable by a Variable Write activity (Write Response):
Within a transformation, if using the option to mirror a schema provided by a non-bulk ServiceMax 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 ServiceMax 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.
View Success and Failure Files¶
If you are running an operation containing a ServiceMax activity on a Private Agent, success and failure files are available for download in the Activities page of the Management Console. Select the relevant operation in the Activities table and click the Activity Logs tab in the bottom section of the screen to display download links for the files if available:
Download Success File: If you are running the operation on a Private Agent, click the Download link to save the success records as a CSV file.
Download Failure File: If you are running the operation on a Private Agent, click the Download link to save the failure records as a CSV file.
By default, success and failure files are automatically deleted from the Private Agent after 14 days by the Jitterbit File Cleanup Service. The number of days the files are saved can be changed by editing the
[ResultFiles] section in the
jitterbit.conf file. You can also change the success and failure file retention rules by editing the Jitterbit File Cleanup Service Rules for Private Agents.
Activity log downloads are disabled for Cloud Agents. If the links are visible, you will receive an error message if you attempt a download.