ProcessMaker API Documentation
Script Central

Import a ProcessMaker Version 4 Process

Import a Process that has previously been validated and exported from ProcessMaker version 4.

Overview

Importing and exporting Processes in your organization makes it easy for Process designers and business analysts in your organization to share business processes. You may have a respected colleague in another department or office that has designed a Process using ProcessMaker version 4 for her team. If you are also using the same ProcessMaker version, you can import her Process to use in your team.

Import validated ProcessMaker Processes that have been exported from the same ProcessMaker version. A validated ProcessMaker Process is BPMN 2.0 compliant and has been validated in Process Modeler before that Process was exported. The Process can be imported from the same or different ProcessMaker instance. Exported ProcessMaker Spark Processes have the .json file extension.

The following ProcessMaker components are imported from a validated ProcessMaker Process if they are specified in that Process:

ProcessMaker does not import ProcessMaker users or groups associated with the original Process. Therefore, Task element assignments are not imported. However, as part of the importing procedure, you have an opportunity to assign ProcessMaker users, groups, and Process configuration settings.

Import a Validated ProcessMaker Version 4 Process

Your ProcessMaker user account or group membership must have the following permissions to import a ProcessMaker version 4 Process unless your user account has the Make this user a Super Admin setting selected:

  • Processes: Import Processes

  • Processes: View Processes

See the ProcessMaker Processes permissions or ask your ProcessMaker Administrator for assistance.

Follow these steps to import a validated ProcessMaker version 4 Process:

  1. View your active Processes. The Processes tab displays.

  2. Click the Import button. The following message displays: You are about to import a Process. After importing, you can reassign users and groups to your process.

  3. Click Browse to locate the ProcessMaker version 4 Process to import. ProcessMaker version 4 Processes have the .json file extension.

  4. Click Import. The Import Process screen displays the following:

    • Status: The Status section displays an overview of which Process components imported successfully. If the imported Process contains package features that are not available in the ProcessMaker instance, one of the following occurs:

      • Packages are installed in your ProcessMaker instance: The Status section indicates which package features are installed in your ProcessMaker instance.

      • Packages are not installed in your ProcessMaker instance: The Status section indicates which package features are not installed in your ProcessMaker instance.

    • Configuration: Use the Configuration section to assign whom in your organization can participate in your imported Process to make the Process functional.

    Below is an example of an imported Process.

  5. From the Configuration section, assign whom in your organization can participate in your imported Process. Follow these guidelines:

    • Assign each Start Event element to the ProcessMaker user and/or group

      Assign which ProcessMaker user and/or group can start a Request of your imported Process. Type into the Assign Start Event setting to filter ProcessMaker users and/or groups that display in that setting's drop-down menu.

    • Assign each Task-type element to the ProcessMaker user and/or group

      Assign which ProcessMaker user and/or group is to do each Task-type in the Process. In doing so, optionally use either of the following special assignments:

      • Requester: Use the Requester special assignment option to assign that Task-type to the ProcessMaker user who started the Request.

      • Previous Task Assignee: Use the Previous Task Assignee option to assign that Task-type to the ProcessMaker user who did the previous Task-type in the Process.

    • Assign which ProcessMaker user and/or group can cancel Requests

      Assign which ProcessMaker user and/or group can cancel Requests for your imported Process. If no user or group are selected, no one can cancel a Request from this Process. Type into the Assign Cancel Request setting to filter ProcessMaker users and/or groups that display in that setting's drop-down menu.

    • Assign which ProcessMaker user and/or group can edit Request data

      Assign which ProcessMaker user or group has permission to edit Request data from this Process. By editing Request data, these users and group members can adjust the data that Request participants have submitted during a Request. If no user or group are selected, no one can edit Request data from this Process. Type into the Assign Edit Data setting to filter ProcessMaker users and/or groups that display in that setting's drop-down menu.

    • Assign which ProcessMaker user can run Scripts

      Assign the ProcessMaker user whose credentials are used to run the Script. Type into the Run script setting to filter ProcessMaker users that display in that setting's drop-down menu.

    • Assign which Process can call an activity

      Assign which process will be assigned to a Sub Process or an Action by Email element. Type into the Assign Call Activity setting to filter Processes that display in that setting's drop-down menu. The Actions by Email package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Actions by Email package can be installed in your ProcessMaker instance.

  6. Click Save. The Processes page displays the imported Process. If the process already exists with the same name, it is renamed with a number "2" suffix.

If the original ProcessMaker version 4 Process cannot import successfully, the following message displays: Unable to import the process. Ensure that the original ProcessMaker Process validates as BPMN 2.0 compliant.

Related Topics