Navigation Component
Overview
The Navigation component creates a multi-page navigation experience in a single module. The Navigation component uses Panel components to represent different pages for end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. to navigate through an application.
By default, the Navigation component has a variety of navigation and event buttons. These include:
- Previous and Next buttons
- A Save Draft and Exit button
- A Submit button
You can also add custom navigation buttons. To learn more, see our Custom Navigation Buttons article.
The default navigation style is navigation bubbles at the top of the page. You can also use tabs or a table of contents-style navigation.
You'll find the Panel component in the Display & Layout group to the left of the Module Builder.
What You'll Learn
After completing this
About the Configuration Window
General
Setting |
Description |
---|---|
Property ID |
A Property ID is the unique field ID used by Unqork to track and link components in your module. The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls. Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation. |
Notes |
Select this tab to display the component's Notes area. You can use notes to keep your teammates informed. The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component. |
Display |
Select this tab to manage your component's display settings. |
Data |
Select this tab to manage your component's data settings. |
Advanced |
Select this tab to manage your component's advanced settings. |
Permissions |
Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. settings of the component. |
Field Tags |
Assign components one-word labels to help organize, identify, and group the components in your application. Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panel components. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag. Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component. For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag. Save your Field Tags by pressing Enter (Return) or adding a comma after each entry. |
Shortcuts |
Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:
Additional keyboard shortcuts:
|
Documentation |
Select this tab to access the component documentation in Unqork's In-Product Help. |
Cancel |
Click this button to undo any unsaved configuration changes and return to the Module Builder canvas. |
Save & Close |
Click this button to save all setting configuration changes and return to the Module Builder canvas. |
Display Panel
Field Text
Settings | Description |
---|---|
Canvas Label Text |
The Label Text field conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. Use user-friendly labels to make your module accessible. It's best practice to use brief and descriptive labels (one or two words). Use title case for short entries and sentence case for long entries. |
Settings | Description |
---|---|
Navigation Title |
Enter a title to display on every page. |
Navigation Subtitle |
Enter a subtitle to display on every page. |
Formatting
Settings | Description |
---|---|
Confirmation Button |
The text that displays in the Success and Error message modals A modal is a window that appears on top of the content you are currently viewing.. The default value is OK. |
Success Message |
The message that displays on successfully saving the submission. The default value is Success! |
Error Title |
The message that displays in a modal A modal is a window that appears on top of the content you are currently viewing. when validation errors are present. |
Save Draft and Exit Button |
The text that displays on the Save Draft and Exit button. The default value is Save Draft and Exit. After clicking Save Draft and Exit, your end-user sees a confirmation modal. |
Submit Button |
The text for the Submit button. The default value is Submit. |
Vertical Display |
Set to (ON) to display the navigation in vertical order. This navigation style looks like a table of contents at the left side of the page, with expandable groups of pages. Use the Group column in the Panels table to create and add top-level titles to the page groups. The default navigation style is navigation bubbles displayed in horizontal order. The default setting is (OFF). |
Show as Tabs |
Set to (ON) to use tabs-style navigation. The default navigation style is navigation bubbles. The default setting is (OFF). |
Validate on Every Navigation |
Set to (ON) to validate the module when the end-user clicks the Previous or Next buttons. You must also select either the Validate on User Navigation or Validate All Module Fields setting. For the Vertical Display to work, there must be a Group value in the Panels table. The default setting is (OFF). |
Display Errors on Top |
Set to (ON) to display validation error messages at the top of the page instead of the bottom. The default setting is (OFF). |
Settings | Description |
---|---|
Previous Button |
The text that displays on the Previous navigation button. The default label is Previous. |
Next Button |
The text that displays on the Next navigation button. The default text is Next. |
Save and Exit Message |
The text that displays in the Save and Exit modal. The modal displays when clicking the Save Draft and Exit button. |
Error Message |
The text that displays in the error message modal when validation errors are present. |
Save Draft URL |
The URL to redirect your end-user to after they click Save Draft and Exit. |
Submit URL |
The URL to redirect your end-user to after they click Submit. |
Scroll Position on Navigation |
This setting controls the end-user's scroll position when navigating between pages. Options include:
The default setting is Scroll to Top. |
Vertical Offset |
The number of pixels to move the Navigation component down by. Use this in applications with fixed headers to prevent the Navigation component from overlapping with the header. The Vertical Offset value is in pixels. |
Panels Table
The Panels table defines each page in the Navigation component. The Panel component referenced in the first row of the table becomes the first page. The Panel component referenced in the second row of the table becomes the second page, and so on. To improve user experience, use the smallest amount of pages possible.
The Panel components referenced in this table must nest inside the Navigation component.
Setting | Description |
---|---|
Group |
Enter a title for a group of Panels. This title displays when the Vertical Display setting is enabled. The Vertical Display navigation style looks like a Table of Contents, with expandable groups of pages. Set the top-level title for each group in this column. Using the same title in multiple rows will add that Panel to the page group. There must be a Group value for the Vertical Display to work. |
Title |
Enter a title to display below each navigation bubble. With Show as Tabs set to (ON), the value in this column displays as the tab's title. With Vertical Display set to (ON), the value in this column displays as the second-level title. |
Heading |
Enter a heading to display on this Panel's page. |
Value |
Enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. of a Panel component that will act as a page. |
Panel |
Enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. of a Panel component that will act as a page. |
Hide Previous |
Set to (checked) to hide the Previous navigation button on this Panel's page. By default, the Previous button doesn't display on the first page. |
Hide Next |
Set to (checked) to hide the Next navigation button on this Panel's page. By default, the Next button doesn't display on the final page. |
Hide Submit |
Set to (checked) to hide the Submit button on this Panel's page. By default, the Submit button displays only on the final page. |
Hide Draft |
Set to (checked) to hide the Save Draft and Exit button on this Panel's page. By default, the Save Draft and Exit button displays on every page. |
Save |
Set to (checked) to create a new submission or save to an existing submission after the end-user navigates away from this Panel's page. |
Post Trigger |
Enter the Property ID of the component to trigger when navigating away from this Panel's page. |
Post Validation Trigger |
Enter the Property ID of the component to trigger on validation of the module. Use in combination with either of the following settings:
|
Pre Trigger |
Enter the Property ID of the component to trigger when navigating to this Panel's page. Post Trigger triggers on the preceding page fire first. |
Post Save Trigger |
Enter the Property ID of the component to trigger on saving the submission. Use in combination with either of the following settings:
Save events created by clicking either the Submit button or the Save and Exit button won't trigger components entered in the Post Save Trigger field. |
Default State Options
Settings | Description |
---|---|
Hide Error Message |
Set to (checked) to prevent the end-user from seeing the error message. |
Hide Success Message |
Set to (checked) to prevent the end-user from seeing the success message. |
Disable User Input |
Set to (checked) to disable input for all nested components in Express View. Navigation between pages continues to work. |
Hide Field |
Set to (checked) to hide the Navigation component and all nested components in Express View. The components are always visible in the Module Builder. |
Data Panel
Settings | Description |
---|---|
Data Reference Key |
Enter a Property ID that contains a JSON JSON (JavaScript Object Notation) is an open standard file and data interchange format. Unqork uses JSON for submission (record) data. array to use as the Data Source. |
Store Data in Database |
The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:
By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission. Set the toggle to (OFF) when you don’t want to store the values from this field in the database. When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help. Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked. |
Advanced Panel
Additional Validation Settings
|
Additional Styling
Set Execution
|
Adding a Navigation Component
Let's say you want to collect information about a claim your end-user submitted. Configure a Navigation component with a two-page navigation experience. Use Panel components for each page of your module. On one page, end-users enter some basic information. On the next page, end-users enter some claim details before submitting the form.
For this configuration, you need:
- 1 Navigation component
- 2 Panel components
- 2 Text Field components
- 1 Date Input component
- 1 Number component
Configure the Navigation Component
First, add and configure the Navigation component. This component holds two Panel components that act as pages of the application.
1. | In the Module Builder, drag and drop a Navigation component onto your canvas. |
2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter navField. |
3. | In the Canvas Label Text field, enter navField. |
4. | In the Panels table, enter the following: |
Group | Title | Heading | Value | Panel |
---|---|---|---|---|
|
Basic Information |
Complete the following fields |
panelBasicInfo |
panelBasicInfo |
|
Your Claim |
Enter details about your claim |
panelClaim |
panelClaim |
5. | From the component's configuration menu, select Advanced. |
6. | Set Validate on User Navigation to (ON). |
7. | Click Save & Close. |
Configure the Panel Components
Add two Panel components inside the Navigation component. Each of these Panels becomes a page in your module.
1. | Drag and drop a Panel component onto your canvas, placing it inside the navfield Navigation component. |
2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter panelBasicInfo. |
3. | Set Hide Panel to (ON). |
4. | Click Save & Close. |
5. | Drag and drop a second Panel component onto your canvas, placing it inside the navfield Navigation component and below the panelBasicInfo Panel component. |
6. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter panelClaim. |
7. | Set Hide Panel to (ON). |
8. | Click Save & Close. |
Configure the Text Field Components
Next, add some Text Fields into the panelBasicInfo Panel component.
1. | Drag and drop a Text Field component onto your canvas, placing it inside the panelBasicInfo Panel component. |
2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter firstName. |
3. | In the Label Text field, enter First Name. |
4. | From the component's configuration menu, select Validation. |
5. | Set the Required toggle to (ON). |
6. | Click Save & Close. |
7. | Drag and drop a Text Field component onto your canvas, placing it under the firstName Text Field component. |
8. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter lastName. |
9. | In the Label Text field, enter Last Name. |
10. | From the component's configuration menu, select Validation. |
11. | Set the Required toggle to (ON). |
12. | Click Save & Close. |
Configure the Date Input Component
Add a Date Input component so your end-user can enter the date of their claim.
1. | Drag and drop a Date Input component onto your canvas, placing it inside the panelClaim Panel component. |
2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter dateClaim. |
3. | In the Label Text field, enter Date of Claim. |
4. | From the component's configuration menu, select Validation. |
5. | Set the Required toggle to (ON). |
6. | Click Save & Close. |
Configure the Number Component
Lastly, add a Number component for your end-user to add their claim's reference number.
1. | Drag and drop a Number component onto your canvas, placing it under the dateClaim Date Input component. |
2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter claimNumber. |
3. | In the Label Text field, enter Claim Reference Number. |
4. | From the component's configuration menu, select Validation. |
5. | Set the Required toggle to (ON). |
6. | Click Save & Close. |
Preview your module in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. You'll see the following functionality:
Structure of a Navigation Component's Data
The Navigation component presents as a key/value pair, where the key is the Property ID of the Navigation component, and the value is the Property ID of the Panel component displaying to the end-user. In the above example, the navfield Navigationcomponent is the key, and the panelClaim Panel component is the value.
Resources