Advanced Datagrid Component

Overview

The Advanced Datagrid is a Centauri (v1.0) layout component that, like the Data Grid component, lets you organize other components. The difference is that the Advanced Datagrid component displays other components in a modal.

Examples of when to use an Advanced Datagrid include the following:

Display entries in a dashboard.
Collect detailed prescription medication information.
Collect beneficiary information, including percentage calculations.
Build lists or combine other grids or tables into a single grid.
Use reference keys to reference other tables or grids, combining multiple types of information and layouts.

You'll find the Advanced Datagrid in the Display & Layout 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 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.

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.

Default State Options

Setting	Description
Disable User Input	Prevents the end-user from entering a value in the field by displaying it as grayed-out and unclickable in Express View. By default, Disable User Input is set to (OFF).
Draft Save	Set to (ON) to let end-users save a draft. By default, this setting is set to off (OFF).
Hide Label	Displays or hides the Label field from view. Setting Hide Label to (ON) hides it in Express View. Setting it to (OFF) displays the field. The component will always remain visible in the Module Builder. By default, Hide Label is set to (ON).
Hide Component	Shows or hides the component. Set Hide Component to (ON) to hide it in Express View. The component will always remain visible in the Module Builder. By default, this setting is set to (OFF).

Modal Formatting

Setting	Description
Modal Title	Enter a title for the pop-up modal.
Modal Message	Lets configure a pop-up modal message that displays a submission's progress. By default, the message reads: Loading please wait....
When to reset the form	Choose when to restore the form to its default values: On Add: Restores the default values when a submission is added. On Save: Restores the default values when a submission is saved.
Fullscreen	Expands your modal screen to the full width and height of the window. By default, this setting is set to off (OFF).
OK Button Label	A button displays at the bottom left of your modal in Express View. This field lets you choose the label text of the button. By default, this button label text displays as OK.
Save Button Label	A button displays at the bottom left of your modal in Express View. This field lets you set the button label text of the button. By default, this button label text displays as Save.

Grid Formatting

Setting	Description
Delete Title	Enter title for the modal that displays when deleting an entry in Express View. By default, the modal displays the following: Are you sure you want to delete this item?.
Delete Text	This modal displays if end-users select Confirm Deletion and try to delete an entry. By default, the message reads: Are you sure you want to delete this item?
Title for Save Confirmation Alert	When your end-user saves an invalid entry an error message displays. This field lets you set a title for that error message.
Message for Save Confirmation Alert	When your end-user saves an invalid entry an error message displays.
Save Event	Lets you create an event for your save confirmation modal.
Message While Saving	Enter a message that displays when an entry saves. By default, the message reads: Saving...
Cancel Button Label	Sets the button label text for the Cancel button. By default, this button label text displays as Cancel.
Action Label	Sets the button label text for the Action button. By default, this button label text displays as Actions.
Add Button Label	Sets the button label text for the Add button. By default, this button label text displays as Add.
Edit Button Label	Sets the button label text for the Edit button. By default, the button label text displays as Edit.
Delete Button Label	Sets the button label text for the Delete button. By default, the button label text displays as Delete.
View Label	Sets the button label text for the View button. By default, the button label text displays as View.

Additional Settings

