Scheduled Task installation

SMTX advices to run the Task Scheduler as a scheduled task under Windows

It is adviced to install the web application files of Pergapedia in a different folder than the Scheduled Task. A common practice is naming the folders like this:

  • Root Folder

    • SMTX

      • Log

      • Scheduler

        • Bin

      • Web

        • Common

        • Workflow

        • Forms

        • ....

By structuring the folders like that, all content is available in a single folder and the web files are seperated from Logs and Scheduler.

Installation of scheduled task

To install the scheduled task follow these steps:

  • Create a folder, outside the Web application files, call it for example "TaskScheduler"

  • From the default.zip file copy everything located in the folder "scheduledtask-full" to your installation folder

  • From the default.zip file copy everything located in the folder "scheduledtask-64bit" to your installation folder. (unless you are running a 32 bits OS, in that case choose folder scheduledtask-32bit).

  • From the default.zip file copy everything located in the folder "scheduledtask-update" to your installation folder

Now all files required have been installed. In case you are doing an upgrade, you only need to copy the scheduledtask-update folder. This will overwrite the previous libraries with the most recent ones.

Configuration through SSPScheduler.exe.config

Continue the installation by modifying the config file belonging to the scheduler. It is named "SSPScheduler.exe.config" and you just copied it from the scheduledtask-full folder into your installation folder.

  • Modify the settings for "sqlServerCatalogNameOverwrites". By default the value is set to SMTXSSP7. Please modify the value to the name of your Database Schema. Do not modify the key name.

  • Go to log4net and find the tag the contains <file type="log4net.Util.PatternString" value="Logs\log-%date{yyyy-MM}-%property{Operation}.txt">. Here you can modify the location of the log files. It is adviced to store the log files of the scheduler in a different folder than the log files of the web application.

  • Go to AppSettings and find the key Main.ConnectionString. Modify the value do that it contains a valid connection string to your database. You can copy this string from the web.config file.

  • Keep all other settings as they are. Only modify in case SMTX support advices you to do so.

  • Save the XML file

  • The Scheduled task should now run properly when you start the file SSPScheduler.exe from a command box.

Installation of scheduled task

The last step of the installation is to automatically start the scheduled task every so many minutes. The scheduled task should have a frequency low enough to run the tasks in the Scheduled Task settings of the admin panel in the desired frequency. And the frequency should be high enough to give each run enough time to finish. It is adviced to set the frequency to 5 minutes by default.

  • Go to Task Schduler under Windows

  • In the left panel select "Task Scheduler Library". Existing tasks are now displayed on the right.

  • Right click on Task Scheduler Library and choose "Create Task"

    • Give the task a name, for example SSP Scheduled Task

    • Choose Radio button "Run whether user is logged on or not"

    • Modify the account under which this task runs by clicking the button Change User or Group.

      • We advice to run this scheduled task with the same account as the IIS application pools

    • Go to tab Triggers, add a new trigger

      • Choose Daily

      • Repeat task every "5 minutes" for a duration of 1 day

      • Stop task if it runs longer than 4 hours

      • Save by clicking OK

    • Go to actions and create a new action

      • Choose Start a program

      • Type the path where the scheduler is installed

      • Arguments can be left empty

      • Set the Start in path to the same folder as where the scheduler is installed:

      • Click OK to save the Action

    • Click OK to save the new Task. You may need to enter the password of the account under which this task will run.

This completes the installation of the scheduled task. You can check the log folder to see if the task is running properly.

Last updated