ARIS Process Mining

Runtime systems, for example, SAP® or Oracle® systems, have data such as the frequency of executed processes and their data, access frequencies and problems, or error messages that have occurred. Using the IBM® webMethods Integration connector for ARIS Process Mining allows you to create the connection between ARIS Process Mining and these systems. This data can be transferred, for example, from runtime systems to ARIS Process Mining and loaded into a data set for further analysis.

ARIS Process Mining supports a public data ingestion REST-API. The API allows you to transfer data from any data source to ARIS Process Mining. The data transferred to ARIS Process Mining must be in table format and must conform to JSON format.

The IBM webMethods Integration connector provides the REST operations from the data ingestion API that you can use to customize your own actions. Additionally, predefined operations allow you to directly use the most commonly used REST resources and operations or reduce the complexity of customizing REST operations.

Prerequisites

Before you can create the connection, you must first create a system integration and connection for the data ingestion API in ARIS Process Mining. The system integration must be based on the Client credentials authentication method. The system integration provides the client ID and client secret required to create a connection between IBM webMethods Integration and ARIS Process Mining.

Connection Parameters

You must specify the following parameters to create a connection between IBM webMethods Integration and ARIS Process Mining:

  • Account Name: The account name is used to identify the connection.

  • ARIS Cloud URL: The ARIS Cloud URL is the URL to the ARIS Process Mining host. https://mc.ariscloud.com is preset by default.

  • Project Room: The project room is the tenant.

  • Data Set Name: Data set to which the data is uploaded. The specified data set is automatically used for all requests of the connector.

  • Client ID: ID to log in to ARIS Process Mining. The client ID is provided by the system integration created for the data ingestion in ARIS Process Mining.

  • Client Secret: Secret to log in to ARIS Process Mining.The client secret is provided by the system integration created for the data ingestion in ARIS Process Mining.

  • UMC Session Timeout (min): Optional. The default value is 45 minutes according the default UMC settings (This can be changed if updated in the UMC settings).

  • Response Timeout (milliseconds): Optional. The default value is 30000 milliseconds.

Actions

  • Cancel Cycle: Cancels the specified cycle.

  • Commit Data Upload Cycle: Indicates ARIS Process Mining that all data has been uploaded and can be loaded into the source tables. The status of the specified cycle will be set to "COMPLETED_SUCCESSFULLY" when the upload has finished without errors in the ARIS Process Mining.

  • Create Data Upload Cycle: Creates an ingestion cycle to upload data. An ingestion cycle key is returned. This key must be used to cancel or delete this cycle, or to get the state of the cycle or to inform ARIS Process Mining that the data upload is complete.

  • Create Source Tables: Creates source table(s) in ARIS Process Mining. Note: If persistenceMode is not set, the table(s) will be created with persistenceMode = OVERWRITE.

  • Drop Source Table: Drops a specified source table.

  • Is Ready for Data Load: It is checked, if a data load can be started.

  • Is Ready for Data Upload: It is checked, if data can be uploaded.

  • Start Data Load: Creates a data ingestion cycle to start the data load.

  • Replace Source Tables: Replaces source table(s) in ARIS Process Mining if the identifier already exists. The structure and data will be replaced. Note: If persistenceMode is not set, table will be replaced with persistenceMode = OVERWRITE.

  • Retrieve Cycle State: Retrieves the state of the specified ingestion cycle.

  • Retrieve API Version: Retrieves the current API version of ARIS Process Mining.

  • Retrieve Cycles: Retrieves all existing ingestion cycles of a data set. This action is based on the corresponding endpoint, which is only available from ARIS Process Mining version 10.18.

  • Retrieve Source Table Definitions: Retrieves definition of requested tables. Note: If no tables are specified, the structure of all tables will be returned.

  • Upload Data: Uploads data for a specified source table to ARIS Process Mining. Before the data is uploaded to ARIS Process Mining, it is checked whether the data corresponds to the expected data type.

  • Update Source Table Definition: Updates the structure of the specified source table while preserving the existing data. This action is available from ARIS Process Mining version 10.20.

Custom Actions

ARIS Process Mining connector also lets you create your own custom actions for performing specific tasks.

Learn more about how to create custom actions.

The custom actions are based on the endpoints provided by the data ingestion API.