How to Install a New Patch - Patcher Tool Documentation

8 Months Ago


With the new tool Bizagi has for creating patches, our clients will receive a zip file with all the information of the new patch and the application that will automatically install it. In order to apply a new patch to your products, here is the process explained.

Applies to

Bizagi All versions.

What you need to do: 

How to install a new patch?

In order to install a new patch in a Bizagi product, you will receive a zip file with the patch to be installed. Once you extract that file, you will find the following items inside a folder named “patch”:


Figure 1. Inside the patcher folder after extracting the zip file.

Open the “Patcher” folder inside the extracted file and you will find the files with all the source code belonging to the patch (fixes made to the code). Look for and open a file called “GUI.Patcher.exe,” which will open an installation wizard that will take you through the process of installing said patch. Please, make sure you use the “Run as administrator” option as most of the time administration rights are needed.

Figure 2. GUI.Patcher.exe inside the Patcher folder.

Once you open it, the window will look like this (Figure 3):

Figure 3. First view of the installation wizard after opening the file “GUI.Patcher.exe” with administration rights.

This first window of the wizard (Figure 3) includes the information related to the patch to be installed: the version it applies to, the id number of this new patch, the applications to which it applies, a description of what the patch includes, and the Support ticket associated with the patch (since the majority of the patches are implemented to fix issues reported by our clients).

Finally, you will need to take into account the two tabs of this view, “Bizagi Applications” and “Bizagi Projects,” before executing the installation wizard and apply the patch.

Bizagi Applications

Applications are the components of Bizagi, such as Studio, Sites, MC, WebApp, and Scheduler. The source code of the patch contains the information of which application it applies to, so the corresponding checkbox will be ticked off. If you select one of the applications the patch does not apply to, the wizard will run normally but will not change that which it does not applies to.

Figure 4. The ticked checkboxes correspond to the information about "Applications to apply" included above. In this case, the only application the patch applies is the WebApp application, so that is the only one ticked off.

If one or more of the Bizagi applications do not have a specified path (see examples in Figures 5 and 6), you can edit the text field to include the location in which each application is installed.

Figure 5. Applications without path. Studio does not have a path associated, so it has no information about version or previous patches.