Changes between Version 13 and Version 14 of AssimilateIntro

Timestamp:

Oct 24, 2014, 2:18:23 PM (9 years ago)

Author:

davea

Comment:

--

AssimilateIntro

@@ -64 +64 @@
 '''script_assimilator''' takes a command-line argument
 
- --script filename:: name of script to handle a completed job
+ --script "filename arg1 ... argn" :: script to handle a completed job
 
-The script is called as
+'''arg1 ... argn''' represent cmdline args to be passed to the script
+for successful workunits.
+The options are:
+ '''files''' ::       list of output files of the job's canonical result
+ '''wu_id''' ::       workunit ID
+ '''result_id''' ::   ID of the canonical result
+ '''runtime''' ::     runtime of the canonical result, in seconds
+
+If no args are specified, the script is invoked as
 {{{
-script --wu_name X f1 ... fn
+scriptname wu_id files
 }}}
-to handle a successful job, where X is the workunit name
-and f1 ... fn are the output files of the canonical result,
-or as
+
+If the workunit has no canonical result (i.e. it failed)
+the script is invoked as
 {{{
-script --wu_name X --error N
+scriptname --error N wu_id
 }}}
-to handle an error job, were N is an integer encoding the error conditions
-(see WU_ERROR_* in html/inc/common_defs.inc).
+where N is an integer encoding the reasons for the job's failure
+(see WU_ERROR_* in html/inc/common_defs.inc)
 
 The script must be put in your project's bin/ directory.