Navigation
Navigation Construct facilitates navigation between different views (interfaces or master layouts). This feature allows developers to define navigation logic programmatically, improving control over routing behaviour and transitions. It helps users move from one screen to another.
Follow the below steps to add the Navigation construct in an event or function flow:
- In the designer canvas of an event flow, drag and drop the Navigation construct into the flow.
- Double-click the construct to configure the properties as required and then click Save.
| Property | Description | Comments |
|---|---|---|
| Label | Specify a label that represents the purpose of the construct within the logic flow. | It is recommended to provide a simple, precise label to improve readability. |
| Navigation Type | Select the type of navigation. Fields displayed in properties depend on the selected navigation type. Options: Static, Dynamic Static Navigation allows navigation in the following ways: Internal Navigation: Navigate to existing Interfaces or Master Layouts within the application. Query parameters can be included. External Navigation: Navigate to an external route or URL with optional query parameters. Programmatic Navigation: Mimic browser back and forward button functionality by navigating through browsing history. Dynamic Navigation allows navigation between screens dynamically based on user actions or data changes. | If Static type is selected, then below fields are visible. Type Navigate To Query Parameters If Dynamic type is selected, then below fields are visible. Property Dynamic Query Parameters |
| Type | This is the type of the page to be navigated. | Following are the list of options: Master Layout Interface External – Allows navigation to external url’s Back: Allows navigation to the previously visited page in their browsing history. Query Parameters, Navigate To and Url fields are invisible. Forward: Allows navigation to the next page in their browsing history. Query Parameters, Navigate To and Url fields are invisible. |
| Navigate To | It is loaded with all existing interfaces and master layouts based on the Type selected. It is visible when selected type is interface or master layout only. | When the ‘Type’ is set to Interface or Master Layout, the Navigate To option becomes visible. If type is Interface: load all existing Interfaces. When the ‘Type’ is set to Interface or Master Layout, the Navigate To option becomes visible. If type is Interface: load all existing Interfaces. If Type is Master Layout: load all existing Master Layouts. |
| Url | Specify External Url using Expression Builder. | This field is visible only when the Type is set to External. |
| Query Parameters | Query parameters are key value pairs to the Static Type navigation pages. | Query Parameters are visible only when Navigation Type is set to Static and Type is set to Interface, Master Layout or External. User can add query parameters as Name and Value pairs. |
| Property | Allows User to assign Property which contains routing URL using expression builder. | This field is visible only when the Navigation Type is set to Dynamic. |
| Dynamic Query Parameters | Allows User to assign Property using expression builder which contains Query parameters as Name and Value pairs. | This field is visible only when the Navigation Type is set to Dynamic. |
| Comment | Specify whether to comment this construct or not. Either Yes or No. | By default, it is set to No. If marked as Yes, the construct is treated as a commented expression and ignored in code generation. |
| Description | Provides details about the Navigation purpose and behaviour. | Helps in understanding Navigation construct |
Note: An asterisk (*) denotes that the property is mandatory for adding the Navigation construct.
The success message displays upon successfully adding the construct.
Query Parameters
Query parameters are a part of the URL used to pass additional information to a route through the URL. They appear after the question mark ? in a URL and are typically key-value pairs, separated by an ampersand (&).
Here is an example of a URL with query parameters:
https://www.example.com/products?category=electronics&price=low