(DI-2305) Collector for monitoring transmissions
The collector for monitoring failed transmission is named: /DVD/MON_CL_COL_SEND_TRANSMIT.
By default, this collector collects KPIs for transmissions in various states and has a customizable input table where the user can filter which transmissions he wants to monitor. To secure the best performance, this collector collects all transmissions either since the last collector run or at a maximum of one hour retrospectively however it can be customized via parameters.
Parameters
This collector has the following parameters:
Parameter name | Default Value | Description |
|---|---|---|
MINUTES_BACK | 60 | If it is the initial collector run or the last collector run was more than an hour ago, only transmissions one hour back will be collected retrospectively. This can be changed by tuning this parameter |
MAX_PROCESS_TO_DETAIL | 50 | Defines the limit of how many collected transmissions will be propagated to the detail table to avoid performance issues. Erroneous transmissions are prioritized. This only applies to default processing and user-defined inputs are not limited by this. Also, this parameter only limits detail table output, KPI counts are not affected. |
Default KPIs
By default, this collector includes these predefined KPIs:
KPI name | Description | Unit | Detail Table |
|---|---|---|---|
SDTR_ERROR_CNT | Number of all transmissions in error | Count | Yes |
SDTR_TRANSMT_CNT | Number of successfully transmitted mail requests | Count | Yes |
SDTR_WAITING_CNT | Number of waiting transmissions | Count | Yes |
NOTE: All standard KPIs have the prefix SDTR_*
Input table
The KPIs may be defined in the input table /DVD/MON_SDTRI1. By default, standard KPIs (with the prefix SDTR_*) are predefined in the input table. Users can monitor additional or more specific transmissions by creating new KPI and input table rows:
Technical name | Column name | Description |
|---|---|---|
KPI | KPI name | Name of KPI under which count of matched transmissions is reported to CrystalBridge Monitoring cockpit. KPI needs to be created first - check the note under this table |
RULE_ID | KPI Rule Number | Part of the key of the table. It may be freely specified |
STATUS | Status of the sent object | Specify selected transmissions by status (ERROR/SEND/WAITING). The field offers F4 help. |
METHOD | Transmission method code | For example INT for (via Internet). It can be left empty to match all |
SENDER | Sender name | Transmission can be filtered by sender name. Leave blank to match any. This field supports wildcards. |
RECIPIENT | Recipient | Transmission can be filtered by recipient name. Leave blank to match any. This field supports wildcards. |
SUBJECT | Document title | Document title. For example mail title. Leave blank to match any. |
ADD_TO_DETAIL | Add relevant records to details | True/false flag to determine if transmissions selected by this input table row should be added to the detail table. |
ACTIVE | Is the KPI rule active? | Activates/deactivates this input table row. |
CHANGED_BY | Last Changed By User | Changed by |
CHANGED_AT | Last Changed At [TIMESTAMP] | Changed at |
CREATED_BY | Created By User | Created by |
CREATED_AT | Created At [TIMESTAMP] | Created at |
If you wish to monitor custom transmission, you must define a new custom KPI in the CrystalBridge Monitoring cockpit before assigning it to the input table.
More information can be found in the chapter How to Create a Custom KPI through a Collector with a Custom KPI.
KPI value is the number of occurrences of specified transmission details defined through the input table.
Detail table
The collector provides also a detailed output of KPIs in a detail table. The detail table Transmissions details - /DVD/MON_SDTRD1 is limited by a parameter (see parameters section). It contains the following fields:
Technical name | Description |
|---|---|
KPI | Name of KPI from input table assigned to this detail |
SID | System ID |
SERVER | Server name |
MESSAGE_NUMBER | Message number used in transmission |
MSGTXT | Text of the message |
RECIPIENT | Recipient of transmission |
SENDER | Sender |
SEND_DATE | Date of transmission |
SEND_METHOD | Transmission method code |
SEND_TIME | Time of transmission |
STATUS | Status of the sent object |
TITLE | Document title |