Board Platform Logs: Server Logs
Server Logs
2.1 Configuration Options
Server logs should be configured through the “Configure Server Logging” options under the System tab, accessing with a Board administrator user.
The list of configuration options modifies the output of the Database logs and Capsule logs.
2.1.1 Database Log Events
This option enables the output of the “HBMP_*databasename*_YYYYMM.log” log files.
For every database present in your Board installation, an log file is generated. Every month a new file is generated.
The database standard log contains every action executed on the Database side, or from a Database procedure, except dataflow actions unless the Dataflow Log Events option is enabled (see below).
2.1.2 Capsule Log Events
This option enables the output of the “Cpsx_YYYYMM.log” log files.
Scope: When enabled, the execution of every layout in any capsule screen will be logged.
Accessibility: The log has to be activated from the ‘System’ tab of the Board client under the ‘Configure Server Logging’ button. The statistics of all the layout executions are written in the log file: «Cpsx_YYYYMM.log» Also dataentry execution are tracked
Usability: The log is unique per each environment and splitted into monthly files. If there are many applications a clean action for those files is highly suggested.
Highlights: Version of the cubes used in a layout;
Multiple rows in each layout (one for each retrieved cube). The value of the dataentry is not tracked in this log, but in the dataentry log
The capsule log is unique and contains information on the usage of all the capsule in your Board installation. Every month a new file is generated.
The capsule standard log contains every action executed on a capsule, or capsule procedure, except dataflow actions unless the Dataflow Log Events option is enabled, and layout execution statistics unless the Layout Log Events option is enabled (see below).
2.1.3 Layout Capsule Log Events
When enabled, the execution of every layout in any capsule screen will be logged, with statistics on the query time of every block inside the layout. This information is very useful to debug slow screens and to understand system performance. Anyway, it is recommended not to enable this option in production environments with large number of users, as it may result in performance lacks.
2.1.4 Procedure Log Events
When enabled, allows logging of the name of the executed capsule procedure, in the capsule log. This information is very useful to track the execution of a capsule procedure from an user. Please note that this option doesn’t apply to database procedures.
Scope: When enabled, it allows the logging of the server actions invoked during capsule procedures executions (dataflows, clear cube and select based on)
Accessibility: The log has to be activated from the ‘System’ tab of the Board client under the ‘Configure Server Logging’ button. The statistics are written in the log file: «Cpsx_YYYYMM.log»
Usability: The log is unique per each environment and splitted into monthly files.
Highlights: Statistics on the dataflow executions invoked on a capsule procedure
Which cube is used for a select based on calculation. This log contains the procedure name that invoked the step. It also contain a step number
2.1.5 Dataflow Log Events
When enabled, allows logging of the dataflows executions, with statistics on the execution time and the dataflow mode used.
2.2 Capsule Log
Filenames: Cpsx_YYYYMM.log
Updated every: User action on a Capsule screen
Log Rotation: every month – year and month appended in the file name
Header: Yes
Scope: The capsule log is unique and contains information on the usage of all the capsule in your Board installation
Accessibility: The log has to be activated from the ‘System’ tab of the Board client under the ‘Configure Server Logging’ button. The log file is located in the following path: ‘’Board_Path\Dataset\Log’’. The filename is «Cpsx_YYYYMM.log»
Usability: The log is unique per each environment and splitted into monthly files. If there are many applications a clean action for those files is highly suggested.
Highlights: Version of the cubes used in a layout
Multiple rows in each layout
File structure (example):
NR | UserName | DbName | Date | Time | Operation | Capsule Path | Screen Title | [L]=Layout [P]=Procedure | Cube Name | Cube Version | [L]=Logical [P]=Physical View | [N]=Normal [E]=DataEntry [S]=Submitted | ElapsedTime (FirstBlockOnly) | 1=LayoutFirstBlock / 0=MoreLayout Blocks |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
18 | Administrator | Echo | 20170920 | 194307 | Multiple Layouts | logs.cpsx | Screen 1 | [L]-Untitled | Gross Sales | v001 | [L] | [N] | 00h00m00s | 1 |
18 | Administrator | Echo | 20170920 | 194307 | Multiple Layouts | logs.cpsx | Screen 1 | [L]-Untitled | Sales Packs | v001 | [L] | [N] | 00h00m00s | 0 |
19 | Administrator | Echo | 20170920 | 194307 | Multiple Layouts | logs.cpsx | Screen 1 | [L]-Average Price | Average Price | v002 | [L] | [N] | 00h00m00s | 1 |
19 | Administrator | Echo | 20170920 | 194307 | Multiple Layouts | logs.cpsx | Screen 2 | [L]-Average Price | Budget Sales | v001 | [L] | [N] | 00h00m00s | 0 |
19 | Administrator | Echo | 20170920 | 194307 | Multiple Layouts | logs.cpsx | Screen 2 | [L]-Average Price | Gross Sales | v003 | [L] | [N] | 00h00m00s | 0 |
Fields Description:
NR: Action ID (auto-incremental)UserName: The user who performed the actionDBName: Database on which action is executedDate: Date (format YYYYMMDD)
Time: Time ( format hhmmss)
Operation: Action executed on the server
CapsulePath: Capsule in use by the user
ScreenTitle: Title of the screen in use
[L]=Layout/[P]=Procedure: Layout or procedure (with name)
CubeName: Cube subject to the action
CubeVersion: Version of the subject cube
[L]=Logical/[P]=Physical View: If action is executed at cell level or on an aggregated level
[N]=Normal / [E]=DataEntry / [S]=Submitted: Normal means the block is displayed in read mode. DataEntry is when the block is open for data entry. Submitted means the server has executed a data entry submission, the blocks entered are logged after the refresh as submitted.
ElapsedTime (FirstBlockOnly): On the first block of the layout, shows the execution time for that layout.
1=LayoutFirstBlock / 0=MoreLayoutBlocks: 1 when it’s the first layout block, 0 for the others.
2.3 Database Log
Filenames: HBMP_*DataBaseName*_YYYYMM.log
Updated every: User action on a Database
Log Rotation: every month – year and month appended in the file name
Header: Yes
Scope: The database standard log contains every action executed on the Database side, or from a Database procedureAccessibility: The log can be deactivated from the ‘System’ tab of the Board client under the ‘Configure Server Logging’ button. The log file is located in the following path: ‘’Board_Path\Dataset\Log’’. The filename is «HBMP_*databasename*_YYYYMM.log»
Usability: The log is unique per each database and splitted into monthly files.
Highlights: Datareader executions and record counting, dataflow and datareader execution times, it does not contain procedure steps
Fields Description ( and example):
Action Code | Date | Time | UserName | DbName | Operation-Title | D.Flow Mode | Target | Elapsed | File | RecordNr | Validated | Rejected | RAM Status | ErrCode |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CD | 20170502 | 15:21 | user | Echo | Cube Defined | TARGET | 00h00m00s |
| ||||||
CD | 20170502 | 15:21 | user | Echo | Cube Defined | MIDDLE | 00h00m00s |
| ||||||
DF | 20170502 | 15:26 | user | Echo | DataFlow | HBMP+ | MIDDLE [Ver:001] | 00h00m01s | [1054/2168]Mb |
| ||||
DF | 20170502 | 15:26 | user | Echo | DataFlow | HBMP+ | TARGET [Ver:001] | 00h00m00s | [1054/2168]Mb |
| ||||
CD | 20170503 | 15:23 | user | Echo | Cube Defined | TARGET_2 | 00h00m00s |
| ||||||
CD | 20170503 | 23:05 | user | Echo | Cube Defined | SPARSE | 00h00m00s |
| ||||||
CD | 20170503 | 23:05 | user | Echo | Cube Defined | DENSE | 00h00m00s |
| ||||||
DF | 20170503 | 23:06 | user | Echo | DataFlow | LargeMatrix+ | DENSE [Ver:001] | 00h00m02s | [1043/2100]Mb |
| ||||
DF | 20170503 | 23:06 | user | Echo | DataFlow | HBMP+ | DENSE [Ver:001] | 00h00m00s | [1046/2096]Mb |
| ||||
DF | 20170503 | 23:07 | user | Echo | DataFlow | CellBased+ | SPARSE [Ver:001] | 00h00m10s | [1030/2117]Mb |
| ||||
DF | 20170503 | 23:07 | user | Echo | DataFlow | HBMP+ | SPARSE [Ver:001] | 00h00m00s | [1031/2109]Mb |
| ||||
FR | 20170505 | 19:51 | user | Echo | bubble | 00h00m00s | bubbleChart.csv | 124 | 124 | 0 | [1118/1136]Mb | |||
EM | 20170531 | 18:34 | user | Echo | Entity Modified | City | 00h00m00s | |||||||
Fields Description:
Action Code: Code of the action execute
Date: Date (format YYYYMMDD)
Time: Time ( format hh:mm)
UserName: The user who performed the action
DbName: Database on which action is executed
Operation-Title: Action executed on the server. In case of FR (FileRead) action code, this is the title of the datareader protocol.
D.Flow Mode: Dataflow mode ( in case of dataflow operation)
Target: Target cube of the dataflow
Elapsed: Elapsed time for the action
File: File read in caseof FR (FileRead) action. For SQL datareader is the code of the resultset obtained.
RecordNr: Number of records read (FileRead action)
Validated: Number of valid records loaded
Rejected: Number of records discarded
RAM Status: Ram usage at the end of the operation
ErrCode: Error code when operation is failed