You are viewing the documentation for Blueriq 16. Documentation for other versions is available in our documentation directory.

What is it?

A SinglePageFlow acts as a grouping of actions that belong to one topic for the user in a free navigable application.

How to use it

The first page of a SinglePageFlow is used as a navigable entry point in a free navigable flow any subpages that are modelled in a SinglePageFlow will be handle by the sequential for flow engine. The display title of the first page in a SinglePageFlow becomes a menu item of the AQ_NavigationMenu, that the user can press to navigate to said page.

Any logic which is modelled at the start and the end of a SinglePageFlow will be executed every time the SinglePageFlow is visited. Flow actions that are handled in between pages of the SinglePageFlow will only be executed when visited just like a normal sequential flow.  

To navigate between SinglePageFlow in a free navigable flow the first page must contain a button with default (empty) exit event or a named exit event called "NextPage", this exit event must be either directly connected to the EndNode of the SinglePageFlow or a non-interactive FlowNode leading to the EndNode.

To navigate to the previous SinglePageFlow in a free navigable application the first page must contain a button with a named exit event called "PreviousPage", this exit event does not have to be connected in flow.

Side step from the free navigable flow

In the situation that a side step out of the free navigable flow is needed in order to perform a more sequentially validated flow, you can model an exit event on the main page to take a side step to either another page or a sub flow. Any side steps taken from the main page in the SinglePageFlow are subjected to the standard flow strategy, meaning that validations become blocking again and if a AQ_NavigationMenu is modelled on a page it will become disabled. 

Any side steps taken in the SinglePageFlow should return back to the main page of the flow or exit the free navigable flow all together. It should never be connected to the EndNode of the free navigable flow, to prevent unexpected behavior.

Constraints

  1. Validations on a first page in a SinglePageFlow are non blocking.
  2. The title of the first page in a SinglePageFlow is used in the AQ_NavigationMenu.
  3. Flow actions that are modelled before the first page and before the EndNode of the SinglePageFlow will be executed every time the flow is visited.
  4. The "NextPage" or default exit event of the first page must be connected to EndNode or a FlowNode that leads to the EndNode.
  5. Side steps from the first page in a SinglePageFlow should either return to the first page or exit the free navigable flow via a different EndNode.