Skip to Content

BMC Helix for CSP Query Activity

Introduction

A BMC Helix for CSP Query activity, using its BMC Helix for CSP connection, queries specified entity data (for a selected entity) in BMC Helix for CSP and is intended to be used as a source to provide data in an operation.

Note

The Query activity will return object data that is specified within its request schema. To retrieve all data from the selected object, use the Get activity.

Create a BMC Helix for CSP Query Activity

An instance of a BMC Helix for CSP Query activity is created from a BMC Helix for CSP connection using its Query 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 BMC Helix for CSP Query activity can be edited from these locations:

Configure a BMC Helix for CSP Query Activity

Follow these steps to configure a BMC Helix for CSP Query activity:

Step 1: Enter a Name and Select an Entity

In this step, provide a name for the activity and select an entity. Each user interface element of this step is described below.

BMC Helix for CSP Query Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each BMC Helix for CSP Query activity and must not contain forward slashes / or colons :.

  • Select an Object for the Resource: This section displays entity types available in the BMC Helix for CSP endpoint.

    • Selected Object: After an entity type is selected, it is listed here.

    • Search: Enter any part of the entity name into the search box to filter the list of entities. The search is not case-sensitive. If entities are already displayed within the table, the table results are filtered in real time with each keystroke. To reload entities from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload entities from the BMC Helix for CSP endpoint. This may be useful if entities have been added to BMC Helix for CSP. This action refreshes all metadata used to build the table of entities displayed in the configuration.

    • Selecting an Object for the Resource: Within the table, click anywhere on a row to select an entity. Only one entity can be selected. The information available for each entity is fetched from the BMC Helix for CSP endpoint:

      • Name: The entity class name from BMC Helix for CSP.

      • Description: The description of the entity class type from BMC Helix for CSP.

    Tip

    If the table does not populate with available entities, the BMC Helix for CSP connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • 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

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

BMC Helix for CSP Query Activity Configuration Step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The BMC Helix for CSP connector uses the BMC Helix for CSP REST API. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the BMC Helix for CSP endpoint. This action also regenerates a 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 for CSP Query 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 for CSP Query activities can be used as a source with these operation patterns:

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

BMC Helix for CSP Query 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.