Skip to end of metadata
Go to start of metadata

Introduction

A BMC Helix Operations Management (BMC Helix Operations Management) Deregister Webhook activity places an object into a BMC Helix Operations Management endpoint and is intended to be used as a target to consume data in an operation. After configuring a BMC Helix Operations Management connection, you can configure as many BMC Helix Operations Management activities as you like for each BMC Helix Operations Management connection.

Creating a BMC Helix Operations Management Activity

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

Connectivity tab

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

BMC Helix Operations Management activities

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 Operations Management Deregister Webhook Activity

Follow these steps to configure a BMC Helix Operations Management Deregister Webhook activity:

Step 1: Enter a Name and Specify Settings

BMC Helix Operations Management Deregister Webhook Activity Configuration Step 1

  • Name: Enter a name to use to identify the BMC Helix Operations Management Deregister Webhook activity. The name must be unique for each BMC Helix Operations Management Deregister Webhook activity and must not contain forward slashes (/) or colons (:).

  • Webhook Name: Enter the name of the webhook API which has to be deregistered.

  • 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

BMC Helix Operations Management Deregister Webhook Activity Configuration Step 2

  • Data Schema: The request and response data schemas for BMC Helix Operations Management 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 Operations Management connector uses the BMC Helix Operations Management REST API. Refer to the API documentation for information on the schema fields.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the BMC Helix Operations Management 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 Operations Management Deregister Webhook 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 Operations Management 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 Operations Management Deregister Webhook activities can be used as a target with these operation patterns:

Other patterns are not valid using BMC Helix Operations Management Deregister Webhook activities. See the validation patterns on the Operation Validity page.

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

BMC Helix Operations Management Deregister Webhook
operation

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:  Nov 05, 2020

  • No labels