Setting a monitor for Analytics widgets

Creating a dashboard

To create a dashboard, do the following steps:

1. In the navigation pane of IBM Process Mining, click the Analytics icon.

2. On the Analytics page, click Dashboard, and then click Create new.

   

3. In the Name field of the Choose a dashboard name dialog box, type a name for the dashboard, and then click OK.

   

4. On the newly created dashboard page, click Edit to create a widget.

   

5. In the right panel, click the Add table icon to create a table widget, and then click Table.

   

6. On the table widget, click the settings icon.

   

7. In the Table dialog, add the following information, and then click OK.

   • Name for the table
   • Dimensions/columns of the table

   

8. In the right panel of the dashboard window, click Save to view the table created as illustration in the following figure.

   

9. On the navigation pane, click the Monitor icon to go to the Monitor page.

Creating a monitor for Analytics widgets

To create a monitor for an analytics widget, do the following steps:

1. On the Monitor page, click the Analytics widgets tab, and then click Create Monitor.

   

2. On the Details page of the Create Analytics widget monitor wizard, do the following steps:

   a. In the Title field, type a name for the analytics widget monitor.
   b. Optional: In the Description field, type a description for the monitor, and then click Next.

   

3. On the Monitor page, do the following steps:
   a. In the Select dashboard field, select the dashboard for which you want to create the monitor.
   b. In the Select what widget to monitor field, select the widget for which you want to create the monitor.
   c. Click Add filter template to add a filter to the monitor.
   d. In the Recurring outputs section, select the required filter for displaying recurring outputs.
   

   If there is only one dashboard and widget created for the Analytics widget monitor, then the wizard automatically populates the data in the respective boxes.
   The Add filter template button is enabled only if there are predefined filter templates for the selected process. Hence, you must create the filter template before you create the Analytics widget monitor. For more information on creating filters, see Filters.
   If the Recurring outputs is set to Avoid sending duplicate results within interval, then you must also choose the interval.

   

4. On the Schedule page, define the criteria for running the monitor, and then click Next.

   • Click Data Upload to run the monitor when data is uploaded to the process.
     
   • Click Frequency to run the monitor at the defined timeframe and days. In this option, you can set to run the monitor at the specified hour or minute. You can also specify whether the monitor should run during business hours or not.
   • Click Calendar to run the monitor at the specified day. You can also set to run the monitor on yearly, monthly, or weekly basis.

   

In this release, you can schedule to run the monitor at a timeframe based on UTC and based on your geographical location.

5. On the Service page, click the service to which you want to link the monitor, and then click Next.

   

6. On the Parameters page, do the following steps:
   

   • If you select a Rest API service on the Service page, then do the following steps:
     

     a. In the URL suffix field, type the suffix for the URL to display the data.
     b. In the HTTP method field, select the required HTTP request method.
     

     • POST
       
     • GET
       
     • PUT
       

     c. In the Additional Parameters section, you can set the Query parameters, Header parameters, and Body parameters.
     d. Click Verify connection to verify the connection to the URL.
     e. Set Activate monitor to Active to activate the monitor when it is created. You also set Activate monitor to Inactive if you do not want to activate the monitor as soon as it is created.
     

     

   When you create a monitor event, you can customize the body parameters on the Parameters page. The page lists the tags that you can use for customization and also provides the options to validate the JSON script created in the Body Parameters section (as illustrated in the following figure).

   • If you select an SMTP service on the Service page, then do the following steps:
     a. In the To, the CC recipients, and the BCC recipients fields of the Recipients section, update the email addresses to which you want to send the result of the monitor event.
     b. The values for the Display name field and the From field are retrieved based on the information updated in the SMTP service. If required, you can edit the values in the field.
     c. In the Subject and Body section, you can use the tags in the Subject and Body fields to define how the results of the monitor event should be presented.
     Starting IBM Process Mining 1.14.3, the Body field supports HTML formatting.
     d. Click Verify connection to ensure the accuracy of the information provided in the Recipients section.

     

7. Click Create. The created monitor event appears on the Analytics widgets tab.

Related task:

• Managing the monitor events