Jump to: navigation, search

Difference between revisions of "Activity:InvokeWorkflow (Activity)"


(Created page with "The InvokeWorkflow activity invokes a {{UBIK}} Workflow. {{ActivityInfoBox | title = Invoke Workflow | name = InvokeWorkflow | image = | imagecaption = Activit...")
 
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
The InvokeWorkflow activity invokes a {{UBIK}} [[Workflow|workflow]].
 
The InvokeWorkflow activity invokes a {{UBIK}} [[Workflow|workflow]].
 
+
= Description =
 
+
 
{{ActivityInfoBox
 
{{ActivityInfoBox
 
| title = Invoke Workflow
 
| title = Invoke Workflow
Line 13: Line 12:
 
}}
 
}}
  
 
+
===Arguments===
 
+
 
+
 
+
==Arguments==
+
 
+
 
{| class="wikitable sortable" | width = "50%"
 
{| class="wikitable sortable" | width = "50%"
 
|-
 
|-
 
! Argument !! Type !! Direction !! Purpose  
 
! Argument !! Type !! Direction !! Purpose  
 
|- align="left"
 
|- align="left"
| Workflow|| Workflow|| In || The {{UBIK}} workflow object to invoke
+
| Workflow|| [[Workflow]]|| In || The {{UBIK}} workflow object to invoke
 
|- align="left"
 
|- align="left"
| WorkflowName|| String|| In || The name of the workflow to invoke, overrules the ''Workflow'' argument if set
+
| WorkflowName|| {{String_MSDN}}|| In || The name of the workflow to invoke, overrules the ''Workflow'' argument if set
 
|- align="left"
 
|- align="left"
| UBIKObject|| BaseClass || In || A valid object; this argument is mandatory if ''WorkflowName'' is used
+
| UBIKObject|| [[BaseClass]] || In || A valid object; this argument is mandatory if ''WorkflowName'' is used
 
|- align="left"
 
|- align="left"
| VerboseErrors|| Boolean|| In|| True to show workflow errors on the UI, false to suppress them
+
| VerboseErrors|| {{Boolean_MSDN}}|| In|| True to show workflow errors on the UI, false to suppress them
 
|- align="left"
 
|- align="left"
| InArguments|| Dictionary<string, object>|| In|| A list with arguments to pass to the workflow
+
| InArguments|| IDictionary<{{String_MSDN}}, {{Object_MSDN}}>|| In|| A list with arguments to pass to the workflow
 
|- align="left"
 
|- align="left"
| OutArguments|| Dictionary<string, object>|| Out|| A list of arguments returned from the workflow, empty if none are returned
+
| OutArguments|| Dictionary<{{String_MSDN}}, {{Object_MSDN}}>|| Out|| A list of arguments returned from the workflow, empty if none are returned
 
|- align="left"
 
|- align="left"
| Result|| Boolean|| Out || True if successful, false if failed
+
| Result|| {{Boolean_MSDN}}|| Out || True if successful, false if failed
 
|}
 
|}
  
==Usage==
+
===Usage===
 
+
 
This activity is used to load and invoke workflows from within a workflow. It is very useful to split complex workflows into handy and reusable portions and invoke them from other workflows.
 
This activity is used to load and invoke workflows from within a workflow. It is very useful to split complex workflows into handy and reusable portions and invoke them from other workflows.
  
==Example==
+
=Example=
 
+
Assign an icon to a given object by invoking the workflow ''WFICON'' and passing the object stored in the variable ''UBIKObject'' as first and only argument:
Assign an icon to a given object by invoking the workflow ''WFICON'' and passing the object as first and only argument:
+
  
 
{| class="wikitable" | width = "50%"
 
{| class="wikitable" | width = "50%"
Line 57: Line 49:
 
|- align="left"
 
|- align="left"
 
| InArguments||  <source lang = "vbnet">New System.Collections.Generic.Dictionary(Of String, object) _
 
| InArguments||  <source lang = "vbnet">New System.Collections.Generic.Dictionary(Of String, object) _
From {"UBIKObject", UBIKObject}</source>
+
From {{"UBIKObject", UBIKObject}}</source>
 +
|- align="left"
 +
| OutArguments || connect this argument with a variable of type <source lang = "vbnet">IDictionary(String, object)</source> and access the value via <source lang = "vbnet">outArgs("keyName")</source>
 
|}
 
|}
 +
 +
{{Activity/End}}
  
 
==See also==
 
==See also==
 
* [[Workflow Designer]]
 
* [[Workflow Designer]]
* [[InvokeInterface (Activity)]]
+
* [[Activity:InvokeInterface (Activity)]]
  
[[Category:Workflows]] [[Category:Activities]]
+
[[Category:Activities]]

Latest revision as of 10:23, 19 March 2015

The InvokeWorkflow activity invokes a UBIK® Workflow.

[edit]

Description

Invoke Workflow
Name InvokeWorkflow
Purpose Invoke a workflow
Category Control Flow
Returns True if successful
Version 2.1.14+

Arguments

Argument Type Direction Purpose
Workflow Workflow In The UBIK® workflow object to invoke
WorkflowName String In The name of the workflow to invoke, overrules the Workflow argument if set
UBIKObject BaseClass In A valid object; this argument is mandatory if WorkflowName is used
VerboseErrors Boolean In True to show workflow errors on the UI, false to suppress them
InArguments IDictionary<String, Object> In A list with arguments to pass to the workflow
OutArguments Dictionary<String, Object> Out A list of arguments returned from the workflow, empty if none are returned
Result Boolean Out True if successful, false if failed

Usage

This activity is used to load and invoke workflows from within a workflow. It is very useful to split complex workflows into handy and reusable portions and invoke them from other workflows.

Example

Assign an icon to a given object by invoking the workflow WFICON and passing the object stored in the variable UBIKObject as first and only argument:

Argument Value
WorkflowName
"WFICON"
UBIKObject Connect this argument with a variable
VerboseErrors
True
InArguments
New System.Collections.Generic.Dictionary(Of String, object) _
From {{"UBIKObject", UBIKObject}}
OutArguments connect this argument with a variable of type
IDictionary(String, object)
and access the value via
outArgs("keyName")


See also