Address (v1) Component

Display Tab

Selecting this tab shows all Address component configuration settings.

Error Messages Tab

Selecting this tab shows the Required Error setting. Use this setting to enter a custom error message to appear if your end-user does not complete this field.

The Required Error message will only display if you mark the component as Required under the Display Tab.

Permissions Tab

Select this tab to see the RBAC settings of the component.

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 ID (also called Property Name) 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 calls.

Property IDs must use camel case (stylized as camelCase) without spaces or punctuation.

Cancel

Click this button to undo any unsaved configuration changes and return to the Module Builder canvas.

Save

Click this button to save all setting  configuration changes and return to the Module Builder canvas.

Placeholder

A short prompt telling end-users the expected value of an input field. For example, Enter your Social Security Number. Placeholder Text displays inside the input field until the end-user begins an entry.

Region Bias

Enter the coordinates of a region. The coordinates tell the Google Places API what regional results to suggest first. For example, entering 56.1304, 106.3468 tells the API to suggest Canadian addresses first.

Google Maps API Key

Enter a Google Maps API key.

For testing purposes, the Address component will work without completing this field. However, for security purposes, always acquire and enter your own key.

Component Filter

Enable to influence or restrict the values the Google Places API returns.

To restrict suggested results based on country, use the following format: country:[2-letter ISO 3166 country code]. For example, entering country:US|country:CA would restrict results to the United States and Canada. To see a complete list of ISO 3166 country codes, visit the following link: en.wikipedia.org/wiki/List_of_ISO_3166_country_codes.
You can also influence suggested results based on state, city, or other values.

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.

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.

Street

Set to (ON) to display the secondary street address field in Express View. Secondary street address information might include building floor and office space values.

Street2

Set to (ON) to display the address field in Express View. Street Address includes building number and street address values.

City

Set to (ON) to display the City field in Express View.

Zip

Set to (ON) to display the Zip code field in Express View.

State

Set to (ON) to display the State field in Express View. State information might include individual U.S. state locations, territories, or sub-regions of a country.

Country

Set to (ON) to display the Country field in Express View.

Hide Search

Set to (ON) to hide the address search function. The Address Search component will not communicate with the Address Service API and perform an address lookup. Instead, the address fields you select display in Express View. Your end-user can then manually type in their address details.

By default, this setting is (OFF).

Clear Value When Hidden

Where the component is set to hidden, setting this toggle to (ON) clears the field’s stored value from the database. Setting the toggle to (OFF) stops the application from removing the stored value.

Persistent

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.

Hidden

Hides the component from displaying in Express View.By default, this setting is (OFF).

Disabled

When checked, end-users can’t interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor will change to alert them to the status change.

Use Read-Only View

When set to ON, end-users can’t interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change.

By default, the Disable User Input toggle is set to (OFF).

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).

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.

Comment

Enter comments about your component and its configuration. You can use this setting to keep your teammates in the loop.