Skip to end of metadata
Go to start of metadata

The Task Scheduler allows you to manage background processes and tasks. Upon the start-up of the Task Scheduler, the system tasks that all Frameworks sites require are automatically created. The Startup Log shows details of the startup process including the Automated Tasks that have been started. For example, the Notifications Queue purge process.

The Task Scheduler works in the background keeping track of tasks & making sure all tasks are executing. The Task Scheduler works closely with Notification Tasks & Event Notifications. The Task Scheduler must be active to ensure the notification tasks including DeTrack & GetSwift are executed. If notifications have failed, refer to FAQ:  How do I check for failed notifications and what do I do if notification/s have failed?

 Further information about the Task Scheduler
  • The start-up and monitoring of the Task Scheduler is self-managed to minimise system administration.
  • The start-up of the Task Scheduler occurs at the same time as the start up of the Frameworks OpenEdge AppServer (controlled via the system startup scripts). 
  • Each time a user logs in to Frameworks, a check is performed to confirm if the Task Scheduler is running. If it is not running, it is restarted. If it cannot be restarted, an error/warning report will be provided (example below) to the user upon logging on. If an error/warning report appears, please contact your System Administrator.

  • If required, the Task Scheduler can be disabled via the Halt button so that it does not automatically restart. If the Task Scheduler is not running, then any user submitting a task to be executed will be warned that the Task Scheduler is not running (example below).

  • The Frameworks Task Scheduler is the similar to the Prostix Job Scheduler.
 Further information about Tasks
  • A Task is any long running activity or operation that needs to be performed in the background that cannot be performed as part of a normal Frameworks application request.
  • All logging and output from the task is logged against the task and can be viewed via the Task Scheduler Queue activity in Frameworks.
  • Tasks are able to be scheduled to be run now, once off (at a set date and time), repeatedly at a specified interval (For example, daily, weekly, fortnightly, monthly) etc. Refer to Scheduling tasks to run One Time only, Daily, Weekly, Fortnightly or Monthly for further information.
  • Common tasks include:
    • A report
    • A transaction posting
    • A background scheduled process
    • Typical “end of day” type activities that need to automatically run overnight
  • A task that has been scheduled to run in the future can be deleted if it hasn't been started.
  • A task that has already been completed can be deleted. Old tasks will be deleted by a data purge and archive on a daily basis.


Refer to the following processes for further information:


Activity Task Scheduler Control

The Activity Task Scheduler Control panel is a view into the configuration details and the startup log when the Frameworks system was started. It show the status and allows you to stop or halt the Task Scheduler. For example, to conduct maintenance activities.

(warning) Only the System Admininistrator should have access to the Activity Task Scheduler Control panel. (warning)

(info) System Admins, If you need to see any further error details, refer to the logfile at the bottom of the Startup Log.

To access the Activity Task Scheduler Control, perform the following:

1. Click  then type Activity Task Scheduler Control (or select Activity Task Scheduler Control from the System Administration then Task Scheduler navigation tree).

Refer to the following processes for further information:


Halting the Task Scheduler

If you halt the Task Scheduler to do some maintenance, upon anyone re- logging into Frameworks, the scheduler is stopped and will NOT automatically restarted when someone logs in. You need to click to allow it to automatically restart.

To halt the Task Scheduler, perform the following:

1. Click  then type Activity Task Scheduler Control (or select Activity Task Scheduler Control from the System Administration then Task Scheduler navigation tree).

2. Click .


To free the Task Scheduler

To allow the Task Scheduler to automatically restart after Halting it, perform the following:

1. Click  then type Activity Task Scheduler Control (or select Activity Task Scheduler Control from the System Administration then Task Scheduler navigation tree).

2. Click .


Stopping the Task Scheduler

Note: If you stop the Task Scheduler, upon anyone re- logging into Frameworks, the Task Scheduler is automatically restarted.

To stop the Task Scheduler, perform the following:

1. Click  then type Activity Task Scheduler Control (or select Activity Task Scheduler Control from the System Administration then Task Scheduler navigation tree).

2. Click .

3. After approximately 30 seconds or less, a status of Stopped is displayed.


Starting the Task Scheduler

To restart the Task Scheduler after Stopping it, perform the following:

1. Click  then type Activity Task Scheduler Control (or select Activity Task Scheduler Control from the System Administration then Task Scheduler navigation tree).

2. Click .

3. After a second or two, a status of Running is displayed.


Checking the status of the Task Scheduler

The Check Status button refreshes the screen (after a Stop or Halt) & re-queries the Task Scheduler to confirm the Task Scheduler is still running & no error messages appear on the screen.

To check the status of the Task Scheduler, perform the following:

1. Click  then type Activity Task Scheduler Control (or select Activity Task Scheduler Control from the System Administration then Task Scheduler navigation tree).

2. Click .



Activity Task Scheduler Data Purge & Archive

The Activity Task Scheduler Data Purge & Archive purges or archives old or no longer needed tasks. A System Administrator can run data purges and archives at any time. By default, only tasks that have been completed will be archived or purged, not any tasks that are still to be run. 30 days of data are automatically retained.

To access the Activity Task Scheduler Data Purge & Archive, perform the following:

1. Click  then type Activity Task Scheduler Data Purge & Archive (or select Activity Task Scheduler Data Purge & Archive from the System Administration then Task Scheduler navigation tree).

    • The Report Criteria tab is used to capture the criteria for the task that needs to be performed, specific to the purge or archive activity. It contains the information needed to run the task.
    • The Schedule tab is used to schedule the task to run at a given time. By default it runs now. Refer to Scheduling tasks to run One Time only, Daily, Weekly, Fortnightly or Monthly for further information.
    • The Output tab is used to view the results of the completed task (dependent on how you schedule it).

