Installing or upgrading 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 >

Installing or upgrading the Web parts

What you need to do

Installing Bizagi Web parts for SharePoint can be carried out in two ways: through an installer which will guides the procedure, or by manually deploying the Web parts from a WSP file (Windows SharePoint file).

For more information about this feature, refer to Bizagi Web parts for SharePoint.

 

This article describes how to install or update Bizagi Web parts in a SharePoint server through either way.

 

Before you start

It is strongly recommended that a SharePoint administrator (having expertise on deploying solutions to web farms) carries out this installation, especially when choosing to install the add-on by deploying the WSP file.

 

Further prerequisites for your SharePoint server in order to use Bizagi Web parts are:

Have your SharePoint configured by following the best practices enforced by the vendor (Microsoft).

Keep in mind that within such best practices recommended by SharePoint, it is fundamental to install SharePoint under a domain (without using local accounts, which is not supported).

For further detail about this, and to view the list of SharePoint's requirements, refer to their official page at http://technet.microsoft.com/en-us/library/cc262485%28v=office.15%29.aspx.

 

Ensuring you have SharePoint Timer Services enabled, and in a started status.

Ensuring you have SharePoint Administrator Services enabled, and in a started status.

 

SPWB_Prerequisites

Having a service account that has Web farm administrator rights.

This account is to be used for the connectivity between SharePoint and Bizagi and it will need to:

oBe a domain account.

oHave administrator rights at the Bizagi Server.

oHave execution permissions for Bizagi Work portal.

oBe created as an user in Bizagi (especially to configure the process button web part).

 

Ensuring that your site collection is configured to use the same base URL of your web application.

For example: http://[SharePoint_server].

