Navigation Component

Navigation Component

Estimated Reading Time:  16 minutes

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

TIP  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 article, you’ll know when to use a Navigation component and how to configure its settings.

About the Configuration Window

General

A static image displaying the Navigation component's general settings.

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 Note-Icon

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 Icon Display

Select this tab to manage your component's display settings.

Data Icon Data

Select this tab to manage your component's data settings.

Advanced Icon Advanced

Select this tab to manage your component's advanced settings.

Permissions Icon 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. (role-based access control) settings of the component.

Field Tag Icon 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 Panels. 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 Icon Shortcuts

Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:

  • Cmd + S (Mac) / Ctrl + S (PC): Save and close the component settings modal.

  • Cmd + G (Mac) / Ctrl + G (PC): Opens a search window to find specific fields and settings in the component settings modal.

  • Tab: Tab to the next field or setting in the component settings modal. This keyboard shortcut tabs left to right and top to bottom.

  • Shift + Tab: Tab to the previous field or setting in the component settings modal. The keyboard shortcut tabs from right to left and bottom to top.

  • Enter (Return): When tabbing to a Tooltip Icon (tooltip), press Enter (Return) to display the field or setting tooltip. Press Enter (Return) again to hide the tooltip.

Additional keyboard shortcuts:

  • Drop-down menus: When you Tab to a settings drop-down, use the keyboard's Up-Arrow Icon (up)/ Down-Arrow icon (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.

Documentation IconDocumentation

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 canvas.

Save & Close

Click this button to save all settings as configured and return to the canvas.

Display Panel

A static image displaying the Navigation component's Display settings.
(click image to expand)

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.

