Skip to end of metadata
Go to start of metadata

Introduction

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.

Creating a ServiceMax Activity

From the design canvas, open the Connectivity tab of the design component palette:

Use the Show dropdown to filter on Endpoints, and then click the ServiceMax connection block to display activities that are available to be used with a ServiceMax connection:

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Configuring a ServiceMax Delete Activity

Follow these steps to configure a ServiceMax Delete activity:

Step 1: Enter a Name

  • 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

  • Data Schema: The request and response data schemas are displayed. Within the node ids on 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 ids on 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.

    NOTE: 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.

Next Steps

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.

After 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:

Operations that contain a ServiceMax activity can have only one ServiceMax activity and cannot also contain any other application activities.

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 common way to find the records you want to delete is to first set up a ServiceMax Query activity, get the IDs back from the query, and then use those IDs as the source for the delete activity. This example setup depicts one common operation setup using a ServiceMax Delete activity:

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.

On This Page

Last updated:  Jan 20, 2021

  • No labels