 | This guide will help you learn how to configure the Scheduling module and automate data integration. |
Description
Using Apatar's Scheduling feature, you can schedule one-time or recurring data transformations. That would allow you to automate data export and import for daily backups. You can schedule Apatar to run at a specific time every day.
Starting the Scheduler
There are 2 way to start the scheduler.
- Start> Programs>Apatar>Scheduling
- File>Scheduling in the Apatar application.
Once you have started the scheduler you will see the Apatar Scheduling icon ( 
) in the system tray.
Scheduler elements
The task list displays the following information on each task:
Name - the name of the task
Status - has 3 values:
On (Idle) means that the task is active but not running at the moment
On (Running) means that the datamap included in the task is currently running
Off means that the task is inactive. Tasks with 'Off' status will not be performed till they are started again.
Next - the date and time when the task will be run next time
New button - opens the window where you can create a new task
Edit button - opens the window with the properties of a task selected
Delete button - removes the task(s) selected from the task list.
NOTE: Tasks are not backed up. Once you delete a task it cannot be restored. You will need to re-create it from scratch.
Start button - activates the task(s) selected. The task(s) status will be set to 'On (Idle)'.
Stop button - deactivates the task(s) selected. The task(s) status will be set to 'Off'. The task(s) will not be run till you start them again.
Close button - closes the application window.
NOTE: Clicking 'Close' will not result in scheduler shutdown. For instructions on how to exit the scheduler refer to Exiting the Scheduler. (link to the Exiting the Scheduler point of the guide)
Configuration
Name is the name of the task as it will appear on the task list. We suggest that you enter a descriptive name here so that it's clear from the task name what it does.
Occurs is the section where you set at what recurrence you want the task to be performed.
For daily run, enter the frequency to the Every ... day(s) field in the Daily section. If you enter 1, the task will be run every day, if you enter 2 the task will be run on every second day etc.
For weekly run, enter the frequency to the Every ... week(s) on: field in the Weekly section. Also, select the day(s) on which the task should be run.
For example, here the task will be run every second week on Thursday and Sunday.
For monthly run, select if the task should be run on a specific date every month/every few months or on certain week day of every month/every few months.
For example, the task will be run on every 18th day of every month.
And here the task will be run on every 1st Monday of every 3rd month.
Daily frequency is the section where you can set how often the task should be performed on the run day.
If you need the task to run just once on the run day, select Occurs once at:. Here you can either enter the time manually or click the hours or minutes and use 'up' and 'down' arrows to adjust the run time.
If you need the task to run several times on the run day, select Occurs every:. You can set the frequency to every certain number of minutes or hours. You can either enter the number of minutes(hours) manually or use 'up' and 'down' arrows to adjust it.
For Occurs every: option you also need to specify the start and end time.
 | NOTE:
Please make sure the frequency you set exceeds the time Apatar needs to complete processing the datamap selected for the task. If it takes 10 minutes to complete the task, please do not set the frequency to every 10 or fewer minutes. |
Duration is the section where you set the period of time for which the task should be active.
Start date is the date when the task should become active.
End date is the date when the task should be deactivated.
Total number of runs is the number of times the task should be run.
By default the settings are as follows:
Start date - current date
End date - inactive. No end date is selected meaning that the task will be run at a schedule you set until you stop it.
Total number of runs is set to 0 meaning that the task will be run unlimited number of times.
If you need the task to run only for a specific period of time, click End date and select the date. The task will not be run on the date set as the end date.
If you the task to be run only a certain number of times, keep No end date selection and enter the number or run times to Total number of runs field.
Project is the field where you specify which datamap the task should use. You can enter a complete path to the datamap manually or click '...' button to browse your PC.
To save the project click OK.
To close the window without saving it, click 'X' at the top right-hand corner of the window.
Editing a Task
To edit a task, select it on the task list and click Edit.
| NOTE:
When you open the task for editing it's automatically deactivated (the status is set to _Off) so that it's not run while you are making changes to it. If you select to edit the task that is running at that moment (status shown as On (Running)), the transformation will be stopped and the task will be deactivated._ |
Once you've done all the changes, click Ok to save them or 'X' in the top right-hand corner of the window to discard them.
After that, remember to start the task (select it on the task list and click Start) if you want to activate it.
Exiting the Scheduler
To shut the scheduler down, right click it's icon in the system tray and select Close.
| NOTE:
When you shut down or restart your PC the scheduler is shut down automatically. You will need to open it again for the tasks to run on schedule. |
Scheduler Performance and Error Logs
Before starting the task make sure the scheduled data map is closed i.e. it is not open in Apatar or some other application. Otherwise, the scheduler will fail to start the task.
To view the logs of the scheduler review the error_output2.txt and debug_output2.txt files in the folder Apatar was installed to.
'debug_output2.txt' contains complete performance log of the scheduler.
'error_output2.txt' contains only the error log of the scheduler.
