Address (v1) Component

Estimated Reading Time:  7 minutes

Sunset Schedule

Sunsetting is the process of gradually phasing out functionality in the Unqork Platform for new practices. The Unqork Platform balances natural growth and necessary capability adjustments over time. The decision to sunset Unqork functionality can be driven by many factors, including but not limited to, Creator Also known as Unqork users; anyone who is inside the Unqork platform. community usage, security concerns, best practices guidelines, or overlaps with new and existing features.

TIP  To learn more about sunset statuses, see our Unqork Platform Sunsetting article.

Announced Feature Not Recommended for Use Retired Decommissioned

10/12/2022 (Platform version v6.68.x)

Address (v1) Component

11/15/2022 (Platform version v6.70.x)

6/30/2023 (Platform version v6.78.x)

Not currently planned for Decommissioned status.

Moving to the Address Search Component

With the release of the more robust Address Search component, the Address (v1) component is scheduled for retirement on 6/30/2023. Before that date, Creators should convert Address (v1) component configurations to the Address Service component.

TIP  To learn more about the Address Search component, see our Address Search Component article.

The following sections provide comparisons, differentiations, and frequently asked questions regarding the two versions of this component.

Component Differences

The Address Search component is different from the Address (v1) in the following ways:

1. When an end-user End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. doesn't know the exact address, the Address Search component autocompletes it for them.
2. When customers need a more secure, efficient, and maintainable Address component experience, the Address Service component provides:
a. Security: All 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. (application programming interface) keys are stored server-side and never exposed to network logs.
b. Performance: API service requests execute server-side, improving overall performance.
c. Maintainability: All address API services are maintained and easily adjusted using Services Administration.
3. The Address Search component offers Creators Also known as Unqork users; anyone who is inside the Unqork platform. need a more tailored, non-Google Canada Post API option.

NOTE  The Canada Post API is a USPS equivalent for mailing addresses in Canada. It also includes global address listings.

High-Level Comparison

The following is a high-level comparison of the Address (v1) and Address Search components:

Feature Address (v1) Component Address Search Component

Queries an address API based on the end-user's input and returns detailed information about that selection.

Details include:

  • Entire address string returned by the address API.

  • Street, Street 2, City, State, Zip, and Country fields.

  • Information regarding the address type. For example, “business”, “point of interest”, and so on.

  • (Google APIs Only) Detailed address information, like County, Province, Zip Suffix, and Latitude and Longitude.

Green Checkmark - Yes, this is supported.

Green Checkmark - Yes, this is supported.

As an end-user enters an address, the component autocompletes and displays suggested addresses.

Red Checkmark - No, this is not supported.

Green Checkmark - Yes, this is supported.

Integrates with Services Administration to provide central management of all address services and APIs. That includes Creator RBAC permissions.

Red Checkmark - No, this is not supported.

The API key is entered directly into the configuration.

Green Checkmark - Yes, this is supported.

The API key and API details are configured in Services Administration.

Supports multiple Address Service Types and APIs.

Red Checkmark - No, this is not supported.

Only the Google Geocoding API is supported.

Green Checkmark - Yes, this is supported.

The Google Place Details API and Canada Post API are supported.

Securely stores and executes the address APIs server-side.

Red Checkmark - No, this is not supported.

Green Checkmark - Yes, this is supported.

Allows end-users to override API-provided address values as needed.

Green Checkmark - Yes, this is supported.

Green Checkmark - Yes, this is supported.

Supports standard Unqork component settings, like Hide Field, Hide Search, Read Only View, Disable User Input, Required, and so on.

Green Checkmark - Yes, this is supported.

Green Checkmark - Yes, this is supported.

Supports On Blur and On Keypress triggers.

Red Checkmark - No, this is not supported.

Green Checkmark - Yes, this is supported.

Additional Technical Differences

The following are additional considerations regarding the two address components:

  • Address (v1) component: formatted_address

  • Address Search component: formatted

  • Short Format Setting: For Google Places APIs, the Address Search component uses this setting to control the address element (Street, Street 2, City, State, Zip, & Country) length in the submission data. When set to Toggle On Icon (ON), the component stores the address element in a shortened format. For example, "New York" stores as "NY".

  • Guided Configuration and Warnings: The Address Search components contains Module Editor settings warnings and Express View console warning logs. These warnings alert Creators when no address service is selected, resulting in no data being returned.

Module Editor Warning:

A static image displaying the infrastructure of AWS PrivateLink.

Express View Console Warning:

A static image displaying the layout of Azure PrivateLink Infrastructure.
  • Clearable Value: The Address Search component allows end-users to clear values in Express View using the button.

  • Required Error Message: The Address Search component displays a component-level required error message below the component. It also has field-level required messages for Street, Street 2, City, State, Zip, and Country.

  • Message Output Type Support: The Address Search component supports Creator-defined custom error messages sent using the message Output Type in a logic component.

Frequently Asked Questions

Below are the most commonly asked questions regarding the change from the Address (v1) component to the Address Search component:

1. How do I start using the Address Search component? What configuration changes are required?

The Address Search component is available in the Secondary Fields component tray of the Module Editor. Creators using the Address (v1) component need to map their configuration settings to the corresponding settings in the Address Search component. This new component has complete feature parity and a consistent configuration experience to make the transition as simple as possible. Unqork estimates that most use cases can be reconfigured in a matter of minutes.

Creators Also known as Unqork users; anyone who is inside the Unqork platform. need to set up an address service in Services Administration to complete Address Search component configuration. Creators must establish a Google Maps or Canada Post API key from their respective API providers.

TIP  To learn more about setting up your API keys, see our Enabling Address Search Using Address Services article.

2. The Address Search component was created to improve security, so what are the security risks when using the Address (v1) component?

The Address (v1) requires Creators to enter a Google Maps API Key directly to the component configuration. This API key is exposed in the browser as the end-user End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. enters an address. Doing so could potentially expose sensitive information to malicious agents.

Instead, the Address Search component integrates with Unqork’s Services Administration, performing all address searches server-side and preventing API information from being exposed in the browser.

3. What happens to all existing Address (v1) component configurations?

Existing Address (v1) component configurations will remain untouched. You can continue to edit them in the Module Editor, and render and execute them 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. After configuring a module, click Preview in the Module Editor to interact with the module in Express View. Because of Creator and end-user improvements with the Address Search component, Unqork will gradually phase out the Address (v1) component while ensuring configurations continue functioning as expected.

4. What does it mean to sunset the Address (v1) component?

Unqork will gradually phase out the Address (v1) component in favor of the recently launched Address Search component. The Address (v1) component sunset will follow a process prioritizing configuration and application stability.

Below are the following phases of the Address (v1) component sunset process:

  • NOT RECOMMENDED FOR USE: This status conveys that it is no longer best practice to configure with the Address (v1) component. It also suggests that there is a narrowed component support policy. We will only address high-priority (P1 P1 is a severe business disruption, either for Unqork and/or our clients.) bugs and security vulnerabilities.

  • RETIRED: This status conveys all conditions of the NOT RECOMMENDED FOR USE status. It also prevents Creators from adding new Address (v1) components to modules.

Address (v1) Component Sunset Schedule:

  • Sunset Announcement: Oct 12, 2022 (as part of platform version v6.68.x)

  • NOT RECOMMENDED FOR USE: Effective Nov 9, 2022 (as part of platform version v6.70.x)

  • RETIRED: Effective Jun 30, 2023 (as part of platform version v6.78.x)

5. How will I know where the Address (v1) is in the sunset process?

A visual badge displays the current sunset status in the Address (v1) component's settings modal A modal is a window that appears on top of the content you are currently viewing.:

  • NOT RECOMMENDED FOR USE

  • RETIRED

  • DECOMMISSIONED

A banner at the top of this article will also indicate the sunset status.

TIP  To learn more about sunset statuses, see our Unqork Platform Sunsetting article.

6. Why is the Address (v2) component now known as the Address Search component?

The Address Search component is a new, independent component for capturing end-user addresses. It is differentiated from Unqork's original Address component by the ability to autocomplete and provide suggested addresses as the end-user enters text. The Address Search component's name represents this distinction, along with other security, Creator-productivity, and maintainability improvements.

