Creating and managing a service

Before creating a monitor for a process, you must create a service and mention the type of authentication required for the service. In IBM Process Mining, service is an API that you can create and link to a monitor. The service can be invoked when the monitoring service detects some situations to report and in that case the API that composes the service can be invoked with the data detected by the monitor. The results created by a monitor are passed as inputs to the API.

For more information, see the following links:

Understanding the relation between service and monitor

The data that is collected after every monitor run is packaged into a JSON payload and sent to the associated Service endpoint, which is defined by the user.

When you create a monitor event, you can define query parameters and request header parameters in the service API call. In IBM Process Mining, you can define the Body Parameters option to ensure that the payload uses a predefined JSON format, which includes all the available data or you can use the Customised Body option to customize the payload to a specific format. For more information on various types of monitors and the settings, see Types of monitors.

Creating a service

To create a service, do the following steps:

  1. On the Monitor page, ensure that a process is selected. If not, select the process from the process list.

    Select process

    Note: You can also select a process in the Workspace page of IBM Process Mining before accessing the Monitor page.

  2. On the Monitor page, click Create service.

    Create service

  3. In the Service title field of the Create new service dialog, type a name for the service.

  4. In the Description field, type a description for the service that you are creating.

  5. In the Url field, type the URL to which the results must be published. Note that you need to provide the complete URL with http:// or https://.

  6. Set Allow self-signed certificates to True if the certificates are from trusted source. This is an optional step and it depends on the API you want to create.

  7. Set Share with others to True to share the service with other accounts in the organization.

  8. In the Authentication type section, click one of the following types:

    • API key, if the authentication is performed based on an API key and value.
    • Basic Auth, if the authentication is performed using a login credential.
    • No Auth, if there is no authentication required.
  9. For the API key authentication, do the following steps:
    a. In the Position field, select Header or Query.
    b. In the API key name field, type the name for the API key.
    c. In the API key value field, type the value for the API key.

  10. For the Basic Auth authentication, do the following steps: a. In the Username field, type the username. b. In the Password field, type the password.

  11. Click Create.

    Sample service

Managing a service

You can use the Manage services page to view all services created for a process. You can also go to the Manage services page to edit, delete, or duplicate a service created for the process.

To manage a service, do the following steps:

  1. On the Monitor page, click Manage services.

    Manage service

  2. To search for a service, type the name of the service in the search box. Search service

  3. To sort the service, do one of the following steps in the Sort by box:

    • Click Last modified to sort the services based on the modification performed. The latest modified service is displayed as the first one.
    • Click Alphabetically to sort the services in the alphabetical order.
    • Click Oldest first to view the oldest services created for the process.

    Sort service

  4. To edit a service, do the following steps:
    a. In the Manage service dialog, click the three-dot icon corresponding to the required service, and then click Edit.

    Edit service

    b. In the Edit service dialog, edit the required field, and then click Update.

    Edit service detail

  5. To delete a service, do the following steps:
    a. In the Manage service dialog, click the three-dot icon corresponding to the required service, and then click Delete.

    Delete service

    b. In the Delete service message box, click Delete.

    Delete confirmation

  6. To duplicate a service, click the three-dot icon corresponding to the required service, and then click Duplicate. Duplicate service

Related task: