HPCC-18650 Document LABEL attribute on INDEPENDENT, PERSIST, FAILURE,…

… & SUCCESS Signed-off-by: Jim DeFabia <[email protected]>
hpcc-systems · Sep 21, 2023 · a64f46d · a64f46d
1 parent 8f13dbf
commit a64f46d
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 9 deletions.
diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-FAILURE.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-FAILURE.xml
@@ -8,9 +8,10 @@
   </emphasis><emphasis role="bold">: FAILURE<indexterm>
       <primary>FAILURE</primary>
     </indexterm>(</emphasis><emphasis>handler</emphasis><emphasis
-  role="bold">) <indexterm>
+  role="bold">) [,LABEL</emphasis>(<emphasis>Text</emphasis>)<emphasis
+  role="bold">]</emphasis><indexterm>
       <primary>FAILURE workflow service</primary>
-    </indexterm></emphasis>;</para>
+    </indexterm>;</para>
 
   <para><informaltable colsep="1" frame="all" rowsep="1">
       <tgroup cols="2">
@@ -36,6 +37,21 @@
 
             <entry>The action to run if the expression fails.</entry>
           </row>
+
+          <row>
+            <entry><emphasis role="bold">LABEL</emphasis></entry>
+
+            <entry>Optional. Defines the <emphasis>Text</emphasis> to display
+            for the workflow item in the Graph for the workunit. If omitted,
+            the code generator will deduce a label from the identifier being
+            defined.</entry>
+          </row>
+
+          <row>
+            <entry><emphasis>Text</emphasis></entry>
+
+            <entry>A string constant containing the text to display</entry>
+          </row>
         </tbody>
       </tgroup>
     </informaltable></para>

diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-INDEPENDENT.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-INDEPENDENT.xml
@@ -6,8 +6,9 @@
 
   <para><emphasis>attribute </emphasis>:= <emphasis>expression
   </emphasis><emphasis role="bold">: INDEPENDENT
-  [</emphasis><emphasis>(cluster)</emphasis><emphasis role="bold">]</emphasis>
-  <indexterm>
+  [</emphasis><emphasis>(cluster)</emphasis><emphasis
+  role="bold">][(LABEL</emphasis>(<emphasis>Text</emphasis>)<emphasis
+  role="bold">)]</emphasis><indexterm>
       <primary>INDEPENDENT</primary>
     </indexterm><indexterm>
       <primary>INDEPENDENT workflow service</primary>
@@ -40,6 +41,21 @@
             <emphasis>attribute</emphasis> is run on the currently executing
             cluster.</entry>
           </row>
+
+          <row>
+            <entry><emphasis role="bold">LABEL</emphasis></entry>
+
+            <entry>Optional. Defines the <emphasis>Text</emphasis> to display
+            for the workflow item in the Graph for the workunit. If omitted,
+            the code generator will deduce a label from the identifier being
+            defined.</entry>
+          </row>
+
+          <row>
+            <entry><emphasis>Text</emphasis></entry>
+
+            <entry>A string constant containing the text to display</entry>
+          </row>
         </tbody>
       </tgroup>
     </informaltable></para>
@@ -59,7 +75,7 @@
 
   <para>Example:</para>
 
-  <programlisting lang="ECL" role="runnable">I := RANDOM() : INDEPENDENT;  //calculated once, period
+  <programlisting lang="ECL" role="runnable">I := RANDOM() : INDEPENDENT(LABEL('CalcRandom'));  //calculated once, period
 G := RANDOM() : GLOBAL;       //calculated once in each graph
 
 ds := 

diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-PERSIST.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-PERSIST.xml
@@ -23,9 +23,10 @@
     </indexterm> | MULTIPLE<indexterm>
       <primary>MULTIPLE</primary>
     </indexterm>[(</emphasis><emphasis>count</emphasis><emphasis
-  role="bold">)]] ) <indexterm>
+  role="bold">)]] [,LABEL </emphasis>(<emphasis>Text</emphasis>)<emphasis
+  role="bold">])</emphasis>; <indexterm>
       <primary>PERSIST workflow service</primary>
-    </indexterm></emphasis>;</para>
+    </indexterm></para>
 
   <para><informaltable colsep="1" frame="all" rowsep="1">
       <tgroup cols="2">
@@ -155,6 +156,21 @@
             omitted, the system default is used. If set to -1, then an
             unlimited number are kept.</entry>
           </row>
+
+          <row>
+            <entry><emphasis role="bold">LABEL</emphasis></entry>
+
+            <entry>Optional. Defines the <emphasis>Text</emphasis> to display
+            for the workflow item in the Graph for the workunit. If omitted,
+            the code generator will deduce a label from the identifier being
+            defined.</entry>
+          </row>
+
+          <row>
+            <entry><emphasis>Text</emphasis></entry>
+
+            <entry>A string constant containing the text to display</entry>
+          </row>
         </tbody>
       </tgroup>
     </informaltable></para>

diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-SUCCESS.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-SUCCESS.xml
@@ -8,9 +8,10 @@
   </emphasis><emphasis role="bold">: SUCCESS<indexterm>
       <primary>SUCCESS</primary>
     </indexterm>(</emphasis><emphasis>handler</emphasis><emphasis
-  role="bold">) </emphasis><indexterm>
+  role="bold">) [,LABEL</emphasis>(Text)<emphasis role="bold">]</emphasis>;
+  <indexterm>
       <primary>SUCCESS workflow service</primary>
-    </indexterm>;</para>
+    </indexterm></para>
 
   <para><informaltable colsep="1" frame="all" rowsep="1">
       <tgroup cols="2">
@@ -36,6 +37,21 @@
 
             <entry>The action to run if the expression succeeds.</entry>
           </row>
+
+          <row>
+            <entry><emphasis role="bold">LABEL</emphasis></entry>
+
+            <entry>Optional. Defines the <emphasis>Text</emphasis> to display
+            for the workflow item in the Graph for the workunit. If omitted,
+            the code generator will deduce a label from the identifier being
+            defined.</entry>
+          </row>
+
+          <row>
+            <entry><emphasis>Text</emphasis></entry>
+
+            <entry>A string constant containing the text to display</entry>
+          </row>
         </tbody>
       </tgroup>
     </informaltable></para>