View Jitterbit Developer Portal
- Created by John Jackson, last modified on Sep 01, 2020
Introduction
A BMC Helix ITSM Delete activity deletes a BMC form at a BMC Helix ITSM endpoint and is intended to be used as a target to consume data in an operation. After configuring a BMC Helix ITSM connection, you can configure as many BMC Helix ITSM activities as you like for each BMC Helix ITSM connection.
NOTE: BMC Helix ITSM does not support deletion on the main ticketing forms. The connector does not filter as to which forms can and cannot be deleted.
Creating a BMC Helix ITSM 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 BMC Helix ITSM connection block to display activities that are available to be used with a BMC Helix ITSM 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 BMC Helix ITSM Delete Activity
Follow these steps to configure a BMC Helix ITSM Delete activity:
Step 1: Enter a Name, Select a Form, and Specify Settings
TIP: Fields with a variable icon support using
global variables,
project variables, and
Jitterbit variables. Begin either by typing an open
square bracket
[
into the field or by clicking the variable icon to display a list of the existing variables to
choose from.
-
Name: Enter a name to use to identify the BMC Helix ITSM Delete activity. The name must be unique for each BMC Helix ITSM Delete activity and must not contain forward slashes (
/
) or colons (:
). -
Select a Form: This section displays forms available in the BMC Helix ITSM endpoint. When reopening an existing activity configuration, only the selected form is displayed instead of reloading the entire form list.
-
Selected Form: After a form is selected, it is listed here.
-
Search: Enter any part of the form name into the search box to filter the list of forms. The search is not case-sensitive. If forms are already displayed within the table, the table results are filtered in real time with each keystroke. To reload forms from the endpoint when searching, enter search criteria and then refresh, as described below.
-
Refresh: Click the refresh icon
or the word Refresh to reload forms from the BMC Helix ITSM endpoint. This may be useful if you have recently added forms to BMC Helix ITSM. This action refreshes all metadata used to build the table of forms displayed in the configuration.
-
Selecting a Form: Within the table, click anywhere on a row to select a form. Only one form can be selected. The information available for each form is fetched from the BMC Helix ITSM endpoint:
-
Name: The form name from BMC Helix ITSM.
-
Description: The form description from BMC Helix ITSM.
-
TIP: If the table does not populate with available forms, the BMC Helix ITSM connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
-
-
Form Name: Name of the form to be created.
-
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: Specify Settings
-
Continue on Error: Select to continue inserting records when there is an error with a particular batch of records.
-
Back: Click to temporarily store the configuration for this step and return to the previous step.
-
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 3: 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.
-
Refresh: Click the refresh icon
or the word Refresh to regenerate schemas from the 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 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 BMC Helix ITSM 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.
BMC Helix ITSM Delete 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 Delete activities. See the validation patterns on the Operation Validity page.
A typical use case is to use a BMC Helix ITSM Delete activity in the Two-Transformation Pattern. In this example, the first transformation (Delete Request) creates a request structure that is passed to the BMC Helix ITSM Delete activity. 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:
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.
- BMC Helix ITSM Change Management Activity
- BMC Helix ITSM Connection
- BMC Helix ITSM Create Activity
- BMC Helix ITSM Incident Management Activity
- BMC Helix ITSM Known Error Activity
- BMC Helix ITSM Merge Activity
- BMC Helix ITSM Problem Management Activity
- BMC Helix ITSM Update Activity
- BMC Helix ITSM Query Activity
- BMC Helix ITSM Work Order Activity
- Component Dependencies, Deletion, and Removal
- Component Deployment
- Component Palette
- Design Canvas
- Operation Creation and Configuration
- Operation Options
- Operation Validity
- Plugins Added to an Activity
- Project Pane
- Transformation Creation and Configuration
Last updated: Sep 01, 2020
- No labels