Skip to main content

Getting Started

  1. Start Enterprise Architect and load OpenFMB UML model


  2. On "Project Browser" window, right click on "OpenFMB", select "Specialize", "OpenFMB Protobuf Exporter", then click on "Export to proto files..." to launch to add-in tool


  3. The OpenFMB Protobuf Exporter will build a Tree View containing the model information with check boxes next to the Tree Nodes that are specific to the generation of the Protobuf files in the left pane and processing information in the right pane. Since it is used by the other modules, the Common is always checked.



    By default, all the modules are checked. Uncheck the modules that you do not want to be generated.

  4. Click on Export Protobuf button to start exporting

  5. When the generation process completes with no errors, the “Save Protobuf” button will be enabled. Clicking the “Save Protobuf” button will bring up a “Browse For Folder” window to allow the user to browse to the directory where the Protobuf files will be saved. When the save process completes, the right pane will display the Protobuf files saved with their absolute paths and the message “Save complete…”


    The save process will create the Protobuf directory structure if it does not exist. If the directory structure does exist, then the save process will overwrite the existing files. The Protobuf directory structure under the user selected directory is openfmb/Protobuf Module Name.

  6. Errors during exporting protobuf

    If an error is encountered during processing, the following will be displayed after all error messages:

    • An error was encountered while generating the proto3 files.
    • The saving of the proto3 files has been disabled.
    • Please correct the error(s) listed and regenerate the proto3 files.

    At this point the user has the following options:

    • Reselect the nodes that do not have errors and generate the Protobuf information. This option will not export a full set of Protobuf files.
    • Close the Tree View window, fix the errors, and re-export the Protobuf information