Changeset 5204 for trunk/doc/src/docbook/appendix/incompatible.xml

Timestamp:

Dec 16, 2009, 2:29:50 PM (13 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1437: Base1PluginExecuter should store 'value' instead of 'key' for enumerated parameters

Note that this fix only affects jobs that have been executed after this fix has been installed. Existing jobs will still store (and display) the 'key' values.

File:

• trunk/doc/src/docbook/appendix/incompatible.xml (modified) (1 diff)

trunk/doc/src/docbook/appendix/incompatible.xml

@@ -43 +43 @@
     </para>
   </note>
+  
+  <sect1 id="appendix.incompatible.2.15">
+    <title>BASE 2.15 release</title>
+
+    <bridgehead>
+      Base1PluginExecuter and enumerated parameters
+    </bridgehead>
+    
+    <para>
+      Enumerated parameters as handled by the Base1PluginExecuter consists
+      of key/value pairs, for example 0=No, 1=Yes. The 'value' is what the user 
+      sees in the GUI while running jobs and the 'key' is what is sent to
+      the plug-in in the parameter file. Starting with BASE 2.15 the 'value' 
+      is saved in the database instead of the 'key'. At runtime, a reverse
+      lookup is used to convert the 'value' into the 'key' that is written
+      to the parameters file. <emphasis>The reverse lookup only works
+      if all values are unique.</emphasis> BASE will check for this at
+      configuration time and throw an exception if this is not the
+      case. To solve this problem the plug-in should be reconfigured.
+    </para>
+    
+  </sect1>
   
   <sect1 id="appendix.incompatible.2.13">