WorkBook Update Tool

Introduction

The WorkBook Update Tool is used when updating existing WorkBook installations. It is also used to install the initial web sites, however a WorkBook database is required for the tool to work. This database must be installed manually. For installing WorkBook and its database see the article Installing WorkBook.

WorkBook Update 6 can be downloaded from our update site

If the software is already installed on your server and you’re prompted to download the latest version when starting it, just click Yes.

Open the tool

When you open the WorkBook Update Tool, start by elevating it into administrator mode. This is extremely important.

Frontend paths

This text field and associated browse button allows you to select an existing installation from the server.
Browse for the file called Web.config placed in the folder for your WorkBook website (the Silverlight website)

Database Info

The database info area is one of the most complicated areas. This area is used to specify how the tool should connect to the WorkBook database.

If you have selected an existing installation with a valid Web.config file in the Frontend Path field as described above, this area will be filled automatically and you can proceed to next step

Server: The name of your SQL server. If you have more than one SQL instance running on the same SQL server, the server name must be followed by a \ and the instance name in question
Username: Insert a user name to run the update. The user must be system administrator for the particular database you want to update
Password: A valid password for that user name
Database: This drop-down shows you a list of databases the user has access to. Simply pick the WorkBook database you wish to update
Connection String: This field will automatically be filled out by combining the inputs from the first four fields

Paths

These text fields with accompanying browse buttons allows for the selection of destinations for the various files associated with WorkBook.

Silverlight Path: The folder to which website files for the Silverlight version are copied
V9 Website Path: The folder to which website files for the HTML version are copied

Note: If you browsed for a valid Web.config file in the very first field Frontend Path, the fields Silverlight Path and V9 Website Path will be filled in automatically

Update options

These boxes should always be ticked:
SilverlightV9Patch and Static DataOptional features:
Use HTTPS and Use HTTPS (Reverse Proxy): see this link
Backend: Tick this box if your WorkBook needs to be updated to a new major version (e.g. version  9.5.x.xxx → 9.6.x.xxx)

Start and progress

When you are absolutely sure all fields and boxes are filled out and ticked, simply click the Start button to start the update.
You will see a progress bar left to the Start button. As long as this bar is active, the update is still running.You can double click the line in the bottom if you want to see how the update progresses.

done

When you see this box, the update is done and users can log into WorkBook again

 

 

On errors

If an error occurs during the update, the update tool will stop immediately with an info box on what went wrong. If this happens, the update tool will roll back everything to start. In other words: nothing is changed in the database – it is in the same state and on the same version as before you started the update, and users can log in again.

You might get something from the log file to identify what went wrong, but you can always just send the log file to support@workbook.net and leave us to decode it.

WorkBook agent

Next step is to update your WorkBook agent. Click HERE to see how this is done

Was this article helpful? Useful Useless 3/4 found this article helpful.