Using the TIBCO ActiveMatrix BPM Operator

The ActiveMatrix BPM operator is a member of the Java Operator group in the Palette view in StreamBase Studio. Select the operators from the Insert an Operator or Adapter dialog. Invoke the dialog with one of the following methods:

From the Insert an Operator or Adapter dialog, select the following related operator and double-click or press OK:

Name: Use this required field to specify or change the name of this instance of this component, which must be unique in the current EventFlow module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.

Operator: A read-only field that shows the formal name of the operator.

Class name: Shows the fully qualified class name that implements the functionality of this operator. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this operator starts.

Enable Error Output Port: Select this check box to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally enter text to briefly describe the component's purpose and function. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

For general instructions on using the Edit Schema tab, see the Properties: Edit Schema Tab section of the Defining Input Streams page.

Use this tab to specify the schema to use when receiving results from the REST API call. Characters in field names from AciveMatrix BPM that would be subject to the StreamBase escaped identifier rules such as "@" and "-" are automatically removed. If the result is wrapped in an xml-fragment object, that is also automatically removed. Specify your schema starting with the first underlying data set.

For Example:  

{
  "xml-fragment": {
    "start-Position": 0,
    "end-Position": 2,
    "total-Items": 2,
    "businessCategory": [
      {
        "@name": "WelcomeUsersImplementSolution",
        "ChildBusinessCategory": {
          "@name": "ProcessPackage",
          "BusinessServiceTemplate": {
            "@moduleName": 
              "/WelcomeUsersImplementSolution/Process Packages/ProcessPackage.xpdl",
            "@version": "1.0.0.201301021250",
            "@processName": "RequestCall",
            "@hasFormalParameters": "false"
          }
        }
      }
    ]
  }
}

Converts to the following before matching the schema:

{
  "startPosition": 0,
  "endPosition": 2,
  "totalItems": 2,
  "businessCategory": [
    {
      "name": "WelcomeUsersImplementSolution",
      "ChildBusinessCategory": {
        "name": "ProcessPackage",
        "BusinessServiceTemplate": {
          "moduleName": 
            "/WelcomeUsersImplementSolution/Process Packages/ProcessPackage.xpdl",
          "version": "1.0.0.201301021250",
          "processName": "RequestCall",
          "hasFormalParameters": "false"
        }
      }
    }
  ]
}

Use the settings in this tab to allow this operator or adapter to start and stop based on conditions that occur at runtime in a cluster with more than one node. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with TIBCO Streaming releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.

Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.

Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.