Configuring the Web parts

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Portals integration > Bizagi Web parts for SharePoint > Bizagi Web parts for SharePoint On Premises >

Configuring the Web parts


This article describes how to configure Bizagi Web parts for SharePoint, once you have already installed them to your SharePoint server.

For more information about Bizagi Web parts and their installation, refer to Installing the Web parts.



What you need to do

Before you start to use Bizagi Web parts, make sure you perform the initial Web parts central configuration (required only once), to specify details regarding  the connection between your SharePoint server and your Bizagi Work portal.



Web parts central configuration

The following configuration is carried out on SharePoint sites and may be achieved through a browser.


1. Locate the Site actions drop-down option, and click on Site settings.

You will see the installed Bizagi Web parts under the SharePoint Extensions category.


Click on Bizagi Configuration.






2. Locate the Configuration list at the right hand side, and click on it.

You will see a list which can contain one or more items.


3. Add a new item and enter its details (namely connection details) as described:

Bizagi project name: The name that identifies this item's purpose (connecting to a specific Bizagi Work Portal).

It should be unique and meaningful towards representing the Bizagi project to be integrated.

Bizagi project URL: The URL location to your Bizagi Work portal.

Should be specified as: http://[BIZAGI_SERVER]/[PROJECT_NAME]

Description: A meaningful description.

Service account: The name of the account used to connect to Bizagi.

Keep in mind that this service account is involved for the actual configuration and runtime (even though, the user's Windows credentials are also used for his or her Bizagi access).

Service password: The password of that account used to connect to Bizagi.

Service domain: The domain for that account used to connect to Bizagi.



The service account used to configure the Web parts (as well as end users accessing the Web parts) needs to be created as a user in Bizagi.

The service account requires administrator rights on Bizagi plus the possibility to start processes.






Click on Save to complete the Web parts central configuration.



Changes in the configuration list will most likely require an IISReset of your SharePoint services.


Notice that:

You may click on Edit Item to modify the connection details anytime.

You may also choose to add additional items (should you be integrating with more than 1 Bizagi Work Portal).





Once you have completed the Web parts central configuration, you are ready to start using Bizagi Web parts for SharePoint directly in SharePoint content.

For more information about this, refer to Using the Web parts.



Additional considerations

Follow these considerations when using the Web parts.


1. Windows authentication

Keep in mind that you need to set your Bizagi project to use Windows authentication. For this, make sure that:


In Bizagi, Windows authentication is selected:




At the IIS authentication settings, Anonymous authentication is disabled (only Windows should be enabled):





2. IIS optimization settings

When integrating Bizagi in portals, it is recommended to adjust the settings for your Bizagi Work portal so that resources stored in the IIS cache are not disposed as frequently.

This is recommended given that users will not be accessing Bizagi Work portal on a regular basis (i.e, on a daily basis).


For Bizagi work portal setting at the IIS, you would need to edit its application pool so that recycling is optimal for your demands.

This would imply:

Disabling Recycling by assigning Regular time interval to zero.

Editing the Idle Time-out minutes so that information in worker processes and cache are not disposed in a short period of time (e.g two days).





3. Internet Explorer considerations

Keep in mind that in order for Bizagi web parts to be displayed, you will need to check browser support as posted at Bizagi requirements, especially for Internet Explorer since there are old versions which are unsupported, regardless if you are using them on your SharePoint environment.



4. Setup for the geolocalization feature

If your Bizagi project enables the Geolocalization feature, make sure you perform the following adjustments to your SharePoint site configuration:


Edit the SharePoint site's web.config file in order to include the following custom header (inside of the <customHeaders> element):
<add name="X-UA-Compatible" value="IE=edge" />


This means that you will need to locate the whole <system.webServer> element.

In it, you should have a definition looking somewhat as the image below:




Save the changes.


Note that in order for this to work, the master page in SharePoint must NOT include:

<meta http-equiv="X-UA-Compatible" content="IE=8"/> 



5. HTTPS and certificates

If you are using HTTPS on your Bizagi server, make sure that its server certificates are valid and up-to-date. Otherwise the web parts will not be able to connect to Bizagi services.