Scheduler Service Setup
Trouble seeing the images? Right click on images and open in new tab to enlarge or zoom in on the page (Ctrl + mousewheel).
In this article we look at the setup process for the VDM Windows Service to automatically run the Scheduler. The topics covered include configuring the service, verifying the log on account, starting and stopping the service and more.
Windows services enable you to create long-running executable applications that run in their own Windows sessions. Setting up the Windows Service for VDM's Scheduler will allow you to run scheduled Jobs in the background without having a session of VDM running.
1. Launch VDM as administrator.
2. Click on the Settings button located at the bottom of VDM's main screen.
IMPORTANT NOTE: Step 3 does not need to be done if using the SQL database for the scheduler.
3. Make sure that the Service Options - Calendar Location (Image 1) matches the User Options - Calendar Location (Image 2) for the person that is managing the service calendar. Set the Default Connection (required). Next, click the Create File button for the Service Options to be saved.
Make sure the account the service is using can access the set locations in this step. If it's on the network, you will need to use the UNC path as drive mappings are not loaded (see below for help with UNC paths).
Image 1: Service Options
Image 2: User Options
Image 3 indicates the file paths that should match in the SERVICEOPTIONS and OPTIONS files.
Image 3: SERVICEOPTIONS vs OPTIONS
Note: Locations on a Network Drive should use the UNC path instead.
The following network drive will not work with the service.
Acceptable UNC path:
4. Close VDM and search for Services in the Windows search bar. Click on Services.
5. Browse to BridgeWorks VDM Scheduler Service. Right click on the service and select Properties.
6. Click the Log On tab inside the properties then click Browse.
7. Enter the account name that is going to be used to access views, export data locations, reports, etc. and then Check Names. If successful, click OK.
IMPORTANT NOTE: The account running the service must have access to the paths in the SERVICEOPTIONS file (Step 3). If the paths are in the user documents it needs to be the same account, otherwise accessible locations will be needed. Click here for more information regarding access / permissions.
Note: Invalid account names will result in an error when checking the name
8. Enter the password for the account and hit apply to verify a successful account configuration.
9. Go back to the BridgeWorks VDM Scheduler Service and right click on it and select Start.
10. If the Log On information was correct, the service should start. If the service does not start, verify account name and password.
Note: It is recommended to set the startup type to Automatic for the service. This can be done in the General tab of the service properties.
11. Stop the service before moving forward. From this point on the service should only be started / stopped inside VDM.
12. Once the service has been started successfully, you will then be able to Start/Stop/Restart the service within VDM's Scheduler. In order to see the service controls within VDM, VDM must be ran as an administrator.
Non Admin users refer to article: Controlling Scheduler Service Without Admin Privileges.
1. Changes cannot be made to the Calendar while the service is running. To add, edit or delete appointments, you must stop the service through VDM. Once you've completed the needed adjustments to your appointments, start the Calendar service from within VDM and your scheduler will resume.
If you would like to be able to run the scheduler without needing to start / stop the service, click here.
2. It is not recommended to manage the running state of the service outside of VDM. Doing so could result in damage to your Calendar. Should you choose to Start/Stop the service outside of VDM, you will not see the indication that the Calendar is in Read Only mode.
3. Should you damage your Calendar file, VDM stores backups at "...\BridgeWorks VDM\CalendarBackups" every time the calendar file is updated. You will need to rename the backup to CALENDAR and drop it over the existing CALENDAR file with the Scheduler service stopped.
The Next Step...
If you have jobs from v9 to import, click here.
If you need to begin the process of creating new jobs to schedule, click here.
Please sign in to leave a comment.