(DI-1911) Example: Number of Errors in Inbound IDocs of the Message Type – Orders

In this example you find brief instructions how to create a custom KPI which displays the number of errors in inbound IDocs of the message type – orders.

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

Contents

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
   1. KPI name: ZIDOC_IN_ERRORS_TYPE_ORDERS. (Choose a name that starts with a capital Z or Y).
   2. Description: Number of errors in inbound IDocs with the type orders
   3. KPI collector: /DVD/MON_IDOC_CL_COL_EDIDC
   4. Fill in all remaining fields for a custom KPI as displayed in the figure. All the field descriptions can be found in (DI-1911) 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 IDocs

1. Select Settings > Collector settings (or the transaction /DVD/MON_COL) o the main screen.
2. Select the collector /DVD/MON_IDOC_CL_COL_EDIDC.
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 KPI name with your custom KPI name. In our example it is: ZIDOC_IN_ERRORS_TYPE_ORDERS.
   2. Set Rule nbr. to 1.
      
   3. Set Unit to COUNT.
   4. Set Status to 51 (IDoc error status).
      
   5. Set Directn to 2 (for outbound).
   6. Set Messg. type to ORDERS.
      
   7. Set Into det. to X (optional) – in the case you would like to collect details for this KPI.

   8. Set From l.run to X (optional) – in the case you would like to collect data only from the last run of the Collector job for IDOCs monitoring. When this field is empty, the Collector job will select all IDOCs in the past.  

      An IDoc has multiple error statuses. Therefore, you should create a new rule entry for each error status, according to the mentioned steps above. Fill in the other rules the same as the first rule for the following error statuses: 52, 54, 56, 60, 61, 63, 65. Please keep in mind that each rule should have a different Rule number.   

      

7. Save the entries (CTRL + S).

At this point you have created a new custom KPI ZIDOC_IN_ERRORS_TYPE_ORDERS, which collects information about Error inbound IDocs with the message type orders.

Step 2.1.:  Assign the Detail table /DVD/MON_IDOC_D1 to your custom KPI (optional)

If you have set the field Into det. to 'X' in the Input table, you chose to collect KPI details into a Detail table. To display the KPI details, you should assign the default Detail table /DVD/MON_IDOC_D1 of this collector to your custom KPI.
To perform this:

1. Select Settings > Collector settings (or the transaction /DVD/MON_COL) in the main screen.
2. Select the collector /DVD/MON_IDOC_CL_COL_EDIDC.
3. Double-click Detail tables.
4. Select the Detail table /DVD/MON_IDOC_D1.
5. Double click Assignment.
6. Click New Entries (F5).
7. Set the KPI name ZIDOC_IN_ERRORS_TYPE_ORDERS.
8. Save (CTRL + S).

Step 3: 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 IDOC_1HOUR.

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 IDOC_1HOUR. You may also create your own Monitoring profile as described in (DI-1911) 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 IDOC_1HOUR.

4. Double-click Assigned KPIs.
5. Click New Entries (F5).
6. Fill the KPI name ZIDOC_IN_ERRORS_TYPE_ORDERS.
7. Save (CTRL+S).

The custom KPI ZIDOC_IN_ERRORS_TYPE_ORDERS is now assigned to the Monitoring profile IDOC_1HOUR.

Step 4: 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 IDOC_1HOUR.

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 before a Collector job for the Monitoring profile, please see the example below on how to start the monitoring of the custom KPI.

1. In the main screen, go the the Collector Jobs tab.
2. Select Create collector job.
3. Fill in System ID on which you want to monitor the KPI. 
4. Fill in Monitoring profile: IDOC_1HOUR.
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 in the main screen. For further information on how to display a KPI, see (DI-1911) Display KPIs.