Differences

This shows you the differences between two versions of the page.

--- pracro:post-commit-hook [2011/12/02 10:33] – deva
+++ pracro:post-commit-hook [2011/12/02 10:48] – deva
@@ Line 1: / Line 1: @@
 ======Post-Commit-Hook design======
 A method for running a script on session data is needed on session-commit (possibly also discard?) in order to for example be able to post data to external databases when the data are commit to the pracro database.
+The post-commit-hook scripts are to be executed //after// the commit has been performed successfully to the database.
 The mechanism should be designed so that it is also able to handle journal commits to pcpraxis (currently handled in c++ via upload server) and thereby replacing part of the functionality in the existing ''<resume>'' tag:
 <code xml>
@@ Line 26: / Line 28: @@
 An important feature of this list is that the native order of the macros are the same as in the template - **NOT** sorted alphabetically or similar!.
 =====Script placement=====
@@ Line 50: / Line 53: @@
 </code>
+A similar solution is to be used in the individual macros (ie. oncommit/ondiscard attributes in the macro tag).
+Each macros scripts are to be loaded in turn in a clean namespace containing only the values of the current macro (again to avoid naming conflicts) and executed in the same order in which they occur in the template.
+The template scripts are to be executed //before// the macro scripts.
+<code xml>
+<?xml version='1.0' encoding='UTF-8'?>
+<macro name="mymacro" version="1.0" oncommit="func1()" ondiscard="func2()">
+  <oncommit>
+    <script>
+      function func1()
+        -- do something useful
+      end
+      function func2()
+        -- do something useful
+      end
+    </script>
+  </oncommit>
+   .
+   .
+   .
+</code>
 =====Resume scripts=====
 The resume scripts cannot directly be replaced by a single on-commit script since the resumes are used dynamically while the template is being edited (to show resumes in collapsed macros).