Setting up the WorkBook agent on server

Installing the WorkBook agent

This only applies to customers who host WorkBook on their own server.

NOTE: If your SQL and your IIS run on different servers, the agent should be installed on the IIS server (web server) and not the server running the SQL

First of all, download the agent that corresponds with the current version of your WorkBook.
You can find the current version of your WorkBook in the lower right corner on the login screen.

Agents can be downloaded from here:

WorkBook version 10.2
WorkBook version 10.1
WorkBook version 10.0

So if your WorkBook is running on version 10.2.114, click on the first link above to get to the version 10.2 site.
As the patch number would be .114, search for the file called workbookagentconsole_114.zip and download it.
Unzip this file to a folder in your WorkBook share (call the folder ‘wbAgent’ or something else that indicates that this folder contains files for the WorkBook agent).

Change the connection string

You need to change the connection string in the file called WorkBook.Agent.ConsoleRunner.exe.config so the agent connects with your WorkBook database.
The correct connection string can be found in the config file for your WorkBook Silverlight website.

Open the folder that contains the files for the Silverlight site and search for the config file called Web.
Right click this file and open it in an editor like Notepad++

2

Mark the three lines containing the connection string and copy them

3

Open the config file for the agent (the one called WorkBook.Agent.ConsoleRunner.exe.config’ in the ‘wbAgent’ folder) in an editor
Search for the same three lines and paste what you have copied from the Silverlight config file. The two connection strings should now be identical

Create a scheduled task

Open Task scheduler and create a new task called ‘wbAgent’ or something similar
Make sure the task is running with a user with the necessary rights and make sure these two settings are enabled

Set the triggers for this task like this
5

Let the task scheduler know which program to start by clicking the ‘Actions’ tab
6

Updating an existing WorkBook agent to a newer version

Your WorkBook agent must always run the same version as your WorkBook, so if your WorkBook has been updated, the WorkBook agent must be updated as well.

You can find the current version of your WorkBook in the lower right corner on the login screen.

Agents can be downloaded from here:

WorkBook version 10.2
WorkBook version 10.1
WorkBook version 10.0

So if your WorkBook is running on version 10.2.114, click on the first link above to get to the version 10.2 site.
As the patch number would be .114, search for the file called workbookagentconsole_114.zip and download it.
Unzip this file to a folder in your WorkBook share (call the folder ‘wbAgent’ or something else that indicates that this folder contains files for the WorkBook agent).

Before you can overwrite existing files for your current and running WorkBook Agent, you need to stop the scheduled task running this WorkBook Agent. Follow these steps:

*Open Task Manager and click the Processes tab, mark the running task called WorkBook.Agent.ConsoleRunner.exe and click End process. If you can’t find the task on the list, you might need to click Show processes from all users

*Open the folder containing the agent files and delete everything in the folder. You can’t delete the files unless you have stopped the task as mentioned above

*Unzip the new agent to this folder and change the connection string

Changing the connection string

You need to change the connection string in the file called WorkBook.Agent.ConsoleRunner.exe.config so the agent connects with your WorkBook database.
The correct connection string can be found in the config file for your WorkBook Silverlight website.

Open the folder that contains the files for the Silverlight site and search for the config file called Web
Right click this file and open it in an editor like Notepad++

2

Mark the three lines containing the connection string and copy them

3

Open the config file for the agent (the one called WorkBook.Agent.ConsoleRunner.exe.config in the wbAgent folder) in an editor like Notepad++
Search for the same three lines and paste what you have copied from the Silverlight config file. The two connection strings should now be identical

*Restart the task in the task scheduler, and you’re done

Check the version of your WorkBook agent

Right click WorkBook.agent.ConsoleRunner and check the properties for the application

 

Was this article helpful? Useful Useless 1/2 found this article helpful.