Refer to the following processes for further information:


Purging Tasks

When Tasks are purged, the Activity Task data is deleted from the database and the report files are deleted from disk. These tasks are also archived.

To purge tasks, perform the following:

1. Click  then type Activity Task Scheduler Data Purge & Archive (or select Activity Task Scheduler Data Purge & Archive from the System Administration then Task Scheduler navigation tree).

2. Tick Purge.

3. If applicable, tick Include Scheduled Tasks to purge tasks that have not yet run.

4. If you would like to purge selected tasks, type the task name or wildcard into the Name Filter field.

5. If applicable, type the date to purge all tasks (up to and including the date specififed) into the Cut off Date field or use the date finder to search.








 Special info about the Cut Off date field & repeated schedules

Rather than using set dates, you can choose to purge data at various points via Date variables.

Common Date variables you may choose to purge data from include:

Cut Off Date VariableDescription
@NOW =Purge the task at the exact date & time at the point of execution.
@TODAY =Purge the task at the exact date at the point of execution.
@TODAY-days =

Purge the task at the exact date at the point of execution minus the number of days. For example, @TODAY-30

@SOM =

Purge the task at the start of month.

@EOM =Purge the task at the end of the current month (eg: to schedule a trial balance to run every day, you would use @SOM and @EOM.

As an example, to schedule a trial balance to run every day, you would use @SOM and @EOM.

(warning), Should you receive a red warning error "Invalid Date Value" in the Cut Off field, please ignore it.

(info)  A future development will include other fields to run GL reports (similar to the Cut Off field).

6. If applicable, click the Schedule tab to schedule the task to run at a given time. By default it runs now. Refer to Scheduling tasks to run One Time only, Daily, Weekly, Fortnightly or Monthly for further information.

7. Click .

8. A message is displayed. Click OK.

9. If run now, the Output tab displays the results of the completed task. If run later, the Task Scheduler Queue contains the ouput.



Archiving Tasks

When Tasks are archived, the Activity Task data is extracted and archived and a report is provided of the archived data.

To archive tasks, perform the following:

1. Click  then type Activity Task Scheduler Data Purge & Archive (or select Activity Task Scheduler Data Purge & Archive from the System Administration then Task Scheduler navigation tree).

2. Tick Archive.

3. If applicable, tick Include Scheduled Tasks to archive tasks that have not yet run.

4. If you would like to archive selected tasks, type the task name or wildcard into the Name Filter field.

5. If applicable, Type the date to archive all tasks (up to and including the date specififed) into the Cut off Date field or use the date finder to search.

 Special info about the Cut Off date field & repeated schedules

Rather than using set dates, you can choose to purge data at various points via Date variables.

Common Date variables you may choose to purge data from include:

Cut Off Date VariableDescription
@NOW =Purge the task at the exact date & time at the point of execution.
@TODAY =Purge the task at the exact date at the point of execution.
@TODAY-days =

Purge the task at the exact date at the point of execution minus the number of days. For example, @TODAY-30

@SOM =

Purge the task at the start of month.

@EOM =Purge the task at the end of the current month (eg: to schedule a trial balance to run every day, you would use @SOM and @EOM.

As an example, to schedule a trial balance to run every day, you would use @SOM and @EOM.

(warning) Should you receive a red warning error "Invalid Date Value" in the Cut Off field, please ignore it.

(info)  A future development will include other fields to run GL reports (similar to the Cut Off field).

6. If applicable, click the Schedule tab to schedule the task to run at a given time. By default it runs now. Refer to Scheduling tasks to run One Time only, Daily, Weekly, Fortnightly or Monthly for further information.

7. Click .

8. A message is displayed. Click OK.

9. If run now, the Output tab displays the results of the completed task. If you ran the task immediately, you can click on the reports generated. If run later, the Task Scheduler Queue contains the ouput.


Task Scheduler Queue

The Task Scheduler Queue contains a list of all tasks scheduled, all tasks running or all tasks that have been completed. You can filter the tasks by these statuses. The Task Scheduler Queue contains the output from completed tasks.

(tick) You have to go to the Task Scheduler Queue to view your output from future scheduled tasks.

(tick) You are able to delete the tasks via thebutton (the same as a purge).



Searching for Scheduled Tasks

To search for Scheduled Tasks, perform the following:

1. Click  then type Task Scheduler Queue (or select Task Scheduler Queue from the System Administration then Task Scheduler navigation tree).

(info) A user is unable to change the Created By field unless they are a System Administrator with the correct accesses defined to change it. The Created By field is controlled by the user's security level. This field allows Users to view their own queues, however not have access to other User's queues in order to prevent sensitive reports/scheduled task logs being accessed by anyone.

2. Type the date the task was scheduled into the Scheduled field, or use the date finder to search.

3. Select either All, Scheduled, Running or Completed via the drop down arrow  in the Status field.

4. Select Yes or No in the Has Run field if you know that the task has run, otherwise leave as All.

5. If applicable, type the task name into the Name field to filter the results.


6. Click to locate the task/s.

7. Click on the task to review the report criteria (Json technical data) including:

  • The schedule
  • The output
  • If the report has run
  • Who created it
  • When it ran in the Task Log'
  • The output containing the report.

8. If applicable, delete the task by clicking .


Removing Automated Tasks

If a System Administrator would like to remove any Automated Tasks from Frameworks that are automatically started at a certain date & time, delete them, then create a new schedule with the task/s to run at a time of your choosing.

(warning) The Automated Tasks must be in the system. If they are not there, the system will recreate them to run at the time scheduled. The Auto Task in the Startup Log details when the tasks are scheduled to run by default.