Difference between revisions of "Custom Expression Builder"

From Hornbill
Jump to navigation Jump to search
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
+
This document can now be found at its new location in the [https://docs.hornbill.com/servicemanager-config/customize/workflows/decision Hornbill Document Library].
__NOTOC__
+
 
{| style="width:100%"
+
[[file:hornbill-document-library.png|Decision Node and Custom Expressions|link=https://docs.hornbill.com/servicemanager-config/customize/workflows/decision]]
|[[Main Page|Home]] > [[Administration]] > [[Business Process Designer]] > Custom Expression Builder
+
<!--
|style="text-align:right;"|[[:Category:Administration|Index]]
 
|}
 
</div>
 
{|style="width: 100%"
 
|- valign="top"
 
|style="width:73%"|
 
==Introduction==
 
Following a decision node in a business process it is possible to branch on the outcomes of the node preceding the decision node. Default outcomes are presented as options, and these may include:
 
  
* No Match
 
* Expiry
 
* Task or Authorisation outcomes
 
  
In addition to the automated options which you can branch on, you can also build your own custom expressions and branch on these using the custom expression builder
+
{{breadcrumb|[[Main Page|Home]] > [[Configuration]] > [[Business Process Designer]] > Custom Expression Builder|Administration}}
 +
{{Section|
 +
==Introduction==
 +
[[File:bpmdecisionexpression.png|right|300px]]
 +
A Decision Node within a Workflow allows the workflow to branch down different paths based on the outcomes of previous nodes within the workflow stage. Default outcomes are available to test the outcomes of the node that immediately precedes the decision node. The outcomes available will depend on the node that precedes the decision node and may include:
  
|style="width:5%"|
+
:* Failure
|
+
:* Success
|style="width:22%; border-style: solid; border-width: 1px; border-color:#e6e6e6; background-color:#f2f2f2;"|
+
:* No Match
 +
:* Expired
 +
:* Task or Authorisation outcomes
  
== Related Articles ==
+
In addition to these default options, you can also build your own custom expressions using the Custom Expression Builder. Custom Expressions will allow you to evaluate the outcomes of any node that precedes the decision node within the same stage.|
 +
{{rightBox|Related Articles|
 
:* [[Variable Picker]]
 
:* [[Variable Picker]]
|}
+
:* [[Business Process Designer]]
 
+
:* [[BPM Authorization]]
==What is the Custom Expression Builder==
+
}}
 
+
}}
Think of the custom expression builder as a rules engine, what you are defining are rules / conditions, if these rules / conditions are met the expression is met and it's path out of a decision node will be followed.  
+
{{Section|
 
+
==What is a Custom Expression==
 
+
[[File:bpmcustomexpress.png|right|350px]]
==Building Rules (Expressions)==
+
A Custom Expression consists of one or more tests that evaluate the outcomes of nodes within the current stage. If the tests within the expression are met, that path out of the decision node will be followed. To add a Custom Expression, click on the description box of a connector that exits a Decision Node and in the ''Goto If'' dialog box, select ''Custom Expression'' from the list of outcomes.
 +
|}}
  
The custom expression builder provides the ability to create one or multiple rules which can be evaluated when run.
+
==Building Expressions==
 +
[[File:custom_expression_builder.png|right|500px]]
 +
The custom expression builder allows you to create one or more tests which can be evaluated when a workflow reaches the decision node.
  
===Adding your first Rule===
+
===Adding your first Expression===
  
 
Following a decision node, draw out a line and add a new node.  On the line you have drawn out you will see '''??''' icons.  Click on the icons and a pop up window is presented, this will contain a drop down with default outcomes and an option for '''Custom Expression'''.   
 
Following a decision node, draw out a line and add a new node.  On the line you have drawn out you will see '''??''' icons.  Click on the icons and a pop up window is presented, this will contain a drop down with default outcomes and an option for '''Custom Expression'''.   
Line 44: Line 43:
 
===Options===
 
===Options===
  
* By default the rule '''question''' will be presented in the '''Selected Test Setup''' section picked up from the node proceeding the decision node.  This can be left the same or using the '''Variable Picker''' Icon you can change what you want to evaluate by choosing from the list of available variables (See the variable picker to understand what options can be presented here)
+
* By default the rule '''question''' will be presented in the '''Selected Test Setup''' section, picked up from the node proceeding the decision node.  This can be left the same or using the '''Variable Picker''' Icon you can change what you want to evaluate by choosing from the list of available variables (See the variable picker to understand what options can be presented here)
  
 
* '''Operators''' - Choose what condition for the chosen question you are looking to test ( ==, Contains, <,> etc)
 
* '''Operators''' - Choose what condition for the chosen question you are looking to test ( ==, Contains, <,> etc)
Line 62: Line 61:
  
 
* AND / OR - Decide if the defined rules (expressions) must all match or if there is a combination of AND or OR conditions
 
* AND / OR - Decide if the defined rules (expressions) must all match or if there is a combination of AND or OR conditions
* Groupings '''('''  ''')'''  - Use the expression groupings to build out more complex (rule / expressions)  
+
* Groupings '''('''  ''')'''  - Use the expression groupings to build out more complex (rule / expressions)
  
 
==Administration==
 
==Administration==
Line 70: Line 69:
 
* Use the '''Delete All''' option to delete all the rules (expressions)  
 
* Use the '''Delete All''' option to delete all the rules (expressions)  
  
 
+
-->
[[Category:Administration]] [[Category:Service Manager]]
+
[[Category:HDOC]]

Latest revision as of 23:46, 31 May 2024

This document can now be found at its new location in the Hornbill Document Library.

Decision Node and Custom Expressions