Publish to SharePoint - available in Modeler Services

<< Click to Display Table of Contents >>

Navigation:  Bizagi Modeler > Generating Documentation > Premium publishing >

Publish to SharePoint - available in Modeler Services

Overview

As part of Modeler Services premium options you can publish your completed documentation and share it with your organization in the SharePoint format. You can either publish to SharePoint Online or On-premises.

Customize the output information for inclusion in your document by selecting the diagrams and the elements to be included.

 

Considerations

SharePoint On-premises: Before publishing, make sure you have SharePoint installed.

SharePoint Online: Before publishing make sure to set the SharePoint online configuration:

 

SharePoint Online configuration:

Make sure to set the Sharepoint Online configuration before publishing:

 

Make sure that your site was created as a Site Collection in the SharePoint Online tenant.

Allow custom scripts in your site. To do so, follow this steps:

oLog in with your Office 365 credentials of an administrator user.

oNavigate to your Site Collection's settings by selecting Show more (on the left panel) > Admin centers > SharePoint > Site collections > settings.

oEnable the Custom Scripts option by leaving their value in "Allow" in the two separate selections that are presented.

oClick OK.

oBear in mind that it might take up to 24 hours for the changes to take effect.

Download the latest SharePoint Management Shell.

Connect to SharePoint Online as global admin.

Run the following commands on your SharePoint shell, line by line and making sure to replace the placeholders for:

o[ADMINISTRATOR_EMAIL] refers to a SharePoint administrator's email address.

o[ORGANIZATION_NAME] refers to the name of your Office 365 Organization.

o[PASSWORD] refers to the corresponding password for the specified user.

 
$adminUPN="[ADMINISTRATOR_EMAIL]"
$orgName="[ORGANIZATION_NAME]"
$userCredential= Get-Credential -UserName $adminUPN -Message "[PASSWORD]"
Connect-SPOService -Url https://$orgName.sharepoint.com -Credential $userCredential
Set-SPOsite https://$orgName.sharepoint.com -DenyAddAndCustomizePages $false

 

Before allowing custom scripts on sites in your organization's SharePoint, make sure that you acknowledge and agree with the security implications.

Bizagi provides an intuitive wizard to help you through the steps to generate your documentation.

 

How to Publish to SharePoint

1. In the Publish tab, in the Process documentation group, click SharePoint.

 

GeneratingSP1

 

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.

 

GeneratinWord3

 

note_pin

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. 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.

 

GeneratingWiki6

 

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 GeneratinWeb0 button.

Once finished, click the Next button.

 

GeneratingWiki7

 

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.

 

GeneratingWiki8

 

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.

 

GeneratingWiki14

 

To filter by roles, expand the by role element and select the roles you want to use in the filter, Then click Apply.

 

GeneratingWiki15

 

You can individually select elements from each diagram marking their checkbox.

 

GeneratingWiki9

 

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..

 

GeneratingWiki10

 

Click the GeneratinWeb18 button to order the elements automatically or click the GeneratinWeb0 button to order the elements alphabetically.

When you are satisfied with the order of the elements for each diagram, click the Next button.

 

7. Select the SharePoint environment you wish to publish within: SharePoint Online or Sharepoint Server (on-premises):

 

7.1 If you select SharePoint Online, provide the SharePoint site Url, and click Next.

 

Generating6_1

 

If you are not logged in, the application drives you to the SharePoint log in portal.

Provide your credentials and click Next.

 

Generating6_3

 

7.2  If you select SharePoint Server (on-premises):

The SharePoint site must already be created.  You need to provide the location and user credentials to access it. Then click the Next button.  

 

Generating6_2

 

8. Specify the appropriate folder in which to publish your process. This folder must have Read and Write permissions. Click the Finish button.

 

GeneratingSP3

 

Hover the mouse over any of the folders displayed and select generatingSP11 to create a new folder inside the selected folder. Provide the folder name in the following dialog.

 

generatingSP12

 

note_pin

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.

 

GeneratinWeb23

 

Once the process has been published on SharePoint, you will be able to view your diagram documentation.

 

note_pin

After clicking Finish on the last step of the process, you will be redirected to your browser to access SharePoint to navigate the newly published documentation. If you are using Internet Explorer and provided the wrong credentials it is possible for you to get stuck, not being able to log into your SharePoint account, since Explorer tries to perform the log in with the wrong credentials. To solve this you need to delete your passwords from the Windows Credentials Administrator.

 

SharePoint Output

 

GeneratingSP4

 

The legend displayed when the mouse is hovered over each process is defined in the Diagram properties.

All other documentation included will be displayed when clicking over each element.

 

GeneratinWeb20

 

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.

 

GeneratingSP7

 

To perform quick searches on the Process Elements, use the search field.

 

GeneratingSP8

 

To go back to the general view, click the Bizagi Modeler Logo.

 

GeneratingSP9