Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HPCC-18650 Document LABEL attribute on INDEPENDENT, PERSIST, FAILURE, & SUCCESS #17799

Merged
merged 1 commit into from
Sep 28, 2023
Merged

HPCC-18650 Document LABEL attribute on INDEPENDENT, PERSIST, FAILURE, & SUCCESS #17799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-FAILURE.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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>
Expand Down
28 changes: 22 additions & 6 deletions docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-INDEPENDENT.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@

<para><emphasis>attribute </emphasis>:= <emphasis>expression
</emphasis><emphasis role="bold">: INDEPENDENT
[</emphasis><emphasis>(cluster)</emphasis><emphasis role="bold">]</emphasis>
<indexterm>
<primary>INDEPENDENT</primary>
</indexterm><indexterm>
[</emphasis><emphasis>(cluster </emphasis><emphasis
role="bold">[,LABEL(</emphasis><emphasis>text</emphasis><emphasis
role="bold">)]</emphasis>)<emphasis role="bold">]</emphasis>; <indexterm>
<primary>INDEPENDENT workflow service</primary>
</indexterm>;</para>
</indexterm><indexterm>
<primary>INDEPENDENT</primary>
</indexterm></para>

<para><informaltable colsep="1" frame="all" rowsep="1">
<tgroup cols="2">
Expand Down Expand Up @@ -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>
Expand All @@ -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 :=
Expand Down
20 changes: 18 additions & 2 deletions docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-PERSIST.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
20 changes: 18 additions & 2 deletions docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-SUCCESS.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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><emphasis>text</emphasis><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">
Expand All @@ -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>
Expand Down