Setting	Description
Confirm Deletion	When set to (ON), a pop-up modal displays when deleting an entry in Express View. By default, this setting is set to (OFF).
Show Yes/No Instead of Delete/Edit	When set to (ON), the grid displays Yes/No options instead of the default Delete/Edit buttons. By default, this setting is set to (OFF).
Show Select Option Instead of Add/Edit	When set to (ON), this checkbox lets you display a Select option instead of the default Add/Edit buttons. By default, this setting is set to (OFF).
Remember Scroll Position	Stores the page and vertical scroll position of the Advanced Datagrid component. When enabled, the component remembers the last place scrolled to on the grid. By default, this setting is set to (OFF).
Display Inline Rows	The Advanced Datagrid component defaults to a table style in the Express View. By default, this setting is set to (OFF).
Default First Row to Open	When set to (ON), the component automatically opens the first row of the accordion in Express View. By default, this setting is set to (OFF).
Show the Save Button in the Accordions	When set to (ON), displays a Save button in each row of the grid. By default, this setting is set to (OFF).
Show a Modal for Confirmation of Save	When set to (ON), a pop-up modal displays, confirming a save action. By default, this setting is set to (OFF).
Hide Table When Empty	Hide the grid in Express View when there's no data in it. By default, this setting is set to (OFF).

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: Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database. Triggering a module save event using a Button component with an Action Type of Save. Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database. 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. 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.
Data Reference Key	Enter the Property ID of the component whose data you're referencing.
Component Reference Key	Enter the Property ID of the Data Table component where you're retrieving data. You'll notice this field duplicates the functionality of the Data Reference Key field.
Yes/No Reference Key	This field is specific to components containing Yes/No lists. Enter the Property ID of the component where you're retrieving data.
Filter Field	Enter the component containing a value that filters the list.
Filter Yes/No Component	When the Yes/No Reference Key contains a component Property ID, you can use this field to filter the component’s Yes/No list.

Setting	Description
ID	This field lets you map a component in your Advanced Datagrid component. Enter the component's Property ID to display the component's data in your grid.
Heading	For each Property ID you enter in the ID fields, you can display a header in Express View.
New Row	Adds a new row to the table.

Setting	Description
ID	This field lets you map a component in your Advanced Datagrid component. Enter the component's Property ID to display the component's data in your grid.
New Row	Adds a new row to the table.

Setting	Description
Code	Enter text to display for the Yes/No Question listing
Text	Enter text to display for the Yes/No Question listing.
Required	When (checked), your end-user must enter a value into the field before they can save an entry. Clear the checkbox when an entry is optional. By default, this checkbox is clear.
Tooltip	A short hint that displays when an end-user positions their cursor over the (Tooltip) icon. Tooltips can display across more than one line.
Subheader	Enter a value to display under the header of the Yes/No Question listing.
New Row	Adds a new row to the table.

Setting	Description
New Row	Enter the Property ID of a component that, when triggered, creates a new row in Express View.
Edit Row	Enter the Property ID of a component that, when triggered, edits a row in Express View.

Setting	Description
Required	When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional. By default, Required is set to (OFF).
Required Error Message	A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Setting	Description
Error Title	Display as a header in a modal to the end-user if an error occurs.
Error Message	Displays under the Error Title in a modal to the end-user if an error occurs.
Min Length	Sets the minimum number of characters an end-user must enter for valid input.
Max Length	Sets the maximum number of characters an end-user must enter for valid input.

Setting	Description
Custom CSS Class	Enter a Custom CSS 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.
Add Button Icon Class	Enter a Custom CSS Class to apply to the Add button.
Edit Button Icon Class	Enter a Custom CSS Class to apply to the Edit button.

Adding an Advanced Datagrid Component

In this example, you'll set up an Advanced Datagrid component with a few components for data entry. In Express View, your end-user can add, edit, or delete data as needed. These instructions assume that you have an open module saved with a title.

Configure the Advanced Datagrid Component

Configure an Advanced Datagrid component to contain your information fields.

In the Module Builder, drag and drop an Advanced Data Grid Icon

Advanced Datagrid component onto your canvas.

In the Property ID field, enter adgApplication .

In the Label Text field, enter Application.

Navigate to the Display setting's Grid Formatting section.

In the Add Button field, enter Add Applicant.

Navigate to the Data settings.

In the Display table, enter the following:

	ID	Heading
1	firstName	First Name
2	lastName	Last Name
3	email	Email
4	phoneNumber	Phone Number

You'll configure the components that match these values in later steps.

Click Save Component.

Configure the Text Field Components

Configure two Text Field components for your first and last name fields.

Drag and drop two Text Field components inside of the adgApplication Advanced Data Grid Icon

Advanced Datagrid, placing them one below the other.

For each component, enter the following Property ID and Label Text values:

Property ID	Label Text
firstName	First Name
lastName	Last Name

