Defining queue operations

An operation is a function within a step processor that performs a specific task. In Process Configuration Console, you can associate an operation with a queue.

About this task

Before you can associate an operation with a queue, you need the following details from the developer of each step processor that will use the operation:

  • The name of the operation
  • The name of each parameter that the operation expects, and an optional description
  • The data type of each parameter
  • How the data for each parameter passes between the operation and the work item

When defining an operation and its parameters, the workflow author, workflow administrator, and application developer typically work together to determine its names and usage. A step processor must use the operation name when referencing the operation. In addition, the properties you enter for each parameter must correspond to the properties expected by a step processor that is processing work items in the selected queue.

Tip: In general, operations are defined on queues for work items that are processed by automated programs. Though less common, operations can also be defined on queues from which participants process work items, including user inboxes.

Procedure

To add an operation:

  1. If the Properties window is not already displayed, select the icon of the queue you want to modify and click Properties on the toolbar.
  2. Click the Operations tab.
  3. In the first available line in the Name box, enter the name of the operation. The name must conform to standard workflow system naming conventions.
    Tip: To copy from an existing operation, select the operation and click Copy.
  4. Optionally, enter an Operation Description for the highlighted operation.
  5. Add the parameters required by the operation.
    1. On the Operations tab, select the operation whose parameters you want to change.
    2. To add a parameter, enter the following information in the Parameters box:
      • Name: The name must conform to standard workflow system naming conventions.
      • Type: Select the data type of the parameter from the list.
      • Access: Select the direction of the data passing between the operation and the work item:
        • Read: A data value that passes from the work item to the operation.
        • Write: A data value that is generated by the operation and then passed to the work item.
        • Read/Write: A data value that passes from the work item to the operation, where it is processed and then passed back to the work item.
      • Description: Enter an optional description.
    3. To remove a parameter, click Delete.
      Important: Use caution when deleting parameters from and re-transferring an operation that already exists in the workflow database. If no work items have entered queue on which the operation is defined, you can safely delete operation parameters. However, if any work items have entered the queue and you subsequently delete an operation parameter, the commit action will fail.
    4. Click OK when done.
    5. Click Commit Changes on the toolbar to apply this change to your isolated region.
  6. Click OK when done.
  7. Click Commit Changes on the toolbar to apply this change to your isolated region.
    Note: You cannot delete an operation once it has been committed.