BMC Helix ITSM Work Order Activity¶

Introduction¶

A BMC Helix ITSM Work Order activity, using its BMC Helix ITSM connection, places work order data into BMC Helix ITSM, and is intended to be used as a target to consume data in an operation.

Create a BMC Helix ITSM Work Order Activity¶

An instance of a BMC Helix ITSM Work Order activity is created from a BMC Helix ITSM connection using its Work Order activity type.

To create an instance of a BMC Helix ITSM Work Order activity, drag the Work Order activity type to the design canvas or copy the Work Order activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing BMC Helix ITSM Work Order 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 BMC Helix ITSM Work Order Activity¶

Follow these steps to configure a BMC Helix ITSM Work Order activity:

• Step 1: Enter a Name and Specify Settings
• Step 2: Review the Data Schemas

Step 1: Enter a Name and Specify Settings¶

• Name: Enter a name to identify the BMC Helix ITSM Work Order activity. The name must be unique for each BMC Helix ITSM Work Order activity and must not contain forward slashes (/) or colons (:).

• Operation: Specify the operation to be used, one of Create Work Order, Update Work Order, Query Work Order, or Create Work Order Worklog.

• Continue on Error: Select to continue with the operation even if an error occurs. By default the option is not selected.

• 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 for BMC Helix ITSM are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

  The BMC Helix ITSM connector uses the BMC Helix ITSM/Remedy ITSM REST API v20.08. Refer to the API documentation for information on the schema fields.

  The connector supports these BMC Helix ITSM versions:

  • 9.1.04 (OnPremises)
  • 18.08 P1 (OnPremises)
  • 19.02 (OnPremises)
  • 19.08 (OnPremises)
  • 19.11 and later (OnPremises and SaaS)

  Adding an Attachment to an Activity

  The BMC Helix ITSM Connector provides the functionality of adding an attachment to your activity. To add an attachment to your activity:

  1. When using the activity in an operation, open the request transformation that precedes the activity.

  2. In the target schema, map the following fields for the attachment:

     • name (string): Enter the name of the file to be attached.

     • href (string): Enter the Base64-encoded content of the file. For converting the attachment content to Base64, see an online convertor or the Jitterbit Cryptographic Functions.

       

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the BMC Helix ITSM endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• 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 BMC Helix ITSM Work Order activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

BMC Helix ITSM Work Order activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-transformation Pattern (as the first or second target)

Other patterns are not valid using BMC Helix ITSM Work Order activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a BMC Helix ITSM Work Order activity in the Two-transformation Pattern. In this example, the first transformation (Work Order Request) creates a request structure that is passed to the BMC Helix ITSM Work Order activity. The second transformation (Work Order Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Work Order Response) and a message is then logged by the Write to Operation Log script:

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.