General Component Settings
Estimated Reading Time: 5 minutes
Overview
While each Unqork component has unique configuration settings that allow you to customize your application, every component shares the same general settings. This
NOTE For more information on component specific configuration settings, visit the Component Library landing page.
What You'll Learn
After completing this
About the Configuration Window
To access the general settings, you must first open the component configuration window. Once you add a component onto the Module Builder canvas, the configuration window appears automatically. You can also open the configuration window of an existing component in your Module Builder canvas by hovering over the component and clicking the (Settings) button from the component toolbar.
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. |
Validation |
Select this tab to manage your component's validation 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. (role-based access control) 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 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 |
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 canvas. |
Save & Close |
Click this button to save all settings as configured and return to the canvas. |
If your components are mapped to a Data Model, you can expect other settings and attributes to display at the top of the component's settings modal A modal is a window that appears on top of the content you are currently viewing.. When viewing the settings for a component associated with a Data Model, some fields are disabled because they are controlled by the schema associated with the Data Model.
Below are the available options for mapped components:
Setting | Description |
---|---|
Component |
Represents the component associated with the Data Model. If the Data Model property type associated with this component supports other component types, you can select a different component from the drop-down menu. The component settings will immediately display for that selected component. |
Field Name |
The JSON Schema field associated with this component. |
Data Model |
The Data Model associated with this component. |
Type |
The data type of the Data Model field. |
Property ID |
The component's Property ID. |