As part of Modeler Services premium options you can publish your completed documentation and share it with your organization in Web format.
Customize the output information for inclusion in your document by selecting the diagrams and the elements to be included.
You may view the Web documentation from a browser. To review the supported browsers, refer to the system requirements.
Bizagi provides an intuitive wizard to help you through the steps to generate your documentation.
1. In the Publish tab, in the Process documentation group, click Web.
2. If your model is stored in the cloud use the Profile name combo to select the profile used to publish the models. For models stored locally or Personal plans, this combo is disabled.
By default, the profile My profile is selected to publish your models, if you want a new model, click create new profile option. This profile is private for the current user. Each user has a private profile
3. Select the diagrams that you wish to publish. Click the Search and select diagrams to publish field. Type the diagram name to filter the available diagrams, while you type, the wizard show you the diagrams which fits with the input name.
You can select one or more diagrams by checking the check box next to the name, if you use the filtering options, the selected diagrams remain.
When all the diagrams you wish to publish are selected, click the Apply button.
4. Choose the order in which you wish to publish your diagrams by using drag and drop features. Alternatively, you can sort them alphabetically by using the button.
Once finished, click the Next button.
In this step, you can override the publishing options for the current publish by click the Publish options link. The options are:
•Exclude artifacts: When enabled, the application does not include artifacts on the publishing.
•Black and white: When enabled, the publish exports the diagrams in black and white colors.
•Exclude unused resources: When enabled, the application does not include resources which have not been included on any task's basic element properties' RACI Responsibility Roles. It means, the publishing includes only the resources which were used at least in one task.
5. Each diagram and their elements appear in the collapsible panel on the right. Select per each diagram the elements that you wish to publish in the documentation.
You can select all elements across all diagrams using the select all checkbox. By checking this checkbox ALL your diagrams and their elements will be marked as elements to publish. Any individual diagram configuration will be lost.
Using the left panel, you can filter the elements of the diagrams either by element type or role.
When you select one or more element types, the elements that match this type are displayed in the right panel. When you filter the elements, all the selected elements in the right panel remains even they are not displayed.
To filter by roles, expand the by role element and select the roles you want to use in the filter, Then click Apply.
You can individually select elements from each diagram marking their checkbox.
You can also use the sort by combo to let you sort the elements either alphabetically or as they appear in the diagram. This order does not affect the order in which the publication is displayed, but lets you find the elements when the model has several diagrams and elements.
Click Next, when you have included the elements in your publish.
6. The selected elements appears in this step. For each diagram select the order in which you wish the elements to be exported. Each diagram selected appears a s a collapsible panel.
By default elements are organized according to the sequence of the process flow. You can use the drag and drop features to set the order as you desire.
Click the button to order the elements automatically or click the button to order the elements alphabetically.
When you are satisfied with the order of the elements for each diagram, click the Next button.
7. Specify the appropriate folder in which to publish your process. This folder should have Read and Write permissions.
If you use the Profile features and you have not saved the changes in the profile, The wizard prompts you to save the changes before publish. Saving is not mandatory.
Once the process has been published on the Web, you will be able to view your diagram documentation.
Generated documentation will show your selected processes in an initial Home page.
The description is displayed when the mouse is hovered over each process.
At any time, you may go into the Full screen mode (specially useful to present or view wide diagrams) by clicking on the Full screen icon located at the top right corner:
Exit full screen mode by pressing the Escape key (ESC) or clicking on the Full screen icon again.
Further documentation included will be displayed when clicking over each element.
Click on your process to see the detailed information.
You will be able to see the documentation of any diagram element by clicking on it.
To exit from the details popup, close it or click anywhere else in the diagram.
If you want to access a specific Diagram form an external location using a Hyperlink to open a process directly, instead of opening the Home page, open the desired process and copy the entire URL. This URL can be used as hyperlink and the process will be opened directly.
To perform quick searches on the Process Elements, you may use the search field.
Notice that while searching on the Home page, you will be by default searching over all of your processes:
To search only in a given process, you may quickly first click on that process:
In addition to this, at any time as well, you may use the pan option for quick navigation in the diagram, or use zoom options which appear at the bottom part of the diagram when hovering the mouse in that zone:
To go into detail of a Sub-process diagram o to display any of the presentation actions, you may click on the small icons which appear at the top right corner of shapes, whenever the mouse is hovered on them:
Presentation actions configured for an element are those same which are set for the presentation mode:
If you want to have the process documentation available to be downloaded and printed from inside the Web documentation, we recommend publishing first to Word or PDF and then saving the documents in a file server.
Finally, link the URL path to that Word of PDF document as an Extended attribute so that it is shown in the Web documentation.