KPI Component

Overview

The KPI component is a 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 that lets Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. display KPIs (key performance indicators) A quanitifiable measure of performance of a specific objective for a specified time. to measure and present a key metric in an application. For example, you can display the number of submissions or a net sales dollar value on your dashboard.

You can find the KPI component under the Charts & Graphs 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.

Adding a KPI Component

For this example, create an application that displays the 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 sum 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.

Configure the Data Table Component

Begin by adding the example submission data to a Data Table component.

1.

In the Module Builder, drag and drop a 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. field, enter dtUserSubmissionData.

3.

In the data table, enter the following:

4.

Click Save Component.

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 Hidden component onto the canvas, placing it below your dtUserSubmissionData 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 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 kpiData.

3.

Click Save Component.

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 component onto the canvas, placing it between the dtUserSubmissionData Data Table and kpiData Hidden 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 dwfKpi.

3.

In theCanvas 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 ., enter dwfKpi.

4.

Navigate to the Actions settings

5.

Set the Trigger Type 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:

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:

3.

Connect the output port (right) of the dtUserSubmissionData Input operator to the input port (left) of the Submission Size 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:

3.

Connect the output port (right) of the Submission Size Size operator to the input port (left) of the kpiData Output operator.

4.

Click Save Component.

Here's how the completed Data Workflow canvas looks:

Configure the KPI Component

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

1.

Drag and drop a KPI component onto the canvas, placing it below the kpiData 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 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 kpiSubmissions.

3.

In the KPI Title field, enter Total Submissions.

4.

Navigate to the Data settings.

5.

From the Inputs drop-down, enter or select kpiData.

6.

Navigate to the Advanced settings.

7.

In the KPI Box Height field, enter 200.

8.

Click Save Component.

9.

Save your module.

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. to view the total number of submissions. The value is nine because you added nine rows of values to the dtUserSubmissionData Data Table component.

Overview

The KPI component is a 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 that lets Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. display KPIs (key performance indicators) A quanitifiable measure of performance of a specific objective for a specified time. to measure and present a key metric in an application. For example, you can display the number of submissions or a net sales dollar value on your dashboard.

You can find the KPI component under the Charts & Graphs 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.

Adding a KPI Component

For this example, create an application that displays the 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 sum 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.

Configure the Data Table Component

Begin by adding the example submission data to a Data Table component.

1.

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

4.

In the data table, enter the following:

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 Hidden component onto the canvas, placing it below your dtUserSubmissionData 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 component onto the canvas, placing it between the dtUserSubmissionData Data Table and kpiData Hidden components.

2.

In the Canvas Label Text and Property Name fields, enter dwfKpi.

3.

From the Trigger Type drop-down, select 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:

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:

3.

Connect the output port (right) of the dtUserSubmissionData Input operator to the input port (left) of the Submission Size 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:

3.

Connect the output port (right) of the Submission Size Size operator to the input port (left) of the kpiData Output operator.

4.

Click Save.

Here's how the completed Data Workflow canvas looks:

Configure the KPI Component

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

1.

Drag and drop a KPI component onto the canvas, placing it below the kpiData 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 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 kpiSubmissions.

3.

In the KPI Title field, enter Total Submissions.

4.

To the left of the component's configuration window, click the Data tab.

5.

From the Inputs drop-down, select or enter kpiData.

6.

To the left of the component's configuration window, click the Advanced tab.

7.

In the KPI Box Height field, enter 200.

8.

Click Save & Close.

9.

Save your module.

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. to view the total number of submissions. The value is nine because you added nine rows of values to the dtUserSubmissionData Data Table component.