BAM Database Reference

The BAM database has a star shaped style schema. This reference describes the fact tables and dimension tables in the BAM database.
Fact Tables:
  • BAM_WORKLOAD
  • BAM_TASK_PERFORMANCE
  • BAM_PROCESS_PERFORMANCE
Dimension Tables:
  • BAM_OUS
  • BAM_ROLES
  • BAM_PARTICIPANTS
  • BAM_PROCESSES
  • BAM_ACTIVITIES

BAM_WORKLOAD

This table contains information about the work items in process. The BAM Updater populates this table with the information it obtains periodically from the engine.

Field Name Value NULL Value Description
snapshot TIMESTAMP NOT NULL The date and time of the snapshot this row belongs to.
activityIn DECIMAL(10) NOT NULL The identification number (IN) of the activity where the work items this row represents, are sitting in. Use this IN in join queries against the BAM_ACTIVITIES table.
roleIn DECIMAL(10) NOT NULL The identification number (IN) of the role where the work items this row represents, are sitting in. Use this IN in join queries against the BAM_ROLES table.
participantIn DECIMAL(10) NOT NULL The identification number (IN) of the participant the work items this row represents, are assigned to. Use this IN in join queries against the BAM_PARTICIPANT table.
origActivityIn DECIMAL(10) NOT NULL If the work items this row represents, are sitting in a subflow activity, this field indicates the identification number of the activity in the subprocess associated to this subflow activity. Otherwise the value of this field is 1.
waitActivityIn DECIMAL(10) NOT NULL If the work items this row represents, are sitting in the sub-process of a subflow activity, this field indicates the identification number of the subflow activity in the parent process. Otherwise the value of this field is 1.
quantity DECIMAL(10) NOT NULL Indicates the number of work items that match the value of the following fields in this row:
  • processIn
  • activityIn
  • roleIn
  • participantIn
  • business dimension
  • latsnapshot
avgTimeTask DECIMAL(10) NOT NULL The average waiting time (in seconds), that the instances represented by this row, spent in the activity at the moment of the snapshot.
meanTimeTask DECIMAL(10) NOT NULL The median of the waiting time (in seconds), that the instances represented by this row, spent in the activity at the moment of the snapshot.
avgTimeProcess DECIMAL(10) NOT NULL The average waiting time (in seconds), that the instances represented by this row, spent in the process at the moment of the snapshot.
meamTimeProcess DECIMAL(10) NOT NULL The median of the waiting time (in seconds), that the instances represented by this row, spent in the process at the moment of the snapshot.

Primary Key: The primary key constraint is not defined in the database schema. The BAM Updater checks this constraint.

The following fields form the primary key:
  • activityIn
  • processIn
  • roleIn
  • participantIn
  • snapshotTime
  • Business Dimensions
Foreign Keys
Foreign Key Referenced Table
activityIn BAM_ACTIVITIES
waitActivityIn BAM_ACTIVITIES
origActivityIn BAM_ACTIVITIES
roleIn BAM_ROLES
participantIn BAM_PARTICIPANTS

BAM_TASKPERFORMANCE

This table contains performance information for every work item that has completed an activity.

Field Name Value NULL Value Description
activityIn DECIMAL(10) NOT NULL The identification number (IN) of the completed activity. Use this IN in join queries against the BAM_ACTIVITIES table.
roleIn DECIMAL(10) NOT NULL The identification number (IN) of the role the completed activity is assigned to. Use this IN in join queries against the BAM_ROLES table.
participantIn DECIMAL(10) NOT NULL The identification number (IN) of the participant the completed activity is assigned to. Use this IN in join queries against the BAM_ROLES table.
completionDate TIMESTAMP NOT NULL The time when the work item completed the activity. This time is stored in GMT-0.
taskTime DECIMAL(10) NOT NULL The time (in seconds) the work item took to complete the activity.
idleTime DECIMAL(10) NOT NULL The time the work item waited until its first execution.
Foreign Keys
Foreign Key Referenced Table
activityIn BAM_ACTIVITIES
roleIn BAM_ROLES
participantIn BAM_PARTICIPANTS

BAM_PROCESSPERFORMANCE

This table contains performance information for every work item that has completed the whole process.

