Configuration information

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

Status information highlights whether operations execute 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', 'Not yet killed' and 'Stop exceeded max duration'.

Color coding for each status value provides a specific visual alert when querying the monitor. These colors can help you distinguish between an operation that stopped normally and one that stopped because it exceeded its maximum allowed duration time.

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.

Code

A unique identifier generated by the add-on.

Event

The operation that triggered event storage. The 'Event' table stores the color coded events that can display here.

User session

Information about each user session, including the User ID, Session ID and IP address. This field references records stored in the 'User session' table.

Event time

The timestamp of the corresponding event's execution.

Duration

The amount of time accrued by the corresponding operation. The add-on calculates duration by subtracting the log in timestamp from the log out timestamp. If no log in was recorded for a user's session, the add-on cannot compute the duration.

User id

The user ID corresponding that initiated this session.

HTTP session id

The unique session ID.

IP address

The user's IP address.

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.

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

- "matchAtOnce" 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.

Enable archive

Turns automatic archiving on, or off. When the number of stopped operations exceeds the corresponding 'Max. number records' property value, the add-on begins the archiving process. The 'TIBCO EBX® Activity Monitoring Add-on - Archive' data space stores the archives.

You can also configure automatic archiving based on the EBX® Scheduler. Refer to the 'Archive data space' section for more information.

Max. number records

The number of stopped operations allowed before the add-on begins the archiving process.

Enable event tracking

Turns event tracking on, or off globally. To enable types of events, such as session tracking, use the 'Event tracking' table.

Max. number records

The number of records stored before the add-on begins deleting them—starting with the oldest.

Code

The unique id for this type of event.

Label

This event's name, such as 'Session tracking'.

Description

The description for this type of event.

Enable

Determines whether tracking for this type of event is enabled/disabled.

Code

Any naming convention except the prefix '[ON]'.

Label

The state label.

Code

Any naming convention except the prefix '[ON]'.

Label

The stop cause label.

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.

Code

The predefined list of available events.

Label

The event's label. Default values include the following events:

• Session destroy: When an administrator terminates a users session.

• Log in: When a user logs in.

• Normal log out: When a user performs the log out operation.

• Session timeout: When the system logs the user out due to inactivity for more than the allotted time.

Color

The unique color assigned to each event.