From d68eb8a71ac5cd9cac2ef3cc0cd96e8a2e3c734d Mon Sep 17 00:00:00 2001 From: Jim DeFabia Date: Thu, 21 Sep 2023 13:11:20 -0400 Subject: [PATCH] HPCC-18650 Document LABEL attribute on INDEPENDENT, PERSIST, FAILURE, & SUCCESS Signed-off-by: Jim DeFabia --- .../ECLR_mods/WkFlo-FAILURE.xml | 20 +++++++++++-- .../ECLR_mods/WkFlo-INDEPENDENT.xml | 28 +++++++++++++++---- .../ECLR_mods/WkFlo-PERSIST.xml | 20 +++++++++++-- .../ECLR_mods/WkFlo-SUCCESS.xml | 20 +++++++++++-- 4 files changed, 76 insertions(+), 12 deletions(-) diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-FAILURE.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-FAILURE.xml index 3d4b0ebb335..842719df639 100644 --- a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-FAILURE.xml +++ b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-FAILURE.xml @@ -8,9 +8,10 @@ : FAILURE FAILURE (handler) + role="bold">) [,LABEL(text)] FAILURE workflow service - ; + ; @@ -36,6 +37,21 @@ The action to run if the expression fails. + + + LABEL + + Optional. Defines the Text 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. + + + + text + + A string constant containing the text to display. + diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-INDEPENDENT.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-INDEPENDENT.xml index 81766013906..a226c545680 100644 --- a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-INDEPENDENT.xml +++ b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-INDEPENDENT.xml @@ -6,12 +6,13 @@ attribute := expression : INDEPENDENT - [(cluster)] - - INDEPENDENT - + [(cluster [,LABEL(text)])]; INDEPENDENT workflow service - ; + + INDEPENDENT + @@ -40,6 +41,21 @@ attribute is run on the currently executing cluster. + + + LABEL + + Optional. Defines the Text 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. + + + + text + + A string constant containing the text to display. + @@ -59,7 +75,7 @@ Example: - I := RANDOM() : INDEPENDENT; //calculated once, period + 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 index cbc1dd33cfc..93b355e7be4 100644 --- a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-PERSIST.xml +++ b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-PERSIST.xml @@ -23,9 +23,10 @@ | MULTIPLE MULTIPLE [(count)]] ) + role="bold">)]] [,LABEL(text)]); PERSIST workflow service - ; + @@ -155,6 +156,21 @@ omitted, the system default is used. If set to -1, then an unlimited number are kept. + + + LABEL + + Optional. Defines the Text 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. + + + + text + + A string constant containing the text to display. + diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-SUCCESS.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-SUCCESS.xml index 2114bf74bb5..9a90211cbf3 100644 --- a/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-SUCCESS.xml +++ b/docs/EN_US/ECLLanguageReference/ECLR_mods/WkFlo-SUCCESS.xml @@ -8,9 +8,10 @@ : SUCCESS SUCCESS (handler) + role="bold">) [,LABEL(text)]; SUCCESS workflow service - ; + @@ -36,6 +37,21 @@ The action to run if the expression succeeds. + + + LABEL + + Optional. Defines the Text 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. + + + + text + + A string constant containing the text to display. +