Field Name Value NULL Value Description
processIn DECIMAL(10) NOT NULL The identification number (IN) of the process. This number identifies the process in the organizational unit. It may vary between deployments. Use the IN only for join queries with other tables. Do not use the IN directly in your queries, instead use the processID.
completionDate TIMESTAMP NOT NULL The time when the work item completed the process. This time is stored in GMT-0.
taskTime TIMESTAMP NOT NULL The time (in seconds) the work item took to complete the activity.
Foreign Keys
Foreign Key Referenced Table
processIn BAM_PROCESSES

BAM_LASTSNAPSHOT

This table stores the time when the BAM Updater took the last snapshot. The BAM Updater populates the Workload with the data obtained in each snapshot.

Field Name Value NULL Value Description
lastsnapshot TIMESTAMP NOT NULL The time of the last snapshot. Use this time to obtain from the Workload table the rows that correspond to the most up-to-date data.

BAM_OUS

Field Name Value Null Value Description
ouIn DECIMAL(10) NOT NULL The identification number (IN) of the organizational unit. This number identifies the organizational unit in its parent organizational unit. It may vary between deployments. Use the IN only for join queries with other tables. Do not use it directly in your queries, instead use the name.
parentIn DECIMAL(10) NOT NULL The identification number (IN) of the parent organizational unit. If this row corresponds to the Organization the value of this field is -1.
name STRING(255) NOT NULL The name of the organizational unit. Use this ID in where clauses to restrict the query to a certain role.
fullPathName STRING(512) NOT NULL The complete name of the organizational unit, which includes the complete name of its parent organizational unit.

Primary Key: ouIN

BAM_ROLES

Field Name Value NULL Value Description
roleIn DECIMAL(10) NOT NULL The identification number (IN) of the role. This number identifies the role in the organizational unit. It may vary between deployments. Use the IN only for join queries with other tables. Do not use the IN directly in your queries, instead use the roleID.
roleID DECIMAL(10) NOT NULL The ID that identifies the role in the organizational unit. Use this ID in where clauses to restrict the query to a certain role.

Primary Key: roleIn

BAM_PARTICIPANTS

Field Name Value NULL Value Description
participantIN DECIMAL(10) NOT NULL The identification number (IN) of the participant. This number identifies the participant in the organizational unit. It may vary between deployments. Use the IN only for join queries with other tables. Do not use the IN directly in your queries, instead use the participantID.
participantID STRING(255) NOT NULL The ID that identifies the participant in the organizational unit. Use this ID in where clauses to restrict the query to a certain participant.
ouIn DECIMAL(10) NOT NULL The identification number (IN) of the organizational unit the participant belongs to. Do not use this number directly in your queries, use it only for join queries against the BAM_OU table.
displayName STRING(255) The localized, human readable name of the organizational unit. The system locale settings of the environment where the BAM Updater runs determine the localization of this field.

Primary Key: participantIn

Foreign Keys
Foreign Key Referenced Table
ouIn BAM_OUS

BAM_PROCESSES

Field Name Value NULL Value Description
ouIn DECIMAL(10) NOT NULL The identification number (IN) of the organizational unit where the process is deployed. Do not use this number directly in your queries, use it only for join queries against the BAM_OU table.
processIn DECIMAL(10) NOT NULL The identification number (IN) of the process. This number identifies the process in the organizational unit. It may vary between deployments. Use the IN only for join queries with other tables. Do not use the IN directly in your queries, instead use the processID.
processId STRING(255) NOT NULL The ID that identifies the process in the organizational unit. Use this ID in where clauses to restrict the query to a certain process.
label STRING(255) NOT NULL The localized, human readable name of the process. The system locale settings of the environment where the BAM Updater runs determine the localization of this field.

Primary Key: processIn .

Foreign Keys
Foreign Key Referenced Table
ouIn BAM_OUS

BAM_ACTIVITIES

Field Name Value NULL Value Description
activityIn DECIMAL(10) NOT NULL The identification number (IN) of this activity. This number identifies the activity in the organizational unit. It may vary between deployments. Use the IN only for join queries with other tables. Do not use the IN directly in your queries, instead use the activityID.
activityId STRING(255) NOT NULL The ID that identifies the activity in the organizational unit. Use this ID in where clauses to restrict the query to a certain activity.
processIN DECIMAL(10) NOT NULL The identification number (IN) of the process this activity belongs to. Do not use this number directly in your queries, use it only for join queries against the BAM_PROCESSES table.
label STRING(255)   The localized, human readable name of the activity. The system locale settings of the environment where the BAM Updater runs determine the localization of this field.

Primary Key: activityIn

Foreign Keys
Foreign Key Referenced Table
processIn BAM_PROCESSES