BMC Helix Business Workflows Search Cases Activity

Introduction

A BMC Helix Business Workflows Search Cases activity finds cases based on defined criteria at a BMC Helix Business Workflows endpoint and is intended to be used as a source to provide data to an operation. After configuring a BMC Helix Business Workflows connection, you can configure multiple BMC Helix Business Workflows activities for each BMC Helix Business Workflows connection.

Creating a BMC Helix Business Workflows 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 Business Workflows connection block to display activities that are available to be used with a BMC Helix Business Workflows 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 Business Workflows Search Cases Activity

Follow these steps to configure a BMC Helix Business Workflows Search Cases 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 use to identify the BMC Helix Business Workflows Search Cases activity. The name must be unique for each BMC Helix Business Workflows Search Cases activity and must not contain forward slashes (/) or colons (:).

• Priority: Such as Critical, High, Medium, Low, etc.

• Status: Such as New, Pending, In Progress, Assigned, etc.

• Search Parameters: None.

• Optional Settings: Click to expand additional optional settings:

  • Page Size: Default value: 10.

  • Maximum number of records to be processed (If empty, will fetch all records): Default value: 500.

  • Search Parameters (in JSON Format): [Note: This JSON input takes higher precedence than the Priority, Status, or Search parameters.]

    {
          "Priority": "Critical",
          "Ticket Status": "Assigned"
        }
    

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to continue to the next step and temporarily store the configuration. The configuration is not 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 Business Workflows 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.

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

After a BMC Helix Business Workflows 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 Business Workflows Search Cases activities can be used as a source with these operation patterns:

• Transformation Pattern
• Two-Target Archive Pattern (as the first source only)
• Two-Transformation Pattern (as the first or second source)

Other patterns are not valid using BMC Helix Business Workflows Search Cases activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a BMC Helix Business Workflows Search Cases activity in the Two-Transformation Pattern. In this example, the first transformation (BMC Helix Business Workflows Search Cases Request) creates a request structure that is passed to the BMC Helix Business Workflows Search Cases activity. The second transformation (BMC Helix Business Workflows Search Cases Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write BMC Helix Business Workflows Search Cases Response). 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.