Changes between Version 2 and Version 3 of DeveloperGuidelines/Scheduler

Timestamp:

09/13/12 11:29:25 (12 years ago)

Author:

Fran Boon

Comment:

--

DeveloperGuidelines/Scheduler

@@ +1 @@
+= Schduler =
+[[TOC]]
 The scheduler is used for asynchronous tasks (not from a user request to the web server). It is used for daily instance maintenance and for processing and sending messages.
 
@@ -14 +16 @@
 }}}
 
-Task schedules are configured by using [http://pub.nursix.org/eden/s3/s3.s3task.S3Task-class.html#schedule_task s3task.schedule_task()] in `/models/zzz_1st_run.py`.
+== Recurring Tasks ==
+Adding a schedule for a recurring task can be done by using [http://pub.nursix.org/eden/s3/s3.s3task.S3Task-class.html#schedule_task s3task.schedule_task()] in `/models/zzz_1st_run.py`.
 
 {{{
@@ -31 +34 @@
 }}}
 
-Note that tasks are run without credentials.
+Note that recurring tasks don't normally use credentials.
+
+== Asynchronous ==
+The scheduler can be used to 'push work async' so that the browser page returns to the user, whilst the task then runs in the background.
+
+Tasks run in this way normally run as the user who initiated the task.
+
+e.g.:
+{{{
+def stats_data_onapprove(row):
+    """
+       When a stats_data record is approved then the related stats_aggregate
+       fields need to be updated so that the results are kept up to date.
+
+       This is done async as this can take some time
+    """
+    current.s3task.async("stats_update_time_aggregate",
+                         args = [row.data_id],
+                         )
+}}}