Click Save Component as you add each component.

Configure the Email Component

Configure an Email component to gather email addresses from your end-users.

Drag and drop an

Email component into your adgApplication Advanced Data Grid Icon

Advanced Datagrid, placing it below your firstName and lastName Text Field components.

In the Property ID field, enter email

In the Label Text field, enter Email.

Click Save Component.

Configure the Phone Number Component

Configure a Phone Number component to gather phone number data from your end-users.

Drag and drop a

Phone Number component into your adgApplication Advanced Data Grid Icon

Advanced Datagrid, placing it below your email

Email component

In the Property ID field, enter phoneNumber.

In the Label Text field, enter Phone Number.

Click Save Component

Save your module.

Preview your module in Express View to see the following functionality:

Setting	Description
Error Title	When your end-user saves an invalid entry an error message shows. This field lets you set a title for that error message. By default, the Error Title shows as: Oops - {{ errors }} error(s) have been found!. {{ errors }} represents the count of errors returned.
Error Message	When your end-user saves an invalid entry an error message shows. By default, the message reads: Please check your module and fix fields outlined in red.
Delete Title	When deleting an entry in Express View, you can configure a pop-up to appear. This field lets you choose the title of the pop-up. By default, the pop-up asks: Are you sure you want to delete this item?
Delete Text	When deleting an entry in Express View, you can configure a pop-up to display. This pop-up displays if you select the Confirm Deletion checkbox and try to delete an entry. By default, the message reads: Are you sure you want to delete this item?
Confirm Deletion	When (checked), a pop-up displays if you try to delete an entry in Express View. By default, this setting is ☐ (unchecked).
Fullscreen	Sets your modal screen to expand to the entire width and height of the window. By default, this setting is ☐ (unchecked).
Required	When (checked), your end-user must enter a value into the field before they can save an entry. Clear the checkbox when an entry is optional. By default, this setting is ☐ (unchecked).
Draft Save	When (checked), gives you the option to save a draft. By default, this setting is ☐ (unchecked).
Minimum Length	Sets the minimum number of rows to display in the grid inExpress View. When you reach this lower limit, the button disappears.
Maximum Length	Sets the maximum number of rows to display in the grid in Express View. When you reach this upper limit, the button disappears.
Disabled	When (checked), prevents end-users from interacting with or editing the input field in Express View. When your end-user hovers over the field, their cursor changes to alert them to the status change. By default, this setting is ☐ (unchecked).
Hidden	When (checked), hides the grid and all components from the end-user in Express View. By default, this setting is ☐ (unchecked).
Show Yes/No Instead of Delete/Edit	When (checked), the grid shows Yes/No options instead of the default Delete/Edit buttons. By default, this setting is ☐ (unchecked).
Remember Scroll Position	Stores the page and vertical scroll position of your Advanced Datagrid. When (checked), Unqork remembers the last place you scrolled to on your grid. When you return to the page, it directs you automatically to that position. This is helpful if you have a large grid and want to return to the same entries on your next visit. By default, this setting is ☐ (unchecked).
Show Select Option Instead of Add/Edit	When (checked), lets you display a Select option rather than Add/Edit buttons. By default, this setting is (checked).
Persistent	When (checked), data is stored each time the module executes. By default, this setting is (checked).
Hide Label	When (checked), stops Label Text from displaying in Express View. Your Label Text still displays in Module Builder. By default, this setting is ☐ (unchecked).
Hide Table When Empty	When (checked), lets you hide your grid in Express View when there's no data in it. By default, this setting is ☐ (unchecked).
Filter Field	Enter the component containing a value that filters the list.
Filter Yes/No Component	When the Yes/No Reference Key contains a component Property ID, you can use this field to filter the component’s yes/no list.

