Versions Compared

Key

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

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue

This page provides details of the properties for the  Insert excerpt_action_gateway_action_gatewaynopaneltrue action

Example

Image Removed

In the above image there is a screen displaying a list of orders that require approval. In this particular workflow a user can approve orders with a value < £1000 without having to confirm the approval. The approve actionflow therefore requires a gateway node to capture of any of the selected orders have a value > £1000. 

Provide screenshot and more details once confirmation and phases have been implemented


Excerpt

This page is for application designers who need to configure functionality for components or events. It explains the properties for the gateway node, which is part of an actionflow.

Overview

Image Modified

Use a 

Insert excerpt
_action_gateway
_action_gateway
nopaneltrue
node to control the path that data records take as they flow through an actionflow. You can add several output connection points. On the output connection points, you can specify decision logic to control the path of data, record by record.

Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone

For a worked example, see Gateway Action Configuration.

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
_parent
_parent
nopaneltrue

Basic Settings

FieldDescription
NameEnter the name
for _actionflow_properties_actionflow_propertiesnameshow-namenopaneltrue
of the action node.
Insert excerpt
Exclusive

Control whether or not a record can go through more than one output. 

Exclusive Gateway (Single path)

Insert excerpt
_

actionflow

toggle_

properties

on
_

actionflow

toggle_

propertiesnameshow-text

on
nopaneltrue

Input Connection Points

This section has a toolbar with standard buttonsThe grid contains a list of all input connection points and their type. Gateway nodes can have:

one 

 to make a record go through the first connection point where the condition is met. Exclusive gateways include the visual indicator of their setup: Image Added

Inclusive Gateway (Multiple Paths)

Insert excerpt
_

driving_input_connection_point

toggle_off
_

driving_input_connection_point

toggle_off
nopaneltrue

multiple  Insert excerpt_request_input_connection_point_request_input_connection_pointnopaneltrue'sTo add a new input connection point, in the section toolbar click  Insert excerpt_add_addnopaneltrue to open a new input connection point and set its properties.
  • To edit an existing input connection point, double-click it in the list to open its properties.
  • To remove an input connection point, select one and in the section toolbar click  Insert excerpt_delete_deletenopaneltrue.

    For input connection point properties, see Connection Points.

    Output Connection Points

    This section has a toolbar with standard buttonsThe grid contains a list of all output connection points. Each output connection point has an expression that specifies the logic to control whether or not records flow to the next action node. 

    For driving output connections, you can refer to an attribute in the expression using the syntax:

    Code Block
    connectionpointname.attributename

    If the expression evaluates to true for the record flowing through the node, it will pass out that connection point onto the next node in the sequence. This can be dependent on if the gateway is marked as exclusive, see below.

    FieldDescriptionExclusive

    Used to control if a stream-item can flow through more than one option. Todo-Fiona - Where does this property appear?

    Insert excerpt_check_box_tick_check_box_ticknopaneltrue the stream-item flows out the first connection point where the condition is met. Insert excerpt_check_box_untick_check_box_unticknopaneltrue the stream-items will flow out of any connection point where the condition is met.

    Output paths process data using expressions; see pages in the topic Expressions and PhixScripts.

    Gateways can have an unlimited number of output paths.

    Stream-items will only pass through the output paths if the condition set in the expression is met.

    Note

    Remember to check if if the gateway has been marked as Exclusive. Records will only pass through the first output path where the condition is met if the gateway is exclusive.

    This section has a toolbar with standard buttonsThe grid contains a list of output connection points and their expressions. 

    To add a new output path

     to make a record go through all connection points where the condition is met. Inclusive gateways include the visual indicator of their setup: Image Added

    Description

    We recommend that you always enter a description to explain the purpose of this item.

    Rules

    FieldDescription
    RuleThe expression to be evaluated. If the condition is met, the record will go through the connection point or points (depending on if the gateway is exclusive or inclusive, see above).
    OutputThe name of the output connection point.              
    OrderThe order the rules should be evaluated in.

    Input Connection Points

    Gateway nodes can have:

    • one 
      Insert excerpt
      _driving_input_connection_point
      _driving_input_connection_point
      nopaneltrue
    • multiple 
      Insert excerpt
      _request_input_connection_point
      _request_input_connection_point
      nopaneltrue
      s

    The grid contains a list of all input connection points and their type.

    • To add a new input connection point, in the section toolbar click 
      Insert excerpt
      _add
      _add
      nopaneltrue
       to open a new
    output path
    • input connection point and set
    the expression
    output path
    • input connection point, double-click it in the list to open its properties.
    • To remove an
    output path
    • input connection point, select one and in the section toolbar
    click Image Removed Permanently Delete

    The expression properties has sections for Parent Details , Audit Summary and the following Basic Settings:

    Field

    DescriptionNameEnter an expression name.OrderWhere the gateway action runs and expression for each output path, enter a number to indicate the order in which this expression will be run. Remember that an expression that generates a value should run before an expression that uses the value. The order is especially important if the gateway is marked as exclusive.ExpressionEnter an expression which evaluates to true or false to determine if stream-items will pass through this connection point. To work in a larger pop-up window,

    See also:

  • Expression Basics
  • Internal Variables
    • click 
    Image Removed.
    _access
    • Functions
      • Insert excerpt
        _
      description
      • delete
        _
      description
      • delete
        nopaneltrue
    Insert excerpt
    _property_tabs_property_tabs
    nameaccess-h
    nopaneltrue
    Insert excerpt
    _access
    • .

    Advanced

    FieldDescription

    Prioritise Throughput Over Ordering

    Insert excerpt
    Actionflow Properties
    Actionflow Properties
    namePrioritiseThroughputOverOrdering
    nopaneltrue


    Insert excerpt
    _audit
    _audit
    nopaneltrue