Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

...

General Guidelines

Variables and Arguments


In general terms of parameters in WF4, there are two main concepts: Variables and Arguments. The definitions for each are that Variables are used to store data within a workflow and Arguments are used to passing pass data in/out of a workflow. The concept of „binding" parameters has been replaced with the usage of variables and arguments.
Variables are to be used in a workflow whenever the need to store data is limited to the current workflow and the output/input of the workflow is not used anywhere else (for example in Admin Suiteanother workflow).
Arguments are to be used whenever the input parameters of an activity are given by the user using for instance a web-based application, (for example when running executing a workflow in Admin Portal) and or if the output of an activity is to be returned and used outside of DesignStudio Flowster Studio Designer application. (for example Admin Portal)
All parameters that have an Expression editor in Activity Properties panel can be used for value storage and passing, through variables and arguments.
Example: Collection From String activity 
 Image Removed
 
Defined IN arguments, with default value to be filled in by the user when running the workflow:
Image Removed
Defined variables to store the output of the Collection From String activity:
Image Removed
Parameters with different editors, like Folder editors or ComboBox cannot be bound to variables nor arguments.
.

Each activity has a predefined set of Input/Output parameters. Depending on the requirements and business scenarios, variables and arguments may be required.
Each Input parameter from each activity has an editor. The default editor is the Expression Editor which allows string values to be inserted. In the example below, the activity used is Length (check the Misc->Display Name property) from the String Operations library . This activity has one input parameter, with an Expression editors that accept string values. The value "FlowsterStudio" was inserted directly in the Expression editor without the use of variables/IN arguments meaning that the value is now embedded in the workflow after check-in. This represents the basic value insertion for activity parameters.

  Image Added

If the value for the "InputString" parameter should not be embedded in the workflow and the value would be given on execution time, for example when executing the workflow from the Portal, then an IN argument is defined for the "InputString" parameter. The arguments are defined in the workflow Designer panel, Parameters section, Arguments tab. Each argument defined in this section should have a name, direction( IN for input values , OUT for output values, IN/OUT for arguments that are used for both input and output purposes). The argument type must match the desired input parameter's type from the activity (for example, for Length activity, the InputString parameter has a string type, so the defined argument InputString should have the same type).
 
 Image Added


Activity Properties


In general terms of activities properties, there are three main concepts: "Tracking Outputs", „Stop Enabled, Stop On Error" and „Enabled". 
 
 Image Removed and Track Outputs. These three properties are defined for each activity in Flowster Studio Activity Library.
 Image Added
 
The concept of „Stop on error" and „Enabled" Stop On Error and Enabled mechanisms are defined for Runtime Execution purposes.

Image RemovedImage Added

 The "Track Outputs" property is defined for Tracking Data panel.  


 Image RemovedImage Added


 
 
 
Stop on error" PropertyError


Th The default value for the "Stop On on Error" property is set to "Yes". When dragging an activity in the Workflow workflow Designer panel, the activity will have this property set to "Yes". Image Removed  Image Removed

On runtime (nn. execution (Home->(Execution section) Start button), if the "Stop on error" Error property is set to "Yes" for an activity , and an error or exception is thrown, the execution of the workflow stops on the activity that caused the error /exception to be thrown and the workflow is automatically aborted. 


 Image Added
 
Image Removed

If "Stop on error" Error property is set to "No", the error message is displayed in Tracking Data panel, but the execution of the workflow continues. 

 Image Removed   Image RemovedImage Added 
  Image Removed

 

 „Enabled" Property
On runtime, if the Enabled

The default value for the Enabled property is set to "Yes". When dragging an activity in the workflow Designer panel, the activity will have this property set to "Yes". 

On execution (Home->(Execution section) Start button), if the Enabled property is set to "Yes for an activity", the activity is executed. 
 

Image RemovedImage Removed

 Image Removed
 's logic block will be executed and if results are returned by the activity, they will be displayed in the Tracking Data panel.

Image Added
 
If the Enabled property is set to "No", the activity will be disabled and it will 's logic block will not be executed on runtimeduring execution and the activity block will appear faded in the workflow Designer panel

Image Added
  Image Added
 Image Removed    Image Removed
  Image Removed

"Track Outputs" property

If set to Yes, the result of the executed activities will Track Outputs

The default value for the Track Outputs property is set to "No". When dragging an activity in the workflow Designer panel, the activity will have this property set to "No". 

On execution (Home->(Execution section) Start button), if the Track Outputs property is set to "No", the output results returned by the activity they will not be displayed in the Tracking Data panel.

Image Removed Image Removed

The result displayed in Tracking Data panel represents the output of the activity "CollectionFromString".

Image Removed

 

If set to No, the result of the executed activities will not Image Added

if the Track Outputs property is set to "Yes", the output results returned by the activity they will be displayed in the Tracking Data panel.

Image Removed  Image Removed

Image RemovedImage Added




 
 
 
 
 
Anchor_GoBack_GoBack