Setting	Description
New Row Trigger	Enter the Property ID of a component that, when triggered, creates a new grid row in Express View.
Edit Row Trigger	Enter the Property ID of a component that, when triggered, edits a grid row in Express View.
Display Inline Rows	The Advanced Datagrid defaults to a table style in the Express View. To set up data in an accordion, set this to (checked)
Default First Row to Open	Set to (checked) to automatically open the first row of the accordion in Express View. By default, this setting is ☐ (unchecked).
Show the Save Button in the Accordions	When (checked), displays a Save button in each row of your grid. By default, this setting is ☐ (unchecked).
Show a Modal for Confirmation of Save	When (checked), a pop-up displays to confirm the saving of an entry in your grid. By default, this setting is ☐ (unchecked).
Message for Save Confirmation Alert	When (checked), creates a Save confirmation pop-up. This field lets you enter the text for that pop-up.
Title For Save Confirmation Alert	When (checked), lets you create a title for your save confirmation pop-up.
Save Event	When (checked), lets you create an event for your save confirmation pop-up.
Message While Saving	This field lets you enter a message that displays as an entry saves. By default, the message reads: Saving...

Setting	Description
Label	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.
Property Name	A Property Name (Property ID) is the unique field ID used by Unqork to track and link your module components. The Property Name is how the software identifies your component. Using Property Names lets you link components, creating logic-based configurations and API (application programming interface) calls. Property Names must use camel case (stylized as camelCase) without spaces or punctuation.
Data Reference Key	Enter the Property ID of the component whose data you're referencing.
Yes/No Reference Key	This field is specific to components containing Yes/No lists. Enter the Property ID of the component where you're referencing data.
Component Reference Key	Enter the Property ID of the Data Table component where you're referencing data. You'll notice that this field duplicates the functionality of the Data Reference Key field.
Modal Title	You can configure a pop-up that displays the loading progress of the Advanced Datagrid. This field lets you enter a title for the pop-up.
Modal Message	You can configure a pop-up that displays a submission's progress. By default, the message reads: Loading please wait...
OK Button	This button displays at the bottom left of your modal in Express View. On button-press of the OK button, the pop-up closes. This field lets you choose the label text of the button. By default, this button label text shows as OK.
Save Button	This button displays at the bottom left of your modal in Express View. On button-press, your updates store, and you'll return to the grid. This field lets you set the button label text for the button. By default, this button label text shows as Save.
Cancel Button	This button displays at the bottom left of your modal in Express View. On button-press, your updates clear and you'll return to the grid. This field lets you set the button label text for the button. By default, this button label text shows as Cancel.
Action	By default, the Advanced Datagrid has an Actions column in Express View. You can perform Actions on entries added to the table. This field lets you set the label text of the column. By default, these actions are Edit and Delete.
Add Button	The Add button lets you add entries to your grid in Express View. This field lets you set the button label text for the button. By default, this button label text shows as Add.
Edit Button	The Edit button displays at the right of your grid in Express View. On button-press, you can change or update your entries. This field lets you set the button label text for the button. By default, the button label text shows as Edit.
Delete Button	This button displays at the right of your grid in Express View. On button-press, you'll remove the entry associated with the button. This field lets you set the button label text for the button. By default, the button label text shows as Delete.
View	When disabling a component, the View button lets your end-user see the entry but not edit it. This field lets you set the button label text for the button. By default, the button label text shows as View.
When to reset the form	Choose when to restore the form to default values: On Add: Restores the default values when a submission is added. On Save: Restores the default values when a submission is saved. This setting is optional.

Setting	Description
Code	Details coming soon!
Text	Details coming soon!
Required	When you select the Required checkbox, your end-user must enter a value into the field before they can save an entry. Clear the checkbox when an entry is optional. By default, this checkbox is clear.
Tooltip	A short hint that displays when an end-user positions their cursor over the (Tooltip) icon. Tooltips can display across more than one line.
Subheader	Details coming soon!
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 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 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.

Advanced Datagrid Component

Overview

About the Configuration Window

Display Settings

Field Text

Default State Options

Modal Formatting

Grid Formatting

Additional Settings

Data Settings

Data Storage

Display

Extra Fields to Include

Yes/No Question Listing

Actions

Triggers

Validation

User Input

Advanced

Additional Validation Options

Additional Styling

Adding an Advanced Datagrid Component