Documentation
Introduction
BPMN Modeler for Confluence is a Confluence plugin that helps create BPMN diagrams in specialized editor which is created by bpmn.io guys. It supports only BPMN.
Installation and setup
You can easily install this plugin following Installing Marketplace apps instruction. Just follow “Install a cloud app” section notes.
Once you install the plugin there is no any setup required.
Key Features and Functionality
BPMN Modeler for Confluence key features are:
BPMN Modeler
BPMN file uploading from local PC
Manual BPMN editing as xml (for advanced users)
Automatic synchronization between BPMN Modeler and XML editor views
Zoom In, Zoom Out, Fit In capabilities
Viewpoint alignment between BPMN Modeler and view on Confluence page. It helps focus on specific BPMN fragment.
Usage Instructions
Diagram creation
If you want to create a new BPMN diagram you may use a great Confluence macro for this. Just type /bpmn in the place that should hold BPMN diagram and click on ‘BPMN Diagram’
Once you clicked on the 'Bpmn Diagram', BPMN Modeler pops up and you can use palette for your BPMN diagram creation by dragging BPMN elements into the canvas.
Keep in mind that your changes will not go to the Confluence page till you press ‘Save’ button.
BPMN File Uploading from local PC
There is an ability to upload existing file into BPMN Modeler.
Use ‘Upload’ button on a toolbar and choose file you want to upload. BPMN Modeler supports .bpmn files produced by Camunda Desktop Modeler as well as Camunda Web Modeler exports.
Once you upload your local BPMN file into the BPMN Modeler you need to hit ‘Save’ button to persist your diagram on Confluence page.
Manual BPMN Editing as XML
Sometimes you want to have more grained control of your BPMN, this way you have an ability to modify BPMN as xml. Also it can be used when you already have BPMN file content in clipboard and just want to insert it into BPMN Modeler.
For doing this hit “XML” tab and modify/insert the BPMN content as xml. Keep in mind that BPMN representation defined in BPMN 2.0 specification quite strict for manual editing and it may lead to BPMN content corrupting and as a result empty UI view.
Always verify your changes by switching to the 'Diagram' tab and seeing the graphical representation of BPMN.
Zoom In, Zoom Out and Fit In Capabilities
In most cases BPMN Diagram can be quite big for the displaying on the Confluence page. Because of this everything on diagram can be small and unreadable if we display the whole diagram. For avoiding this confusion you can use three buttons located on the toolbar for setting up how the diagram should be represented on the Confluence page. Just zoom in/out and move view point into the desired BPMN location.
‘Save’ button pressing leads to diagram persisting on the Confluence page with user’s view point and zoom factor. See next picture.
Troubleshooting
If something goes wrong after manual BPMN editing, try to undo your changes.
FAQ (Frequently Asked Questions)
Q: Is possible to edit diagram in-place on Confluence page?
A: It’s not possible.
Q: What if I have Flowable, Activity, etc.. BPMN file and want to insert it into the BPMN Modeler?
A: You can give it a try. BPMN 2.0 specification declares strict xml representation for BPMN but other hand it allows user extend it by adding custom extensions that can break BPMN Modeler.
Q: Can I use xml representation somewhere else?
A: Absolutely! It’s compatible with Desktop Modeler as well as Web Modeler created by Camunda.
Q: I’m experienced Camunda developer. Why I don’t see Property panel?
A: Property panel is being used for specifying activity details on the diagram. That can’t change visual BPMN representation that’s why it’s not added.
Q: I have an idea! How can I share it with you?
A: I’m open for it! Just use my support channel.
Support and Resources
There is a great place for asking support and ideas sharing!