Repeater Component
Overview
The Repeater component is a unique component that lets you interface with table-based data. You can add multiple components inside the Repeater component to display repeating rows of data.
The Repeater component offers an easy way to display and review table-based data. Displaying data with a Repeater component involves three essential parts:
1. | You need a table-based data source, like a Data Table component. |
2. | Fields placed inside the Repeater component display values from each row of the data source. The fields' Property IDs must match your data source'scolumn headers (keys). |
3. | A Data Workflow component links the data source to the Repeater component. |
You'll find the Repeater 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 Repeater 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. |
(ON)/(OFF) |
The component is active and visible 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.. While active, other components and processes can reference your component. Setting the toggle to (OFF) makes your component inactive. Other components and processes cannot reference your component while it's inactive. By default, the Active toggle is set to (ON). |
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. |
Actions |
Select this tab to manage your component's actions settings. |
Advanced |
Select this tab to manage your component's advanced 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:
Additional keyboard shortcuts:
|
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
Field Text
Default State Options
|
Contextual Help
|
Data Panel
Data Storage
Setting |
Description |
---|---|
Store Data in Database |
The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:
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 (OFF) when you don’t want to store the values from this field in the database. 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. 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 (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked. By default, this toggle is set to (OFF). |
Actions Panel
Triggers
|
|
Advanced Panel
Additional Styling
Setting | 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. |
Adding a Repeater Component
In this example, you'll configure a page where your 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. can review the data they submitted. On this page, end-users can edit fields and save any changes to the submission data. A Data Table component acts as the data source, and you'll configure a Text Field, Radio Buttons, and Number component inside the Repeater component. That way, the Repeater component can display the Data Table's values. Lastly, you'll link the Data Table and Repeater components using a Data Workflow component.
These instructions assume that you have an open module saved with a title.
What You Need
For this configuration, you need:
-
1 Data Table component
-
1 Repeater component
-
1 Columns component
-
1 Text Field component
-
1 Radio Buttons component
-
1 Number component
-
1 HTML Element component
-
1 Data Workflow component
To set up your Data Workflow, you need:
Configure the Data Table Component
First, set up your data source using a Data Table component.
1. | In the Module Builder, drag and drop a Data Table component onto your canvas. |
2. | In the Label and Property Name fields, enter dtData. |
3. | In the data table, enter the following: |
A |
B |
C |
---|---|---|
name |
employment |
income |
Minna Amigon |
fulltime |
96000 |
Ezekiel Chui |
parttime |
41000 |
4. | Click Save. |
Configure the Repeater Component
Next, add the Repeater component as a container for the Text Field, Radio Buttons, and Number components.
1. | Drag and drop a Repeater component onto your canvas, placing it below the dtData Data Table. |
3. | Click Save & Close. |
Configure the Columns Component
Your Data Table component has three columns of data. So, use a Columns component to add three display columns inside the Repeater component. That way, the Name, Employment, and Income fields display side-by-side.
1. | Drag and drop a Columns component onto your canvas, placing it inside the repeater Repeater 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 colRepeater. |
3. | Under Formatting, click (Three Columns). |
4. | Click Save & Close. |
Configure the Text Field Component
This Text Field component displays the values from the name column of the Data Table component. What's important is that the Property ID matches the column header in the Data Table.
1. | Drag and drop a Text Field component onto your canvas, placing it in column1 of the colRepeater Columns 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 Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter First Name. |
4. | Click Save & Close. |
Configure the Radio Buttons Component
Next up, a Radio Buttons component. This component displays the values from the employment column of your Data Table. Match the values in the component's Value to Store in Submission Data column to those in the Data Table component. Doin so lets the Repeater component preselect Radio Buttons values 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. based on the value in your Data Table component.
1. | Drag and drop a Radio Buttons component onto your canvas, placing it in column2 of the colRepeater Columns 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 employment. |
3. | In the Label Text field, enter Employment. |
4. | In the component's configuration window, click the Data tab. |
5. | Set your Option Label and Value to Store in Submission Data as shown below: |
Option Label |
Value to Store in Submission Data |
|
---|---|---|
1 |
Full Time |
fulltime |
2 |
Part Time |
partime |
3 |
Unemployed |
unemployed |
Values entered in the Value to Store in Submission Data column must match the values entered in the Data Table component.
6. | Click Save & Close. |
Configure the Number Component
This Number component will display the values from the income column of your Data Table. Again, the Property ID should match the column header from your Data Table component.
1. | Drag and drop a Number 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 income. |
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 Annual Pre-Tax Income. |
4. | Click Save & Close. |
Configure the Data Workflow Component
This Data Workflow links your dtData Data Table component to your Repeater component.
1. | Drag and drop a Data Workflow component onto your canvas, placing it below the repeater Repeater component. |
2. | In the Label and Property Name fields, enter dwfRepeater. |
3. | 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: |
Setting |
Value |
---|---|
Category |
Input |
Component |
dtData |
Required |
Yes |
Source |
Default |
Configure the Output Operator
1. | Drag and drop an Output operator onto your Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Output |
Component |
repeater |
3. | Connect the output port (right) of the Input operator to the input port (left) of the Output operator. |
4. | Click Save. |
Configure the HTML Element Component
Finally, let's add some instructions so your end-user knows what to do.
1. | Drag and drop a HTML Element component onto your canvas, placing it below the dwfRepeater Data Workflow component. |
3. | In the Content field, enter the following: |
<h3>Have any of these details changed?</h3>
<h4>If yes, please update your information here.</h4><br>
4. | Click Save & Close. |
5. | Save your module. |
Preview your module in Express View. Notice how each of the fields auto-populate, including the preselected Radio Buttons.
Resources