The component exposes a Server Action responsible for parsing a BPMN file, and has the following signature :

BPMN_File > Parse_BPMN_File

• Input Parameters
  • BPMNFile - Binary content of the selected BPMN file
• Output Parameters
  • BPMNStructure - Structured representation of the BPMN file content (all relevant OutSystems structures are public on the component)
  • JSON_BPMNStructure - JSON representation of the BPMN file content
  • Return - Return structure for the result of the operation (WasSuccessfull and Message, for both success and error conditions)

Simply drag and drop the public action in your action flow, provide the input parameters, and handle the return.

For the preview, the component exposes a public Web Block, with the following signature :

BPMN_Viewer > BPMNViewer

• Input Parameters
  • BPMNStructure - BPMN Structure to render on the viewer (returned from calling the public server action Parse_BPMN_File mentioned above)
  • IsClickable - BPMN Diagram is clickable?
  • HighlightBPMNElementId - Id of the BPMN Element to Highlight (usage combined with the previous input parameter)
• Events
  • ShapeClicked - Returms the Id of the clicked shape on the diagram
    • Clicked_BPMNElementId - Id of the BPMN Element that was clicked

Simply drag and drop the Web Block to yous page or block, provide the input parameters, and handle the event.