Monitoring data and configuration
Monitoring overview
The TIBCO EBX® Activity Monitoring Add-on data space is located under the EBX® 'Administration' tab.
The 'Activity monitoring' table collects all the data related to the execution of operations.
The 'Directory' domain is used to register the operations that you want to monitor.
The 'Archive' domain is used to make active the archiving process.
Activity monitoring
The 'Activity monitoring' table records all data collected by the monitor during communication with operations. Color coding applied to the 'Status' property is used to display it contextually depending on the operation execution status. By default, all data for the monitor is read-only.
Property | Definition |
|---|---|
Operation | The operation for which the log is recorded. |
Creation date | The date when the log record was created. |
Business ID | Any value can be provided by the operation. This identifier is used to group the monitoring records by business concept. For instance, if the 'Business ID' is the unique identifier of a customer, then it becomes possible to group all business activity for this customer in the 'Activity monitoring' table. |
State | The current state of the operation. The possible values (Started, Stopped and Suspended) are defined in the 'State' table located in the 'Reference data' domain. |
Stop cause | Once an operation is stopped, a stop cause is recorded that shows why the operation has terminated. Possible values (Failure, Kill and Normal) for this property are defined in the 'Stop cause' table located in the 'Reference data' domain. |
Status | The status is administrative information highlighting whether the operation is executing normally or in an atypical manner. The possible status values are declared in the 'Status' table located in the 'Reference data' domain. Example values include: Default (normal execution), Exceed max. duration time, etc. Color coding is configured for each status value to provide a specific visual alert when querying the monitor. |
Secondary status | When more than one status is raised for a monitoring record at the same time, then the 'Secondary status' property lists these values. This does not show a history of the status values over time, only current status values that have been raised. |
Record | One or more references to a record can be logged by the operation. |
Table | A reference to the table on which the operation is executed. |
Data set | A reference to the data set from which the operation is executed. |
Data space | A reference to the data space from which the operation is executed. |
User requester | The user that initiated operation execution. |
User killer | The user who requested termination of operation execution. |
Start date | The operation's start date. |
Last modification date | The record log's last date of modification. |
End date | The operation's end date. |
Percentage of completion | Completion percentage of the operation execution. |
Last suspended time | The last time operation execution was in a 'Suspended' (pending) state. |
Last restart time | The last operation execution restart date if the operation was previously suspended. |
Total duration in minutes | Total operation execution time. This duration is automatically computed by the monitor every time the operation refreshes its status. |
Max duration in minutes | An operation can be associated with a maximum expected execution duration. When the operation is registered in the directory, its 'Max. duration in minutes' property can provide a default value. During the execution, the operation can override this value when starting its communication with the monitor. |
End code | This property is used by the operation to record an 'end code'. This value is not used by the monitor. This is for information purposes only. |
Wait to be killed | The 'Wait to be killed' property allows the monitor to inform the operation whether its termination is expected or not. 'True': The operation is informed that it must stop as soon as possible. 'False': The operation can continue its execution. |
Input parameters | The operation can record any business data in the monitor with the data format 'Name-Value' (multi-occurrence). Three types of data are identified: input parameters, working parameters and output parameters. |
Working parameters | The operation can record any business data in the monitor with the data format 'Name-Value' (multi-occurrence). Three types of data are identified: input parameters, working parameters and output parameters. |
Output parameters | The operation can record any business data in the monitor with the data format 'Name-Value' (multi-occurrence). Three types of data are identified: input parameters, working parameters and output parameters. |
Directory
The 'Directory' table is used to register the operations that can be monitored. They are declared by products (EBX® 'modules').
Product
A product is an EBX® module that contains the operations that are registered.
Property | Definition |
|---|---|
Code | Technical name of the EBX® module. Example: ebx-addon-dqid, ebx-addon-daqa. |
Name | Functional 'name' of the EBX® module. Example: TIBCO EBX® Insight Add-on or TIBCO EBX® Match and Cleanse Add-on. |
Description | Any description can be entered for the module. |
Operation
This table contains the operations that are registered to be monitored.
Property | Definition |
|---|---|
Product | A reference to the product that contains the registered operation. |
Operation | Unique name of the 'service' in the EBX® module (product). For example: - "DQIdExecuteAndQueryOnTable" of the TIBCO EBX® Insight Add-on - "MatchAtOnceUnmatched" of the TIBCO EBX® Match and Cleanse Add-on |
Max. duration in minutes | Theoretical maximum duration of the operation execution in minutes. This value can be changed by the operation when starting the communication protocol with the monitor |
Accept to be killed | This property is used to state if the operation is able to receive and manage a kill request from the monitor 'True': The operation can receive and manage a kill request from the monitor. 'False': The operation can not receive a kill request from the monitor. |
Reference data
The following sections describe reference data.
State
Three states are used to manage the lifetime of an operation: Started, Stopped and Suspended.
Property | Definition |
|---|---|
Code | Any naming convention except the prefix '[ON]'. |
Label | The state label. |
Stop cause
Once the operation is stopped, it is possible to record a stop cause: Failure, Kill, Normal.
Property | Definition |
|---|---|
Code | Any naming convention except the prefix '[ON]'. |
Label | The stop cause label. |
Status
The status is administrative information highlighting whether the operation is being executed normally or in an atypical manner. The possible status values are declared in the 'Status' table. For example, Default (normal execution), Exceed max. duration time, etc.
Color coding is configured for each status value to provide a specific visual alert when querying the monitor.
Property | Definition |
|---|---|
Code | Any naming convention except the prefix '[ON]'. |
Label | The stop cause label. |
Color | Color used to display the monitoring record when the status is raised. |
Priority level | More than one status can be raised for a same monitoring record. To decide which one is used for the color coding, the priority level is applied. A value of '1' is the highest level. |
Java class | Qualified name (package + class name) of the java class that is used to compute the status. |
Archive
The archive domain allows you to make active the archiving process. It is based on a maximum number of stopped operations recorded in the monitoring table.
Property | Definition |
|---|---|
Automatic archive | The 'Automatic archive' property allows you to activate the automatic archive when the number of stopped operations is above the 'Max size' value (see next property). The archive is saved in the data space 'TIBCO EBX® Activity Monitoring Add-on - Archive'. 'True': Automatic archive is activated 'False': Automatic archive is not activated It is also possible to configure an automatic archiving based on the EBX® Scheduler (please refer to the user guide, section 'Archive data space'). |
Max size (nb. Of records ) | When the 'Max size' value is reached, then the automatic archive can be activated. The 'Max size' corresponds to the number of stopped operations. |