Creating projects by using custom process apps

You can create a project in IBM Process Mining by using a custom process app. The custom project applies all the process logic and configurations that you previously set up when you created the process app. To generate a project by using a custom process app, complete the following actions:

  1. Specify the project details
  2. View the documentation
  3. Configure tne event logs
  4. Optional: Schedule data updates
  5. Load your data
  6. Generate your process-mining project

Specifying the project details

To set up the project details, complete the following steps:

  1. On the Home page, click the Start from a process application tile.
  2. On the tile of the process app that you want to use, click Get Started
  3. Enter the name of your process-mining project.
  4. Link your project to an organization by choosing one of the following options:
    • To link your project to an existing organization, click the Use existing organization button and select an organization name from the list.
    • To link your project to a new organization, click the Create new organization button and enter the name for the new organization.
  5. Click Next to go to the Documentation step.

Viewing the documentation

The Documentation step is visible only if the creator of the process app provided documentation in the Provide user guidance step. For more information, see Providing user guidance.

In the Documentation step, you can view the documentation the process app creator provided. Read the documentation to learn how you can use this process app to generate a project. Click Next to go to the Configuring event logs step.

Configuring event logs

The Configure event logs step is visible only if the creator of the process app added user input fields in the Define user input. For more information, see Defining user inputs.

To configure the event logs, complete the following steps:

  1. Enter input in the fields that are marked as requested.

  2. Optional: Enter input in the fields that are not marked as requested.

  3. Click Next to go to the Load your data step.

Optional: Scheduling data updates

In the Schedule settings step, you can schedule your projects to automatically fetch new data.

Scheduling process data fetching is optional, and you can complete the process creation without setting a schedule for the process. If you do not schedule process data fetching when you create the process, you can schedule it later in the Data & Settings tab of your process page. For more information, see Scheduling process data fetching in process apps.

Scheduling provides the opportunity to refresh your data sources either by replacing or incrementally updating existing data:

  • If you choose the replacement method, the existing data source gets replaced. The previous project data source is disregarded. The new data source is processed based on your requirements: you can either choose how frequently your data is replaced or use a calendar to set a preferred timing for data replacement.

  • If you choose the incremental update method, new data is added on top of the existing project data source. Both the previous and the new data are used in your project.

Replacement method

To schedule process data fetching with the replacement method, complete the following steps:

  1. In the Schedule settings step, set the Enable a scheduling feature for future updates toggle to Yes.

  2. Select Replace existing data.

  3. Select the schedule type:

    • If you want to set the frequency of data replacement, complete the following steps:

      a. Select Frequency.

      b. Enter how often should the data be replaced.

    • If you want to set a preferred timing for data replacement, compelete the following steps:

      a. Select Calendar.

      b. Select the Yearly, Monthly, or Weekly periodicity.

      c. Depending on your previous choice, choose a date, days of the month, or days of the week.

      d. Choose the time and the time zone.

  4. Click Next to go to the Loading your data step.

Incremental update method

To schedule process data fetching with the incremental update method, complete the following steps:

  1. In the Schedule settings step, set the Enable a scheduling feature for future updates toggle to Yes.

  2. Select Incremental update.

  3. Set a preferred timing:

    a. Select the Yearly, Monthly, or Weekly periodicity.

    b. Depending on your previous choice, choose a date, days of the month, or days of the week.

    c. Choose the time and the time zone.

  4. Click Next to go to the Loading your data step.

Loading your data

The Load your data step is visible only the creator of the process app previously set the Is your user required to upload a file with their own data? toggle to *Required in the Define user input step in the Create Process App wizard. For more information, see Defining the user inputs.

To load the extracted data from your enterprise application to IBM Process Mining, complete the following steps:

  1. Upload the data file in the .zip format.

  2. Ensure that the file finished uploading and that the process app validated the data.

  3. Click Next to go to the Generate your process-mining project step.

Generating your project

The process app starts generating the project when you click Next in the Load your data step. You can see the progress of project generation by looking at the progress bar and by viewing the status of the following steps in project generation:

  • Transforming your data
  • Generating event log
  • Applying default analysis
  • Finalizing the project

The status can be PENDING, IN PROGRESS, COMPLETED, and ERROR.

When all steps are marked as COMPLETED, click Finish. You can also exit the process app wizard while project generation runs in the background. When the process app completes the project generation, you can access the new project from the Projects tab.