NOTE  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 Toggle On Icon (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 Toggle Off icon (OFF).

Show as Tabs

Set to Toggle On Icon (ON) to use tabs-style navigation. The default navigation style is navigation bubbles.

The default setting is Toggle Off icon (OFF).

Validate on Every Navigation

Set to Toggle On Icon (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.

NOTE  For the Vertical Display to work, there must be a Group value in the Panels table.

The default setting is Toggle Off icon (OFF).

Display Errors on Top

Set to Toggle On Icon (ON) to display validation error messages at the top of the page instead of the bottom.

The default setting is Toggle Off icon (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:

  • Scroll to Top: Scrolls to the top of the application when a new page is accessed.

  • Stay in Place: Displays the new page without scrolling.

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.

NOTE  The Panel components referenced in this table must nest inside the Navigation component.

A static image displaying the Navigation component's Panels table.
(click to expand image)

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.

NOTE  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 Toggle On Icon (ON), the value in this column displays as the tab's title. With Vertical Display set to Toggle On Icon (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 Box Icon (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 Box Icon (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 Box Icon (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 Box Icon (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 Box Icon (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:

  • Validate on User Navigation: Validates when the end-user clicks the Next button on any page or Submit button on the final page.
  • Validate All Module Fields: Validates when the end-user clicks the Submit button on the final page.

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:

  • Panels table - Save Column: Check the Save checkbox in the same row.
  • Save on User Navigation: Set to Toggle On Icon (ON) to enable save on forward navigation. The Post Save Trigger triggers on user navigation.

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 Box Icon (checked) to prevent the end-user from seeing the error message.

Hide Success Message

Set to Checked Box Icon (checked) to prevent the end-user from seeing the success message.

Disable User Input

Set to Checked Box Icon (checked) to disable input for all nested components in Express View. Navigation between pages continues to work.

Hide Field

Set to Checked Box Icon (checked) to hide the Navigation component and all nested components in Express View. The components are always visible in the Module Builder.

Data Panel

A static image displaying the Navigation Component's Data settings.
(click image to expand)

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 Toggle On Icon (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:

  • Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.

  • Triggering a module save event using a Button component with an Action Type of Save.

  • Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.

NOTE  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 Toggle Off icon (OFF) when you don’t want to store the values from this field in the database.

NOTE  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.

TIP  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 Toggle On Icon (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Advanced Panel

A static image displaying the Navigation Component's advanced settings.
(click image to expand)

Additional Validation Settings

Settings Description

Save on User Navigation

Set to Checked Box Icon (checked) to create a submission when your end-user navigates between the first and second pages. The submission then updates and saves any changes on every subsequent navigation.

By default, only clicking the Submit or Save Draft and Exit buttons create a submission.

Validate on User Navigation

Set to Checked Box Icon (checked) to validate the module whenever your end-user clicks the Next or Submit buttons.

When validation errors are present, your end-user cannotnavigate away.

Validate Upon Opening Submission

Set to Checked Box Icon (checked) to validate the module when your end-user opens a new submission.

Validate All Module Fields

Set to Checked Box Icon (checked) to validate all fields in the module, not just the fields visible on the current page.

All validation errors display on the final page when your end-user clicks Submit.

IMPORTANT  This setting is not supported when the Stagger Load for Performance setting is set to Checked Box Icon (checked).

Allow User to Navigate with Errors

Set to Checked Box Icon (checked) to let your end-user navigate between pages despite validation errors. Your end-user can't submit their information when validation errors are present.

Disable Navigation Jumps

Set to Checked Box Icon (checked) to prevent end-users from navigating between pages in non-sequential order. For example, by clicking the navigation bubbles.

Additional Styling

Settings Description

Custom CSS Class

Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules.

Updated CSS styling applies to all components that reference this custom class name.

Set Execution

Settings Description

Stagger Load for Performance

Set to Checked Box Icon (checked) to prevent the Navigation component's Panel components from being loaded into the module until the end-user 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. makes them visible by navigating to that Panel component step. Doing so improves loading and navigation performance in larger Navigation components with many Panel components or components in the Panel components.

NOTE  When set to Checked Box Icon (checked), components remain hidden and do not trigger until displayed. These components include those with Hide Field set to Toggle On Icon (ON) or when a logic component controls another component with a hidden Output Type.

By default, the Stagger Load for Performance setting is set to (unchecked).

Debounce Setting

The number of milliseconds that pass before the module loads this component. This is useful if you have a large module and you load several components at the same time. 1,000 milliseconds = 1 second.

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:

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 Icon 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

NOTE  You'll set up the panelBasicInfo and panelClaim Panel components next.

A static image displaying the Navigation Component's Panels-table settings. The Title, Heading, Value, and Panel columns are filled out.

5. From the component's configuration menu, select Advanced Icon Advanced.
6. Set Validate on User Navigation to Toggle On Icon (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 Icon Panel component onto your canvas, placing it inside the navfield Navigation Component Icon 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 Toggle On Icon (ON).
4. Click Save & Close.
5. Drag and drop a second Panel Component Icon Panel component onto your canvas, placing it inside the navfield Navigation Component Icon Navigation component and below the panelBasicInfo Panel Component Icon 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 Toggle On Icon (ON).
8. Click Save & Close.

Configure the Text Field Components

Next, add some Text Fields into the panelBasicInfoPanel Component Icon Panel component.

1. Drag and drop a Text Field Icon Text Field component onto your canvas, placing it inside the panelBasicInfo Panel Component Icon 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 icon Validation.
5. Set the Required toggle to Toggle On Icon (ON).
6. Click Save & Close.
7. Drag and drop a Text Field Icon Text Field component onto your canvas, placing it under the firstName Text Field Icon 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 icon Validation.
11. Set the Required toggle to Toggle On Icon (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 icon Date Input component onto your canvas, placing it inside the panelClaim Panel Component Icon 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 icon Validation.
5. Set the Required toggle to Toggle On Icon (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 icon Number component onto your canvas, placing it under the dateClaim Date Input Component icon 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 icon Validation.
5. Set the Required toggle to Toggle On Icon (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 Navigation Component Icon Navigationcomponent is the key, and the panelClaim Panel Component Icon Panel component is the value.

A static image displaying the Developer Console in Express view. The angular command reveals the Navigation component's key value pair.

Resources