BPMN to XPDL Conversion Plugin

Introduction

The BPMN to XPDL Conversion Plugin is used to convert BPMN files (with either .bpmn or .xml extensions) into XPDL-compatible XML files that can be uploaded to the Joget Process Builder.

Plugin information

Plugins Available in the Bundle:

• BPMN to XPDL Conversion Plugin.

This plugin bundle is compatible with Joget DX 8 / 9 and onwards.

Get started

Prerequisites

• BPMN files (with either .bpmn or .xml extensions), the sample BPMN files can be downloaded here:
  • .bpmn file
  • .bpmn subflow file
  • .xml file

Where to get the plugin

You can download this plugin from the Joget Marketplace.

How to install

1. Log in before downloading the plugin.
2. Click Download on this plugin screen (It will be a .jar file).
   
3. Go to your Joget localhost or server. In the Joget Console, go to Admin Bar > Systems Settings > Manage Plugins and click the Upload Plugins button.
   
4. Under Upload Plugin, click Choose File and select the plugin .jar file you downloaded and click Upload.
   
5. You can now view your new plugin in the Installed Plugins and in your Form Builder.
   
6. Remember to uninstall the old plugin before uploading a new version.
7. The Joget Knowledge Base has more information on managing and developing plugins.

How to use it

1. Start the Joget server and open the App Center.
2. Log in as Admin and click Design New App.
   
3. Click Create New App.
   
4. Fill in the App ID and App Name, and click Save.
   
5. Click the + button at the Form Builder to create a new form.
   
6. Fill in the Form ID, Form Name, and Table Name, and click Save.
   
7. In the Form Builder, drag a File Upload element into the form and label it BPMN File Upload. 
   
8. Similarly, add another Fill Upload element into the form and name it XPDL File Retrieval. You may add other elements from the Palette to the form as needed.
   
9. Click Apply Change > Save > Generate App.
10. Tick the box of GENERATE CRUD and click Generate.
    
11. Close the window.
12. Click Settings > Advanced, then select BPMN to XPDL Conversion as the Post Processing Tool and set Run Tool on to Both data creation and update.
    
13. Click Configure BPMN to XPDL Conversion, then select Sample Form as the Form for BPMN File and XPDL File.
    
14. Choose bpmn_file_upload (BPMN File Upload) as the Field for BPMN File and xpdl_file_retrieval (XPDL File Retrieval) as the Field for XPDL File.
    
15. Click Save and Publish the app from the App Composer.

Converting a BPMN File to XPDL File

1. Launch the app.
2. Click Manage Sample Form > New.
   
3. Upload a BPMN file at the BPMN File Upload field and fill in other fields as needed, except for the XPDL File Retrieval Field.
   
4. Click Save.
5. There is an XPDL file for the new record, as shown in the following list. Click Edit at the new record.
   
6. Click the xpdixml.xml to download it.
   

Upload the XPDL File into the Process Builder

1. Click Admin Bar > App Composer.
   
2. Click the + button to add a new process.
   
3. Click XPDL.
   
4. Click Upload XPDL.
   
5. Click Choose File > xpdixml.xml > Upload.
   
6. Click Save > Design. You will see that the XPDL file has been successfully imported and that a new process has been generated accordingly.
   

Configure BPMN to XPDL Conversion Plugin Properties

Fields to configure:

BPMN File

• Form: Form where the BPMN File Upload Field resides
• Field: BPMN File Upload Field
• Record Id: Record ID of form record; if not filled, the default value will be the current process record ID.

XPDL File

• Form: Form where the XPDL File Upload Field resides
• Field: XPDL File Upload Field
• Record Id: Record ID of form record; if not filled, the default value will be the current process record ID.

Expected Outcome

The user can import the converted BPMN files into the Joget Process Builder. The following images show a BPMN file created in BPMN.io (.bpmn file) and its counterpart in the Joget Process Builder.

The following images show a BPMN file with a subflow created in BPMN.io (.bpmn subflow file) and its counterpart in the Joget Process Builder. For more information regarding subflow, please refer here.

The following images show a BPMN file created in Visual Paradigm (.xml file) and its counterpart in the Joget Process Builder. 

Download plugin 

Download the plugin from Joget Market Joget Marketplace.

Download Sample App