(DI-2202) Example: Response time for custom transaction

Owned by SNP
Feb 08, 2022
4 min read

In this example, you might find brief instructions on how to create a custom KPI that displays the number of custom transaction starts.

For more information on how to create a custom KPI based on this type of collector, see the chapter Create a KPI through the Collectors with a Custom KPI.

Step 1: Define a custom KPI 

  1. Go to Settings > Monitoring settings (or transaction /DVD/MON_CUST).

  2. Click New Entries (F5).

  3. Fill in all required fields for your custom KPI as displayed on the figure below:

    1. KPI name: ZSTAT_DVD_MON_TTL. (Choose a name that starts with a capital Z or Y).

    2. Description: Response Time of Transaction /DVD/MON

    3. KPI collector: /DVD/MON_STAT_CL_COL_MODULES

    4. Fill in all remaining fields for a custom KPI as displayed in the figure below. All the field descriptions can be found in the chapter Define a Custom KPI.

  4. Save the KPI definition (CTRL + S).

Step 2: Choose how data is collected into the custom KPI through the Collector for Workload statistics

  1. Select Settings > Collector settings (or the transaction /DVD/MON_COL)

  2. Select the collector /DVD/MON_STAT_CL_COL_MODULES.

  3. Double-click Inputs & rules.

  4. Select Edit next to the Input table /DVD/MON_IDOC_I1.

  5. Click Switch mode (Edit) (CTRL + F1) and then Create new records  (F6).

  6. Define new rules:

    1. Fill in the KPI name with your custom KPI name. In our example: ZSTAT_DVD_MON_TTL.

    2. Set Value result. to RESP_TIME.

    3. Keep the One rec. empty (to select all statistical records per transaction)

    4. (OPTIONAL) You might define additional fields according to described fields in Input table - /DVD/MON_STAT_I1.

  7. Save the entries (CTRL + S).

Step 3: Choose which statistical records are included in the custom KPI calculation

  1. Select Settings > Collector settings (or the transaction /DVD/MON_COL)

  2. Select the collector /DVD/MON_STAT_CL_COL_MODULES.

  3. Double-click Inputs & rules.

  4. Select Edit next to the Input table /DVD/MON_STAT_I2.

  5. Click Switch mode (Edit) (CTRL + F1) and then Create new records  (F6).

  6. Define new rules:

    1. Fill in the KPI name with your custom KPI name. In our example: ZSTAT_DVD_MON_TTL.

    2. Set Rule number to 1.

    3. Set Program Name to custom Transaction code or Report which is executed directly or via custom transaction. In this example is used transaction code /DVD/MON.

    4. Set Task type to 1 (Dialog process)

    5. (OPTIONAL) You might define additional fields according to described fields in Input table - /DVD/MON_STAT_I2.

  7. Save the entries (CTRL + S).

At this point, you have created a new custom KPI ZSTAT_DVD_MON_TTL, which collects the information about the Total response time for /DVD/MON transaction.

If you want to collect details for this KPI, please check the steps mentioned in chapter Collector for Workload Statistics - Detail table.

Step 4: Assign a Monitoring profile to the custom KPI 

Before you start to collect the created KPI, you must assign it to a Monitoring profile. In this example, we don't create a new Monitoring profile but assign the custom KPI to the default Monitoring profile DEF_5MIN.

  1. Go to the Settings > Monitoring settings (or transaction /DVD/MON_CUST).

  2. Double-click Profile definition. 

  3. Select and set a default Profile name DEF_5MIN. You may also create your own Monitoring profile as described in the chapter Define a Monitoring Profile for a KPI. 

    If you create your own Monitoring profile, you should use your own Monitoring profile name in the next steps instead of DEF_5MIN.

  4. Double-click Assigned KPIs.

  5. Click New Entries (F5).

  6. Fill in the KPI name ZSTAT_DVD_MON_TTL

  7. Save (CTRL+S).

The custom KPI ZSTAT_DVD_MON_TTL is now assigned to the Monitoring profile DEF_5MIN (or your custom profile).

Step 5: Schedule the monitoring of a custom KPI 

The last step is to start the monitoring of the KPI for a specific system with its assigned Monitoring profile DEF_5MIN.

You may check in the Collector Jobs tab, if you created before a Collector job for the Monitoring profile of your custom KPI and if it is scheduled.
For information on how to schedule and start monitoring KPIs belonging to a Monitoring profile, see the chapter Schedule the Monitoring of KPIs.

If you created before a Collector job for your Monitoring profile of your custom KPI:

  1. Go to the Collector Jobs tab

  2. Find the Monitoring profile and click Stop and Start in the field Coll.job.
    In the fields Last status icon and Job last status is displayed when the Collector job run is completed.

If you didn't create a Collector job for the Monitoring profile, please see the example below on how to start the monitoring of the custom KPI.

  1. On the main screen, go to the Collector Jobs tab.

  2. Select Create collector job.

  3. Fill in the System ID on which you want to monitor the KPI. 

  4. Fill in Monitoring profile: DEF_5MIN.

  5. Adjust the Period and Retention time according to your requirements.

  6. Click (Re)Start collector job.

When the Collector job was executed successfully, you may display the results of your custom KPI on the main screen. For further information on how to display a KPI, see the chapter Display KPIs.