Run Tool

Schedule a Run Tool Project with Windows Task Scheduler

To schedule with Task Scheduler, open Windows Task Scheduler and create a folder to hold your scheduled tasks. You can do this by going to the Actions Window and selecting New Folder...

Schedule Folder

Create the Task

To create a task either right click into the task window and select Create New Task or go to the Actions Window to the right and select Create Task...

Enter in a name and description for the task, and make sure to set the security options to the correct user account that has permission to run the task.

New Task

Add the Run Tool Project

To add the Run Tool Project to the task, click onto the Actions tab and click on New.

Actions Tab

Now enter in the path to the Run Tool exe in the Program/Script field. You can use "%DATASYNCINSTALLPATH%\Simego.DataSync.Run32.exe" or browse to the location.

For the Add arguments field enter in -e and the name of the project to run followed by .dsrun for the Run Tool or .dsprj for a single Data Sync step. An example of what could be entered is: -e "RunToolProject.dsrun"

If your project is in a different directory you can enter the path in the Start field. For example C:\Users\Rebecca\Documents\RunTool2\

This should be either a local path or a UNC shared drive. It will not work with a mapped drive.

Actions

If you want to attach multiple Run Tool projects to a Scheduled Task then you need to add each project as a separate action

Add the Schedule

Now we can create the schedule to run the project. Go to the trigger tab and click on New to define the schedule that you want the project to run on.

The example below shows a possible configuration for a Start of Day trigger.

Triggers

Set how frequently you want it to run (e.g. Daily), a start time, and set the recurrence frequency. We also recommend setting a stop task if it runs longer than, in-case there is an error.

Running

You can now check the task runs as expected by right clicking and selecting Run from the menu.

The result will be a code returned in the Last Run Result column.

  • If it is successful a 0x0 code will be returned.
  • If there is an error with Data Sync a 0x1 code will be returned. Check out the log file in the .ds folder for more details.
  • Any other error code is thrown by Task Scheduler and you will need to look in Windows Event Viewer to see what the issue is.

Successful Run

You may also want to enable task history so then you can see when the task ran. This can be done from the Actions window to the right.

Troubleshooting

If you are getting errors or the task is not running, please check Windows Event Viewer for any error messages. This will be where you can find details about the running of the task.

If you are getting the 0x1 error code in Task Scheduler then this is being returned by Data Sync. Have a look in the log files in the .ds folder for that run to see what the error was.