HPCC-14561 Document SetWorkunitAppValue & filter by appvalue

Signed-off-by: Jim DeFabia <jamesdefabia@lexisnexis.com>

docs/ECLStandardLibraryReference/SLR-Mods/SetWorkunitAppValue.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<sect1 id="SetWorkunitAppValue">
+  <title><emphasis role="bold">SetWorkunitAppValue</emphasis></title>
+
+  <para><emphasis role="bold">STD.System.Workunit.SetWorkunitAppValue
+  <indexterm>
+      <primary>STD.System.Workunit.SetWorkunitAppValue</primary>
+    </indexterm> <indexterm>
+      <primary>System.Workunit.SetWorkunitAppValue</primary>
+    </indexterm> <indexterm>
+      <primary>Workunit.SetWorkunitAppValue</primary>
+    </indexterm> <indexterm>
+      <primary>SetWorkunitAppValue</primary>
+    </indexterm> (</emphasis> <emphasis>app, key, value,</emphasis> <emphasis
+  role="bold"> [ </emphasis> <emphasis>overwrite</emphasis> <emphasis
+  role="bold"> ])</emphasis></para>
+
+  <informaltable colsep="1" frame="all" rowsep="1">
+    <tgroup cols="2">
+      <colspec colwidth="80.50pt" />
+
+      <colspec />
+
+      <tbody>
+        <row>
+          <entry><emphasis>app</emphasis></entry>
+
+          <entry>The application name to set.</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>key</emphasis></entry>
+
+          <entry>The name of the value to set.</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>value</emphasis></entry>
+
+          <entry>The value to set.</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>overwrite</emphasis></entry>
+
+          <entry>A boolean TRUE or FALSE flag indicating whether to allow the
+          value to overwrite an existing value. Default is TRUE..</entry>
+        </row>
+
+        <row>
+          <entry>Return:<emphasis> </emphasis></entry>
+
+          <entry>SetWorkunitAppValue returns TRUE if the value was set
+          successfully.</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
+  <para>The <emphasis role="bold">SetWorkunitAppValue </emphasis>function sets
+  an application value in the current workunit. It returns TRUE if the value
+  was set successfully.</para>
+
+  <para>Example:</para>
+
+  <programlisting format="linespecific">IMPORT STD;
+STD.System.Workunit.SetWorkunitAppValue('MyApp','FirstName','Jim',TRUE);
+OUTPUT(STD.System.Workunit.WorkunitList(appvalues := 'MyApp/FirstName='Jim');
+//returns a list of workunits with app values where FirstName='Jim'</programlisting>
+
+  <para>See Also: <link linkend="WorkunitList">WorkunitList</link></para>
+</sect1>

docs/ECLStandardLibraryReference/SLR-Mods/WorkunitList.xml

@@ -4,34 +4,30 @@
 <sect1 id="WorkunitList">
   <title>WorkunitList</title>
 
-  <para><emphasis role="bold">STD.System.Workunit.WorkunitList    <indexterm>
+  <para><emphasis role="bold">STD.System.Workunit.WorkunitList <indexterm>
       <primary>STD.System.Workunit.WorkunitList</primary>
-    </indexterm>
-    <indexterm>
+    </indexterm> <indexterm>
       <primary>System.Workunit.WorkunitList</primary>
-    </indexterm>
-    <indexterm>
+    </indexterm> <indexterm>
       <primary>Workunit.WorkunitList</primary>
-    </indexterm>
-    <indexterm>
+    </indexterm> <indexterm>
       <primary>WorkunitList</primary>
-    </indexterm>
-(</emphasis>
-  <emphasis> lowwuid </emphasis> <emphasis role="bold">[</emphasis>
-  <emphasis>, highwuid </emphasis> <emphasis role="bold">] [</emphasis>
-  <emphasis>, username </emphasis> <emphasis role="bold">]</emphasis>
-  <emphasis role="bold"> [</emphasis> <emphasis>, cluster </emphasis>
-  <emphasis role="bold">] [</emphasis> <emphasis>, jobname </emphasis>
-  <emphasis role="bold">] [</emphasis> <emphasis>, state </emphasis> <emphasis
-  role="bold">] [</emphasis> <emphasis>, priority </emphasis> <emphasis
+    </indexterm> (</emphasis> <emphasis> lowwuid </emphasis> <emphasis
+  role="bold">[</emphasis> <emphasis>, highwuid </emphasis> <emphasis
+  role="bold">] [</emphasis> <emphasis>, username </emphasis> <emphasis
   role="bold">]</emphasis> <emphasis role="bold"> [</emphasis> <emphasis>,
-  fileread </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>,
-  filewritten </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>,
-  roxiecluster </emphasis> <emphasis role="bold">]</emphasis> <emphasis
-  role="bold"> [</emphasis> <emphasis>, eclcontains </emphasis> <emphasis
-  role="bold">] [</emphasis> <emphasis>, online </emphasis> <emphasis
-  role="bold">] [</emphasis> <emphasis>, archived </emphasis> <emphasis
-  role="bold">])</emphasis></para>
+  cluster </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>, jobname
+  </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>, state
+  </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>, priority
+  </emphasis> <emphasis role="bold">]</emphasis> <emphasis role="bold">
+  [</emphasis> <emphasis>, fileread </emphasis> <emphasis role="bold">]
+  [</emphasis> <emphasis>, filewritten </emphasis> <emphasis role="bold">]
+  [</emphasis> <emphasis>, roxiecluster </emphasis> <emphasis
+  role="bold">]</emphasis> <emphasis role="bold"> [</emphasis> <emphasis>,
+  eclcontains </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>,
+  online </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>, archived
+  </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>, appvalues
+  </emphasis> <emphasis role="bold">])</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -132,6 +128,14 @@
         </row>
 
         <row>
+          <entry><emphasis>appvalues</emphasis></entry>
+
+          <entry>Optional. A null-terminated string containing application
+          values to search for. Use a string of the form appname/key=value or
+          appname/*=value.</entry>
+        </row>
+
+        <row>
           <entry>Return:<emphasis> </emphasis></entry>
 
           <entry>WorkunitList returns a DATASET.</entry>
@@ -170,5 +174,13 @@ END;</programlisting>
 OUTPUT(STD.System.Workunit.WorkunitList('',
        NAMED eclcontains := 'COUNT'));
  //list only those where the ECL code contains the word 'COUNT'
- //this search is case insensitive and does include comments</programlisting>
+ //this search is case insensitive and does include comments
+
+STD.System.Workunit.SetWorkunitAppValue('MyApp','FirstName','Jim',TRUE);
+OUTPUT(STD.System.Workunit.WorkunitList(appvalues := 'MyApp/FirstName='Jim'));
+//returns a list of workunits with app values where FirstName='Jim'
+</programlisting>
+
+  <para>See Also: <link
+  linkend="SetWorkunitAppValue">SetWorkunitAppValue</link></para>
 </sect1>

docs/ECLStandardLibraryReference/SLR-includer.xml

@@ -535,6 +535,9 @@
     <xi:include href="ECLStandardLibraryReference/SLR-Mods/WorkunitList.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
 
+    <xi:include href="ECLStandardLibraryReference/SLR-Mods/SetWorkunitAppValue.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude" />
+
     <xi:include href="ECLStandardLibraryReference/SLR-Mods/WUIDonDate.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />