Checkpoint Component

Overview

The Checkpoint component helps you track an 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.'s location in an application In Unqork an application is a program used to perform specific tasks. An application can be one of two types: workflow or module.. You can place Checkpoint components throughout your application. When end-users reach a checkpoint, the component records a timestamp.

You can use this timestamp data in many ways, including:

• Creating a dashboard that displays crucial "drop-off" points in your application.

• Integrating with client data to notify end-users to complete their unfinished work.

For the Checkpoint component to work, you need to trigger it. The easiest way to trigger a Checkpoint component is with an Initializer component.

There's no visual aspect of a Checkpoint component. When a Checkpoint component fires, it creates an entry in the submission data. You can retrieve this data using metadata.checkpoints.<checkpointPropertyID> and view its timestamp in Unix Unix time is measured by the number of seconds elapsed since 00:00:00 UTC on 1 January 1970, the beginning of the Unix epoch. time.

You'll find the Checkpoint component under the Data & Event Processing group to the left of the Module Builder.

What You'll Learn

After completing this article, you’ll know when to use a Checkpoint component, how to configure its settings, and how to use it in an Unqork application.

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.
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: 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), 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)/  (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.
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

(click to expand image)

Field Text

Setting	Description
Label Text	Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Data Panel

(click to expand image)

User Input

Setting

Description

Allow Checkpoint to Be Set Multiple Times

When set to  (ON), the end-user triggers the Checkpoint component every time they reach a set point in the application. The end-user can also trigger the checkpoint by going backward in the application and then returning to the Checkpoint component's location. When set to (OFF), the Checkpoint component only records the first time an end-user reaches the checkpoint. By default, this toggle is set to (OFF).

Adding a Checkpoint Component

Configure a Checkpoint component to fire when your end-user applies a signature with a Signature component. You'll use an Initializer component to trigger the Checkpoint component.

In this configuration, you need the following components:

• 1 Signature component

• 1 Checkpoint component

• 1 Initializer component

Configure the Signature Component

First, configure a Signature component so your end-user can apply a signature.

1.

In the Module Builder, drag and drop a Signature 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 signature.

3.

Click Save & Close.

Configure the Checkpoint Component

Next, configure the Checkpoint component to retrieve a timestamp when the end-user applies a signature.

1.

Drag and drop a Checkpoint component onto your canvas, placing it below the Signature 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 cpSignature.

3.

In the Label Text Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the . field, enter Checkpoint.

4.

Click Save & Close.

Configure the Initializer Component

Lastly, configure an Initializer component to trigger the Checkpoint component.

1.

Drag and drop an  Initializer component onto your canvas, placing it between the Signature and Checkpoint components.

2.

In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. and Canvas Label Text Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the . fields, enter initCheckpoint.

3.

Set the Trigger Type Deteremines how the component triggers. to Watch.

4.

In the Inputs table, enter the following:

5.

In the Outputs table, enter the following:

6.

Click Save & Close.

7.

Save your module.

Viewing the Checkpoint Metadata

Now, look at the DevTools Console The DevTools Console helps you securely store, build, test, and deploy your software. to see how the Checkpoint works. You'll start by opening the DevTools Console.

To open the DevTools Console The DevTools Console helps you securely store, build, test, and deploy your software. tab:

1.

Preview your module in Express View Express View is how your end-user views your 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..

2.

Right-click anywhere on your Express View page.

3.

Click Inspect. By default, the DevTools panel opens on the right side of your page.

4.

At the top of the DevTools panel, click the Console tab.

The Console tab lets you view your Unqork application's submission data Also known as Record Data. Submission data consists of information saved by Unqork components. View submission data by using the angular command, or in Record Collections.. A blue arrow to the left of a blank row at the bottom of the Console's feed indicates the Console's command line. You'll use this field to enter commands to get more data details.

With the DevTools Console open, test out the Checkpoint component.

1.

In the Signature field, sign your name.

2.

Returning to the Console tab, enter the following Angular command in the Console's command line: angular.element('.unqorkio-form').scope().submission.

3.

Press Enter/Return. The submission object appears.

4.

Click the gray arrows to expand and inspect the submission object until you find the metadata object.

The metadata object is where the checkpoint data lives. Expanding the metadata object, you'll see an object called checkpoints. Inside is the timestamp recorded when you signed your name in the cpSignature Checkpoint component.

(click image to expand)

As you see in this example, the value is a Unix timestamp of 1679944694537. Converted to a readable date, this value is GMT Monday, March 27, 2023 7:18:14.537 PM.

Resources

• Modify the Checkpoint component using the toolbar settings.

• Initializer Component

• Signature Component