Setting up calendar sync agents
Psssst. you can find FAQ’s about the new agent here.
Calendar synchronization uses workbook agents, which can be found under Settings, Advanced tools, Agent setup. For information on how to use the agent system, please refer to this guide. For more information on setting up Workbook to use calendar synchronization, please refer to this guide.
Creating the agent
In workbook, there exists two calendar agents: “Calendar Worker” and “Calendar Worker V9 engine“. The V9 version is preferred as it is less taxing on the database, and as a result can run more frequently than the other version, which is limited to two hours. The V9 version can be set to run at any interval. Be advised that for the V9 version to work, the system must have a working V9/HTML system in place, and that the initial calendar synchronization operation can take longer. Ask Support if in doubt.
Add the agent
If you can’t find the agent you might need to add it. Press the add button and find “Calendar Worker V9 engine“.
Make sure to delete the old “Calendar worker” agent.
Setting up the calendar sync interval
Here you can configure how often the synchronization happens.
Remember to mark “Active“.
We recommend a minimum interval of 15 minuts.
Setting up the calendar sync parameters
The calendar V9 agent require setup of a few parameters.
- Start (in weeks)
- End (in weeks)
- URL to basic version
- Include detailed logging
As with the original agent, the agent requires a start and end interval, in weeks from the current date.
If using multiple agents (as described below), be sure that the end of the first agent matches the start of the second agent in order to not overlap.
End week is the number of weeks (from today) the synchronization will happen in the past and in the future.
“URL to basic version” is a reference to the V9 version of Workbook. If employees access V9 using the link “myworkbookhtml.workbook.net“, then this link should say “https://myworkbookhtml.workbook.net“. Make sure to use http instead of https if your system is not using SSL. If this field is left blank, it will fall back to the value entered in system variable 911 (BasicUrl). Feel free to use this system variable instead, but make sure that http or https is included in the link.
“Include detailed logging” is useful for debugging purposes only and should be ignored.
Setting up multiple calendar agents
The V9 calendar agent allows for running multiple calendar agents at separate date intervals. For instance, you may have an agent that only looks at the current week run at a frequency of 15 minutes, and a separate agent that looks a year ahead running once a day.
If you wish to run calendar sync in multiple date intervals at several frequencies, add multiple calendar workers to the agent setup. Adding multiple rows to the schedule on a single agent allows for performing calendar sync at different times of the day, but the parameters will be reused, and separate start and end dates will not be possible. To have different date intervals, select a new instance of the “Calendar worker V9 engine” using the add an agent button. When added, set up parameters and scheduling for the new agent.