KPI Component

Estimated Reading Time:  5 minutes

Overview

A KPI A quanitifiable measure of performance of a specific objective for a specified time. (key performance indicator) is a measure of performance toward an objective. For example, a KPI can be the number of submissions in your dashboard or a net sales dollar value. In Unqork, you can use the KPI component to measure and display a key metric in your application.

You can find the KPI component under the Charts & Graphs group to the left of the Module Builder.

What You'll Learn

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

About the Configuration Window

General

A static image displaying the KPI component's configuration window.

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

Save & Close

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

Display Panel

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

Field Text

Setting

Description

Label

The Label 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.

Formatting

Setting

Description

KPI Title

The title that displays above the KPI widget 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..

KPI Format

Adds a prefix or suffix to your KPI widget. To set the KPI format, enter {Prefix}X{Suffix}.

Data Panel

A static image displaying the KPI component's Data settings.
(click to expand image)

Inputs

Setting

Description

Inputs

Enter the Property ID where you stored your value. Your KPI widget displays the value you enter into the Inputs table.

NOTE  The KPI widget can only display the value of a single key/value pair.

Advanced Panel

A static image displaying the KPI component's Advanced settings.
(click to expand image)

Additional Styling

Setting

Description

KPI Box Height (in px)

Enter a value (in pixels) to set the box height of your KPI widget.

KPI Icon

Add an icon for your KPI widget by entering the icon class string. For example, to use Font Awesome US dollar icon, enter fa fa-usd.

KPI Background Color

Use this drop-down to set a background color for your KPI widget. Your local style sheet determines the color options available in your KPI Background Color Options menu.

To preview different style sheets: 

1. Preview your module in Express View.
2. In the top-right corner of the page, select Show.
3. From the Preview Style drop-down, select your style sheet.

KPI Text Color

Select the text color you want to display in your KPI widget.

Adding a KPI Component

For this example, create an application that shows total customer submissions to 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.. Use a Data Workflow component to add up the number of submissions in a submission data set. Then, display that number on your application using a KPI widget.

These instructions assume that you have an open module saved with a title.

What You Need

For this configuration, you need:

To set up your Data Workflow, you need:

Configure the Data Table Component

Start your application by adding the submission data to a Data Table component.

1. In the Module Builder, drag and drop a Dropdown Component Icon Data Table 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. and Canvas Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. fields, enter dtUserSubmission Data.
3. To the left of the component's configuration window, click Data Icon Data.
4. In the data table, enter the following:
  A B

1

name

status

2

Robert

Denied

3

Ebony

Approved

4

Kaylin

Denied

5

Rachelle

Approved

6

Trevor

Pending

7

Kenya

Approved

8

Madison

Denied

9

Keshawn

Pending

10

Emie

Approved

A static image displaying the completed configuration of the Data Table component.

5. Click Save & Close.

Configure the Hidden Component

This Hidden component stores the number of submissions. Your KPI component references this data to display to the end-user.

1. Drag and drop a Radio Buttons icon Hidden component onto the canvas, placing it below your dtUserSubmissionData Dropdown Component Icon Data Table 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. 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 kpiData.
3. Click Save & Close.

Configure the Data Workflow Component

Use a Data Workflow component to output the number of submissions from the Data Table component. Once your Data Workflow factors the number of submissions, it stores it in your Hidden component.

1. Drag and drop a Data Workflow Icon Data Workflow component onto the canvas, placing it between the dtUserSubmissionData Dropdown Component Icon Data Table and kpiData Radio Buttons icon Hidden components.
2. In the Canvas Label Text and Property Name fields, enter dwfKpi.
3. Set the Trigger Type to Watch.

A static image displaying the completed Data Workflow configuration with the Trigger Type set to Watch.

Configure the Input Operator

1. Drag and drop an  Input operator onto your Data Workflow canvas.
2. Configure the operator's Info window as follows:

Setting

Value

Category

Input

Component

dtUserSubmissionData

Required

Yes

Source

Default

Configure the Size Operator

1. Drag and drop a  Size operator onto your Data Workflow canvas.
2. Configure the operator's Info window as follows:

Setting

Value

Category

Size

Label

Submission Size
3. Connect the output port (right) of the  Input operator to the input port (left) of the  Size operator.

Configure the Output Operator

1. Drag and drop an  Output operator onto the Data Workflow canvas.
2. Configure the operator's Info window as follows:

Setting

Value

Category

Output

Component

kpiData

Action

value
3. Connect the output port (right) of the  Size operator to the input port (left) of the  Output operator.

A static image displaying the Data Workflow's configuration and the Watch Trigger Type selected.

4. Click Save.

Configure the KPI Component

Lastly, use a KPI component to display the total number of submissions.

1. Drag and drop a KPI Icon KPI component onto the canvas, placing it below the kpiData Radio Buttons icon Hidden 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. and Label 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 kpiSubmissions.
3. In the KPI Title field, enter Total Submissions.
4. To the left of the component's configuration window, click the Data Icon Data tab.
5. From the Inputs drop-down, select or enter kpiData.

A static image of the configured Property ID, Label, KPI Title, and the selected kpiData Input.

6. To the left of the component's configuration window, click the Advanced Icon Advanced tab.
7. In the KPI Box Height field, enter 200.

A static image displaying the configuration of the KPI Box Height (in px) setting.

8. Click Save & Close.
9. Save your module.

Preview your module in Express View. You can see the total number of submissions is nine because you added nine rows of values to the dtUserSubmissionData Dropdown Component Icon Data Table component.

A static image displaying the completed configuration in Express View.

Structure of a KPI Component's Data

The KPI data uses an input Property ID to display a value of a single key/value pair.

Resources