This URL must not specify any additional suffixes (e.g: http://[SharePoint_server]/[site]/).

 

Following all usual and regular recommendations, which are oriented towards hardware and software configuration and tuning in SharePoint.

Refer to https://technet.microsoft.com/en-us/library/cc262485.aspx#hwforwebserver for official information.

Consider that Microsoft encourages the use of a SharePoint 2013 Standard or Enterprise edition.

 

Supported versions

Web Parts are supported in SharePoint 2010 or SharePoint 2013 installations.

All editions are supported (Enterprise, Standard or Foundation).

 

SharePoint installations must be set On-Premise.

 

note_pin

Bizagi Web parts are not shown within a responsive content.

This means that these web parts will not be displayed in mobile devices or tablets.

 

 

Configuration in Bizagi

Keep in mind that this integration scheme relies on the Single Sign-On capabilities provided by an integrated type of authentication (both set in Bizagi and in SharePoint).

For this, there are 2 alternatives that consider integrated authentication: Windows authentication or Federated authentication.

 

Option #1: Windows authentication.

You will need to set the authentication in Bizagi as shown:

 

Authentication_Windows

 

Furthermore, Anonymous authentication needs to be disabled at the IIS for Bizagi Work portal.

The required configuration towards authentication in Bizagi Work portal should be as shown below:

 

BizagiSP01

 

And, in SharePoint you would similarly use Windows authentication.

 

Option #2: Federated authentication.

You will need to set the authentication in Bizagi as shown below, making sure you also configure the parameters regarding your identity provider:

 

SSO_Federated

 

 

And for this, in SharePoint you would similarly configure a Federated authentication against the same identity provider.

 

Web parts Installation

Refer to the 2 alternatives presented in the sections below to either: install the Web parts from an executable installer, or to manually deploy a WSP file.

 

note_pin

Installing the Web parts will eventually restart your SharePoint Web applications.

Therefore, make sure you schedule this step and execute it at non-working hours, and that you take the proper cautions.

 

1. Running the Web parts installer

Once the prerequisites are met, installing Bizagi Web parts in your SharePoint is simply done by running an installer. To do so, follow these steps:

 

1. Download Bizagi Web parts for SharePoint, as an add-on installer from Bizagi SharePoint resources.

Make sure you choose the appropriate installer for your SharePoint version (2013 or 2010).

 

2. Unzip the downloaded file and run the installer's exe file for the Web parts add-on installation.

Use the Bizagi.SharePoint.Installer2013.exe or Bizagi.SharePoint.Installer2010.exe executable file according to your SharePoint server version:

 

SP_shortcut

 

A wizard will guide you through the installation process.

Click Next.

 

SPv2_01

 

The installer will recommend you to review the prerequisites and run a system check to make sure these are met.

Once this is successful, click Next.

 

SPv2_02

 

The installer will validate if there is an existing installation of Bizagi Web parts.

When installing for the very first time, no existing solution will be found and you may click Next.

If you are updating to a newer Bizagi Web parts installation, you will be shown with the possibility to upgrade the installed version.

 

SPv2_02alt

 

Make sure you carefully read and accept the End-User license agreement.

 

Notice you may also use the installer to uninstall Bizagi Web parts.

 

Mark the SharePoint sites of your site collection and farm, so that you select those in which you will install Bizagi Web parts for SharePoint.

 

SPv2_03

 

Make sure you tick both the Bizagi.SharePoint.WebpartsConfig and Bizagi.SharePoint.Widgets items.

Click Next.

 

SPv2_04

 

Verify the installation preferences on the Summary shown.

Click Next when you are done, in order to start with the installation.

 

SPv2_05

 

Once the installation has been completed, you may close the wizard.

 

2. Manually deploying the Web parts

Once the prerequisites are met, follow these steps:

 

1. Download from Bizagi SharePoint resources the Bizagi Web parts for SharePoint, as a zipped wsp file.

Make sure you choose the appropriate one for your SharePoint version (2013 or 2010).

 

2. Unzip the downloaded file into a local path of one of your SharePoint WFE servers (recommended to use a server having central administration role).

This local path will be referred to as <BIZAGI_WSP_PATH>.

 

Notice this will uncompress these two WSP files.

 

For SharePoint 2013, these are: Bizagi.SharePoint2013.wsp and Bizagi.SHP2013.FieldPass.wsp.

 

For SharePoint 2010, these are: Bizagi.SharePoint.wsp, and Bizagi.SharePoint.FieldPass.wsp.

 

SPWB_WSPPath

 

Notice in this example, our <BIZAGI_WSP_PATH> is C:\Installer\WSP.

 

3. Run the SharePoint Management Shell.

Make sure you run it as an administrator.

 

SPWB_RunMgmShell

 

4. Run the following commands to install the 2 WSP files:

Add-SPSolution -LiteralPath <BIZAGI_WSP_PATH>\Bizagi.SharePoint.wsp

 

SPWB_AddSolution

 

Once this is installed, run as well:

Add-SPSolution -LiteralPath <BIZAGI_WSP_PATH>\Bizagi.SharePoint.FieldPass.wsp

This command and wsp installs a set of controls used mainly when configuring the Web parts connection to Bizagi.

 

note_pin

If you already have the Web parts installed, and need to do an upgrade (i.e to a newer release), run the following command:

Update-SPSolution -Identity Bizagi.SharePoint.wsp -LiteralPath <BIZAGI_WSP_PATH>\Bizagi.SharePoint.wsp -GACDeployment

 

Note that before upgrading, you will need to backup the bizagi.custom.styles.css overrides file if you have included any customizations.

 

 

5. Run the SharePoint Central Administration.

 

SPWB_RunCentralAdm

 

6. Browse to the System settings section, to the Farm Management options, and into the Manage farm solutions option.

 

SPWB_CA01

 

7. Deploy both WSP solutions.

Bizagi.SharePoint.wsp and Bizagi.SharePoint.Fieldpass.wsp.

 

 

To do this, first click on bizagi.sharepoint.wsp.

 

SPWB_CA02

 

Then click on Deploy solution.

 

SPWB_CA03

 

Make sure you select the specific sites to which you want to include Bizagi Web parts.

Once you click Ok, take into account that the SharePoint Central Administration will restart the application pools of your SharePoint sites whenever this deployment is executed (meaning, it will temporarily disrupt the SharePoint site and its services).

 

SPWB_CA04

 

Then, make sure you repeat this step for bizagi.sharepoint.fieldpass.wsp.

This means, click on it, and then on Deploy solution to run or schedule its deployment to the SharePoint sites.

 

You may verify a successful Web parts installation by following the step described below.

 

Verifying the installation

You may verify that Bizagi Web parts were successfully installed by accessing your SharePoint site through a browser.

 

Make sure that the Bizagi Web parts components are active for your site collection.

This can be reviewed through the Site collection features option:

 

SPWB_Check04

 

 

You should be able to see 2 Bizagi features installed and active: Bizagi.SharePoint.WebPartsConfig (used for the central Web parts configuration), and Bizagi.SharePoint.Widgets (containing the actual Bizagi Web parts).

 

SPWB_Check03

 

 

note_pin

No actions are needed at these verification steps.

You may only need to reactivate these (by using the Deactivate button and then the Activate button), to force a refresh of the Web parts, but that is only if: you have recently updated the WSP file and the newer file contains new Bizagi Web parts.

 

Similarly, you may browse to the Web parts option, and check that these are now listed at the SharePoint galleries:

 

SPWB_Check01

 

By ordering the list according to those which belong to the Bizagi group, you may see the newly listed Web parts:

 

SPWB_Check02

 

At this point, we are done installing Bizagi Web parts for SharePoint and we have verified their successful installation!

 

The next step is to configure the connection to your Bizagi Work portal, and then your SharePoint Web designer may include the Web parts into SharePoint pages.

For more information about the next step, refer to Configuring Bizagi Web parts.

 

 

Web parts upgrade and uninstall

If you are updating to a newer Bizagi Web parts installation or uninstalling the Web parts, run the installer as well.

You will be shown with the possibility to upgrade the installed version or remove the installed Web parts:

 

SPv2_02alt