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 field to specify or change the component's name, which must be unique in the application. 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: A field that shows the fully qualified class name that implements the functionality of this operator. Use this class name when loading the operator in StreamSQL programs with the APPLY JAVA statement. You can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start with application: If this field is set to Yes or to a module parameter that evaluates to true, an instance of this operator starts as part of the containing StreamBase Server. If this field is set to No or to a module parameter that evaluates to false, the adapter is loaded with the server, but does not start until you send an sbadmin resume command, or until you start the component with StreamBase Manager. With this option set to No or false, the operator does not start even if the application as a whole is suspended and later resumed. The recommended setting is selected by default.

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 and Error Streams to learn about Error Ports.

Description: Optionally enter text to briefly describe the component's purpose and function. In the EventFlow 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 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.