BMC Helix Business Workflows Search Cases activity

Introduction

A BMC Helix Business Workflows Search Cases activity, using its BMC Helix Business Workflows connection, searches for and retrieves cases at BMC Helix Business Workflows and is intended to be used as a source to provide data in an operation.

Create a BMC Helix Business Workflows Search Cases activity

An instance of a BMC Helix Business Workflows Search Cases activity is created from a BMC Helix Business Workflows connection using its Search Cases 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 Business Workflows Search Cases 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 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
  Provide a name for the activity and specify the priority, status, search parameters, and optional settings.

• Step 2: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the priority, status, search parameters, and optional settings. Each user interface element of this step is described below.

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

• Priority: Enter a priority such as Critical, High, Medium, Low, etc.

• Status: Enter a status such as New, Pending, In Progress, Assigned, etc.

• Search Parameters: Add additional search parameters using name-value pairs.

• Optional Settings: Click to expand additional optional settings:

  • Page Size: Default value: 200.
  • Maximum Number of Records to Be Processed (If Empty, Will Fetch All Records): Default value: 500.

  • Search Parameters (In JSON Format): Enter the search parameters in JSON format.

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

    Note

    This JSON input takes higher precedence than the Priority, Status, or Search Parameters fields.

• 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 are displayed. Each user interface element of this step is described below.

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

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  Refer to the BMC documentation for information on the schema nodes and fields.

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the BMC Helix Business Workflows 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 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 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 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-target HTTP archive pattern (as the first source only)
• Two-transformation pattern (as the first or second source)

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.