Import and Export BPMN
  • 19 Jul 2021
  • 3 Minutes to read
  • Dark
    Light

Import and Export BPMN

  • Dark
    Light

Overview 

Decisions provides the ability to utilize BPMN (Business Process Modeling Notation) in conjunction with the Flow Designer to create BPMN Diagrams. In addition to being able to create BPMN Flows and diagrams using the Toolbox, Decisions also provides the ability to Import BMPN XML files/convert them into Workflows and Export these diagrams as Decisions .obj files. This ability is provided via the Project Conversion Service and can be accessed via the Upload BMN XML or a POST call.

Note on BPMN Formatting 
Note that Decisions utilizes BPMN 2.0 notation to import/convert BPMN. 

The following document demonstrates how to use the Import and Export feature to utilize BPMN Diagrams within the Decisions Studio environment. 

Additional Documentation
For additional information on BPMN in Decisions, see Creating a BPMN Flow.

Example A: Upload BPMN XML  

The following example demonstrates how to Import a BPMN XML format file into the Decisions Studio environment through use of the Upload BPMN XML action.

Note on Example 
The following example utilizes a .bpmn file that was constructed using the demo BPMN builder at bpmn.io.

To use this tool, navigate to https://demo.bpmn.io/ 

To Import a BPMN File:

  1. Create and export a BPMN Diagram using a BPMN tool, or locate a BPMN XML file.
  2. Navigate to a Designer Project in Decisions Studio.
  3. Right-click the Designer Project then select  Import/Export > Upload BPMN XML.
  4. From the Upload BPMN XML window, use the CHOOSE FILE button or drag in a .bpmn file into the Drag file here field. Then click UPLOAD.
  5. Once the File Imports, open the imported Flow to verify that the BPMN Diagram has imported and been properly converted into a Flow.
    Note on Imported File's Name
    Note that if a Name is specified in the BMPN XML File, then the Flow will Import with the same name. Otherwise, the Flow will appear under the Name "BPMN Converted Flow"



Example B: POST Call

Note on POST Calls 
The following document utilizes sending a POST Call in Postman to upload BPMN XML.
For more information on POST calls see Post to Flow Behavior. 

To configure a POST Call as an alternate method of uploading BPMN XML: 

  1. From the Decisions Studio, navigate to System > Administration > Features > All Services
  2. Scroll to and right-click ProjectConversionService, then select View Integration Details
  3. Locate and select UploadBpmnProject
  4. From the UploadBpmnProject Integrations Page, under Credentials, select Specify User Credentials. Under Options > Rest Options, select POST. Then, under Output Type, select XML. Then copy the Using POST url
  5. Open Postman and create a new POST call; paste the URL into the Enter URL Request box. 
  6. Navigate to the Body tab and select raw. Back on the View Integrations Page, copy the Parameters content, then paste it into the Body text field. Configure the userid, password, and folderId values accordingly. 
    Additional Information on Call Configuration 
    folderId represents the designated location (Designer Project) that the Flow will import to.
    userid and password represent the user's login credentials for Decisions.
     
    Note, the default value for includeDataSteps is set to false, setting this value to true will import the BPMN with the inclusion of Data Input steps. 

  7. After the opening bpmnDiagramXml tag, replace StringValue, with the desired BPMN XML content, leading the text with <![CDATA[ and closing the text with ]]>. Then click Send.

    Note on CDATA Tag
    Ensure that the BPMN XML is encapsulated within the <![CDATA[ ]]> tag, Failing to do so will throw an error in the process and prevent the BPMN from importing. 

  8. Navigate to the designated Designer Project, then locate and open the newly imported Flow. 

  9. Verify that the Flow contains the expected Shapes, steps, and Annotations


Example C: Export

Note on Export Functions 
Presently, Decisions only offers the ability to Export a BPMN formatted Flow as a .dec obj file, for migration to other Decisions environments.

Functionality to Export BPMN Flows as .bpmn files is currently in development. 

To export a BPMN Workflow:

  1. Locate the desired Flow in Decisions Studio
  2. Right-click the Flow and select Import/Export > Export
  3. From the Export window, select either Item Only or Project under the What would you like to download options. Then click CONTINUE. 
  4. Once the item is ready, click DOWNLOAD. 

    Note on DOWNLOAD 
    Selecting DOWNLOAD will Export and download the desired Flow as a .decObj to the default Download location on the Local System



Was this article helpful?

What's Next