Changes between Version 10 and Version 11 of AssimilateIntro

Timestamp:

Oct 22, 2014, 10:56:20 AM (11 years ago)

Author:

davea

Comment:

--

AssimilateIntro

@@ +1 @@
+[[PageOutline]]
 = Handling completed jobs =
 
@@ -16 +17 @@
 
 This function is called when either
- * The workunit has a nonzero [JobIn#Redundancyandschedulingattributes error mask] (indicating, for example, too many error results). In this case the handler might write a message to a log or send an email to the project administrator.
- * The workunit has a canonical result. In this case wu.canonical_resultid will be nonzero, and canonical_result will contain the canonical result.
+ * The workunit has a nonzero [JobIn#Redundancyandschedulingattributes error mask]
+  (indicating, for example, too many error results).
+  In this case the handler might write a message to a log or send an email to the project administrator.
+ * The workunit has a canonical result.
+  In this case wu.canonical_resultid will be nonzero, and canonical_result will contain the canonical result.
 
 In both cases the 'results' vector will be populated with all the workunit's results (including unsuccessful and unsent ones).
@@ -26 +30 @@
 The return values of `assimilate_handler()` are:
  * 0: success: the workunit will be marked as assimilated.
- * DEFER_ASSIMILATION: the workunit will be processed again when another instance finishes.  This is useful for appliations where you want to see all the completed results.
- * Other nonzero values: the assimilator will log an error message and exit. Typically '''assimilate_handler()''' should return nonzero for any error condition. This way the system administrator can fix the problem before any completed or erroneous workunits are mis-handled by BOINC.
+ * DEFER_ASSIMILATION: the workunit will be processed again when another instance finishes.
+  This is useful for appliations where you want to see all the completed results.
+ * Other nonzero values: the assimilator will log an error message and exit.
+  Typically '''assimilate_handler()''' should return nonzero for any error condition.
+  This way the system administrator can fix the problem before any completed or erroneous workunits are mis-handled by BOINC.
 
 You can use BOINC's [BackendUtilities back-end utility functions] to get file pathnames and open files.
@@ -36 +43 @@
 {{{
 <daemon>
-   <cmd> my_assimilator -app APPNAME </cmd>
+   <cmd> my_assimilator --app APPNAME </cmd>
 </daemon>
 }}}
@@ -50 +57 @@
 
  [ --dont_update_db ] :: don't mark jobs as assimilated (for testing)
- 
+
+== Using scripting languages ==
+
+The assimilator '''script_assimilator''' lets you write assimilator logic
+in your language of choice (Python, Perl, bash, etc.).
+'''script_assimilator''' takes a command-line argument
+
+ --script filename:: name of script to handle a completed job
+
+The script is called as
+{{{
+script --wu_name X f1 ... fn
+}}}
+to handle a successful job, where X is the workunit name
+and f1 ... fn are the output files of the canonical result,
+or as
+{{{
+script --wu_name X --error N
+}}}
+to handle an error job, were N is an integer encoding the error conditions
+(see WU_ERROR_* in html/inc/common_defs.inc).
+
+The script must be put in your project's bin/ directory.
+
 == The sample assimilator ==
 
@@ -60 +90 @@
   If there are more than one they are named WU_NAME_0, WU_NAME_1, etc.
   If there are no output files, an empty file WU_NAME_no_output_files is created.
- * If the workunit failed (e.g., too many errors) it appends a line to '''sample_results/errors''' containing the workunit name and the error code.
+ * If the workunit failed (e.g., too many errors) it appends a line to '''sample_results/errors'''
+  containing the workunit name and the error code.
 
-The sample assimilator can be used as a placeholder while you
-are developing your application.
+The sample assimilator can be used as a placeholder while you are developing your application.
 In some cases you may be able to use it in production.