Setting a monitor for Process KPI

To create a monitor for process KPI, do the following steps:

  1. On the Monitor page, click the Process KPIs tab, and then click Create Monitor.

    Create process monitor

  2. On the Details page of the Create Process KPI monitor wizard, do the following steps:

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

    Defining process kpi monitor

  3. On the Monitor page, define the monitor with the following information: a. In the Select KPI to monitor field, select the KPI you want to monitor.
    b. In the Set threshold to monitor section, set the value that you want to monitor based on the KPI selected.
    c. Click Add filter template to add a filter to the monitor. d. In the Recurring outputs section, select any one of the options and define how to display the recurring outputs and then click Next.


    Notes:

    • 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 Process KPI monitor. For more information on creating filters, see Filters.

    • In the Recurring outputs section, if you select the Avoid sending duplicate results within interval option, then you must define the timeframe during which the duplicate results are not displayed.


    Setting monitor parameter in Process KPI

  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 defined 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.

    Scheduling in Process KPI


    Note: 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.

    Set service in Process KPI

  6. On the Parameters page, 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.

    Setting the parameters in Process KPI


    Note: 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).

    Customization in Process KPI


  7. Click Create. The created monitor event appears on the Process KPIs tab.

Related task: