ProcessMaker API Documentation
Script Central

Export a BPMN-Compliant Process

Export a ProcessMaker Process that is BPMN 2.0 compliant.

Overview

Export Processes from ProcessMaker that are BPMN 2.0 compliant. An exported Process may then be imported in the following ways:

  • Import into ProcessMaker: Import a Process to the same or another ProcessMaker instance of the same product version.

  • Import into a third-party tool: Import into a BPMN 2.0 compliant third-party tool. All ProcessMaker features that are not part of the BPMN 2.0 specification are ignored.

The following ProcessMaker components are exported if they are specified in the Process:

ProcessMaker does not export users or groups associated with the original ProcessMaker Process. Therefore, Task element assignments are not exported and must be configured if the Process is imported to another ProcessMaker instance or third-party BPMN 2.0 modeler application.

An exported Process has the .json file extension.

Export a BPMN 2.0 Compliant Process

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

  • Processes: Export Processes

  • Processes: View Processes

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

ProcessMaker Processes that are not BPMN 2.0 compliant can be exported successfully. However, such Processes will not import successfully. Therefore, validate that your Process is BPMN 2.0 compliant before exporting it. See Validate Your Process is BPMN 2.0 Compliant.

Follow these steps to export a BPMN 2.0 compliant Process:

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

  2. Click the Export iconfor your Process. The following message displays: You are about to export a Process. User assignments and sensitive environment variables will not be exported.

  3. Click Download, and then browse for the location on your local computer to save the exported Process.

  4. By default, ProcessMaker exports the Process using the original Process name except spaces in the name are replaced with underscores (_). The file has the file extension .json. Rename the default file name if necessary, though do not change the file extension. As a best practice, specify in the file name that this is an exported ProcessMaker Process and not an exported ProcessMaker Screen or an exported ProcessMaker Collection.

  5. Save the file. ProcessMaker exports the .json file to your local computer or network. The following message displays when the Process exports successfully: The process was exported.

Related Topics