BAM Utility (Magic xpi 4.13)
The BAM (Business Activity Monitoring) utility lets you define and configure the messages sent by the server that are related to business processes. BAM messages monitor the essential business processes and provide messages and alerts about them. This section describes how to add the BAM utility to your flow and how to define the messages that are returned.
To add the BAM utility to a flow:
-
Drag the BAM utility from the Toolbox pane to your flow.
-
In the Properties pane, enter the information as described in the table below:
|
|
|
|
General
|
|
Step Name
|
Type a name that describes the utility in the flow.
|
|
Description
|
Type a description of the utility in your flow (optional).
|
|
Step ID
|
A read-only field displaying the ID of the step in the flow.
|
|
Component ID
|
An internal identifier number generated automatically.
|
|
Component Type
|
A read-only field displaying the name of the step type.
|
|
Condition
|
Enter a condition to specify the flow's execution behavior. You can either click  to open the Expression Editor, or you can right-click on the component and select Condition from the context menu.
|
|
Processing mode
|
Select whether the step should be executed linear, parallel or stand-alone.
|
|
This is available only if the BAM utility is not the first step in a flow.
|
|
|
Wait for completion
|
Select whether the step should be run in Wait for Completion mode. The options are Yes or No.
|
|
This is available only when the BAM utility is a Linear step and if it is not the first step in the flow.
|
|
|
Advanced
|
|
Save point
|
Select Yes to indicate that the step is a Save Point in your flow.
|
|
Call logic flow
|
You can use this option if you want to call generic logic after the execution of a specific step. Once this step has been executed, the flow logic that you defined in the flow properties is called before the Server continues to the following steps.
The options are Yes or No (default).
|
-
Double-click or right-click on the BAM utility and select Configuration from the context menu to open the BAM Configuration dialog box. This dialog box has the following fields:
|
|
|
|
Message
|
The message text that is displayed when monitoring the flow. You can type the message or click  to the right of the Message field to open the Expression Editor and create a message.
|
|
BLOB
|
The BLOB file that contains the message. You can use the Expression Editor to select a BLOB file by clicking to the right of the BLOB field.
|
|
Extension
|
The file extension for the message file.
|
|
Category
|
Type or use the Expression Editor to define a category for your BAM messages.
|
|
Priority
|
Enter a numeric priority for the message. You can click to the right of the Priority field to open the Expression Editor to define priorities for your BAM message.
|
|
The maximum expression results length is 12 digits.
|
|
|
Status
|
Define the status returned for the BAM messages. You can click to the right of the Status field to open the Expression Editor to define statuses for your BAM message.
|
|
The maximum expression results length is 12 digits.
|
|
|
User key 1
User key 2
|
Create up to two user keys. You can click to the right of the User Key field to open the Expression Editor to define the user keys for your BAM messages.
|
-
Click OK to close the BAM Configuration dialog box. The BAM utility is displayed in the flow.
