Changes between Version 2 and Version 3 of docs_cache

Timestamp:

Feb 17, 2016, 4:30:29 AM (6 years ago)

Author:

ehb

Comment:

--

docs_cache

@@ -11 +11 @@
     * "cache":"askrecompute" will present the user with the choice of showing previously computed results or recomputing them.
      * we could make this user specific to allow certain users only to recompute, please ask us if you need this.
+
+ * deleting a [wiki:docs_jobs job] will clear the cached entry
+ * caveat: if you remove job the backing files with the file manager, the cached results will be corrupted due to missing files
+  * we should probably address this somehow within the generated application
+ 
+== viewing available cached results ==
+
+ * a build in module executable is available for displaying cached results
+ * a template example is shown below
+ * the important bits to use this module executable are
+  * keep most of what is shown in the example... you can change, of course, any labels and the module id of this module
+  * make sure the field id "module" has its default value set to the module id of the module creating the cached results (in this case, "flowinducedvibration"
+
+{{{
+{
+    "moduleid"           : "cachedresultsfiv"
+    ,"submitpolicy"      : "all"
+    ,"label"             : "Available Results"
+    ,"resource"          : "local"
+    ,"noreset"           : "true"
+    ,"executable"        : "cached_results"
+    ,"docrootexecutable" : "ajax/sys_config/cached_results.php"
+    ,"uniquedir"         : "on"
+    ,"submit_label"      : "Refresh"
+    ,"autosubmit"        : "true"
+    ,"nojobcontrol"      : "on"
+    ,"fields"   : [
+        {
+            "role"     : "input"
+            ,"id"       : "label1"
+            ,"label"    : "Available Results"
+            ,"type"     : "label"
+        }
+        ,{
+            "role"     : "input"
+            ,"id"       : "module"
+            ,"type"     : "hidden"
+            ,"default"  : "flowinducedvibration"
+        }
+        ,{
+            "role"     : "output"
+            ,"label"    : ""
+            ,"id"       : "outhtml"
+            ,"type"     : "html"
+        }
+    ]
+}
+}}}