(DI-2305) Create a Detail Table for a Custom KPI Assigned to a Custom Collector

Owned by SNP
May 03, 2023
2 min read

This chapter contains instructions on how to create a Detail table for a custom KPI assigned to a custom collector.

What is a Detail table, is explained in the chapter KPI Details Displayed in a Detail Table.


Prerequisites

  1. Step 1: Create a Detail table for a custom KPI assigned to a custom collector

    1. Go to Settings > Collector settings. 
    2. Find your Custom collector (starting with Y or Z).
    3. Select the collector and double-click Detail tables.
    4. Select New Entries (to create new entries you should be in the Edit mode).

    5. Fill in Detail table name and Detail table description fields.

      You can create a custom Detail table, only if it starts with the capital letters Z* or Y*.

      If the name of your Detail table is the same as a structure or a table type in DDIC, then the description for the fields of the Detail table will be retrieved from the DDIC structure.
      In other cases, when the Detail table name isn't included in DDIC, then the fields of the Detail table are defined by the custom collector (technical names of the fields are used as their descriptions).

    6. Save (CTRL + S)

    7. Define which information is stored in a Detail table

      You should implement your own logic for the collection of details into the Detail table. To display the KPI details in CrystalBridge® Monitoring, you must save them using the collector's method add_detail_table(). 

      Instead of '/DVD/MON_OUTPUT_TABLE' use your own created Detail table.

      When you create a custom Detail table, the fields of a Detail table aren't displayed in the Fields folder. The fields are generated after the first run of the custom collector.

    Step 2: Assign a Detail table to the custom KPI

    1. Select your created Detail table and double-click Assignment (Go to Settings > Collector settings > Detail tables).
    2. Select New Entries.
    3. Fill in your custom KPI name, which you want to assign to the custom Detail table.
    4. Save (CTRL + S).

                

The Detail table is now assigned to your custom KPI. For information on how to display the Detail table, see the chapter (DI-2305) KPI Details Displayed in a Detail Table.

The same procedure for a custom KPI assigned to the Collector for user defined SQL is described in the chapter (DI-2305) Create a Detail Table for a Custom KPI Assigned to the Collector for a User Defined SQL.