Overview

When collecting basic information about your end-user, you'll often want their address, too. Manually typing out every field of an address can be tedious and leaves room for human error. With the Address component, your end-user can use a Google Maps-style address look-up to suggest matching addresses. When your end-user selects a suggested address, the address fields will auto-fill. Using an Address component is quicker, more accurate, and provides a better user experience.

The component also offers flexibility with how you'll collect and use address information. Handy features of the Address component include:

  • The Google Places API returns all the information it has on each address. This is useful because you can set up the Address component to show select address fields in Express View. But, you'll still have access to all the information the Google Places API returns.

  • The option to overwrite suggested values returned by the Google Places API. But, the values returned by the API will still store with the submission.
  • The ability to disable the address lookup function. You can instead use the Address component to quickly add a set of address fields.

You'll find the Address component in the Secondary Fields group at the left of the Module Editor.

What You'll Learn

After completing this article, you’ll know when to use an Address component, how to configure its settings, and how to use it in an Unqork application.

About the Configuration Window

General

Setting

Description

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 doesn't complete this field.

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

Permissions Tab

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.

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 Button

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

Save Button

Click this button to save all settings as configured and return to the canvas.

Configuration Settings

Setting

Description

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.

NOTE  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 will return.

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 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. Use custom CSS to maintain a consistent look and feel if the field or element is part of a template or more than one module.

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 Questionmark Icon (Tooltip) icon. Tooltips can display across more than one line.

Street

Set to Toggle On Icon (ON) to display the secondary street address field in Express View. Secondary street address information might include building floor and office space values.After your end-user selects a suggested address, this field auto-fills from the address data returned by the map service API.

Street2

Set to Toggle On Icon (ON) to display the address field in Express View. Street Address includes building number and street address values. After your end-user selects a suggested address, this field auto-fills from the address data returned by the map service API.

City

Set to Toggle On Icon (ON) to display the City field in Express View. After your end-user selects a suggested address, this field auto-fills from the address data returned by the map service API.

Zip

Set to Toggle On Icon (ON) to display the Zip code field in Express View.. After your end-user selects a suggested address, this field auto-fills from the address data returned by the map service API.

State

Set to Toggle On Icon (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 Toggle On Icon (ON) to display the Country field in Express View. After your end-user selects a suggested address, this field auto-fills from the address data returned by the map service API.

Hide Search

Set to Toggle On Icon (ON) to hide the address search function. The Address component won't communicate with the address service API to perform an address lookup. Instead, the address fields you checked display in Express View. Your end-user can then manually type in their address details.

Clear Value When Hidden

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

Persistent

When checked, Unqork stores values entered into the field on submission of the module. Leave unchecked when you don't want to store the values from this field in the database.

Hidden

Shows or hides the component from view. Checking the Hidden checkbox hides the component in Express View. The component will always remain visible in the Module Editor.

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 checked, the component becomes display-only. If another component pushes content to the field, the end-user will see that content. Otherwise, end-users will see the word None.

Required

When set to Toggle On Icon (ON), the end user must enter a value in the component's visible fields. Set the toggle to Toggle Off icon (OFF) when an entry is optional.

By default, the Required toggle is set to Toggle Off icon (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 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.

Comment

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

Adding an Address Component

As an example, let's add an Address component for collecting end-user addresses. Let's assume we know your end-user lives in the United States. So, we won't include the Country field in Express View. Let's also add some Placeholder text so your end-user knows to use the search field. These instructions assume that you have an open module saved with a title.

NOTE  For testing purposes, the Address component will work without entering a unique Google Maps API key. In production applications, always acquire and enter a personal API key.

1. In the Module Editor drag and drop an Address component onto your canvas.
2. In the Label field, enter Address.
3. In the Property Name field, enter address.
4. In the Placeholder field, enter Search for your address.
5. Select Street, Street 2, City, State, and Zip.

6. Click Save.
7. Save your module.

Now you're ready to test out your Address component. Preview your module 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. After configuring a module, click Preview in the Module Editor to interact with the module in Express View and enter for an address. Your module should work like the following in Express View: