Checkpoint Component

Overview

The Checkpoint (Centauri v1.0) The Centauri (v 1.0.0) runtime is the first-generation foundation of the Unqork Designer Platform. Centauri provides Creators a codeless experience for developing applications. 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 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. reach a checkpoint, the component records a timestamp.

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

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

There's no visual aspect of a Checkpoint component 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.. When a Checkpoint component executes, 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.

A static image displaying the checkpoint metadata in the DevTools Console.

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

About the Configuration Window

To learn more about general component settings, view our General Component Settings article.

Display Setting

Field Text

A static image displaying the Disply Settings of Checkpoint Component.

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 Setting

User Input

A static image displaying the Data Setting of Checkpoint Component.

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 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. can also trigger Triggers activate another component when certain requirements are met. Trigger types include Concurrent, Post, and Error. Some components do not have the ability to trigger others. 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 setting is set to (OFF).

Adding a Checkpoint Component

Configure a Checkpoint component to executes when your 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. applies a signature with a Signature component. You'll use an Initializer component to trigger Triggers activate another component when certain requirements are met. Trigger types include Concurrent, Post, and Error. Some components do not have the ability to trigger others. the Checkpoint component.

Configure the Signature Component

First, configure a Signature component so your 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. 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 Component.

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  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 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 . field, enter Checkpoint.
4. Click Save Component.

Configure the Initializer Component

Lastly, configure an Initializer component to trigger Triggers activate another component when certain requirements are met. Trigger types include Concurrent, Post, and Error. Some components do not have the ability to trigger others. the Checkpoint component.

1. Drag and drop an  Initializer component onto your canvas, placing it between the signature  Signature and cpSignature  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. field, enter initCheckpoint.
3. In the 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 . field, enter initCheckpoint.
4. Set the Trigger Type Deteremines how the component triggers. to Watch.
5. In the Inputs table Enter inputs components and actions you want the component to perform., enter the following:
  Property ID Alias Required

1

signature

 

(checked)

6. In the Outputs table Enter outputs components and actions you want the component to perform., enter the following:
  Property ID Type Value

1

cpSignature

trigger

GO

7. Click Save Component.
8. 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 component works.

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.

To open the Console in Google Chrome, you can use the Ctrl + Shift + J (Windows/Linux) or Option + Command + J (Mac OS) shortcut.

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.

A static image displaying the added signature in Express View and the checkpoint metadata object in the DevTools Console.

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.

Overview

The Checkpoint (Centauri v1.0) The Centauri (v 1.0.0) runtime is the first-generation foundation of the Unqork Designer Platform. Centauri provides Creators a codeless experience for developing applications. 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 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. 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.

A static image displaying the checkpoint metadata in the DevTools Console.

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

About the Configuration Window

To learn more about general component settings, view our General Component Settings article.

Display Panel

A static image dispaying the Checkpoint component's Display settings.

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

A static image dispaying the Checkpoint component's Data settings.

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 setting is set to (OFF).

Adding a Checkpoint Component

Configure a Checkpoint component to fire when your 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. applies a signature with a Signature component. You'll use an Initializer component to trigger Triggers activate another component when certain requirements are met. Trigger types include Concurrent, Post, and Error. Some components do not have the ability to trigger others. the Checkpoint 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 Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. 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  Signature and cpSignature  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:
Property ID Alias Required

signature

 

(checked)

5. In the Outputs table, enter the following:
Property ID Type Value

cpSignature

trigger

GO

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 component works.

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.

To open the Console in Google Chrome, you can use the Ctrl + Shift + J (Windows/Linux) or Option + Command + J (Mac OS) shortcut.

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.

A static image displaying the added signature in Express View and the checkpoint metadata object in the DevTools Console.

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