Published at: 2026-06-26
Address Format
1. Function Overview
1.1 Function Introduction
The multi-format address function supports the display, entry and storage of address information in line with local address conventions of different countries or regions. Administrators can configure customized address formats for various countries or regions, including field display order, field names, required field rules, line break display modes and text splicing rules.
After enabling this function, when users create or edit data, the system will dynamically display the corresponding address fields based on the selected country or region. For example, addresses in China are displayed in the order of province, city, district and detailed address; addresses in the United States are shown as state, city, street and postal code; addresses in Japan follow local conventions including prefecture, city/town/village and block number.
1.2 Application Scenarios
-
Enterprises with cross-border businesses that need to record addresses of different countries or regions for business objects such as customers, contacts, orders, stores and delivery addresses.
-
Scenarios where address fields vary across countries and regions. For instance, some countries do not have the concept of province/state, while others require fields such as postal code, house number, room number and PO Box.
-
Enterprises that require address display and entry methods to conform to local user habits, so as to reduce manual adaptation work and entry errors.
-
Enterprises that need to splice address information into standardized texts for list display, data export, system docking, logistics, customs clearance, payment verification and other scenarios.
1.3 Preconditions \& Instructions
-
Country/Region Management - Countries \& Regions: Used to maintain basic country/region information, including code, name, full name, two-letter code, three-letter code, numeric code, time zone, regional format, international dialing code, etc.
-
Country/Region Management - Administrative Divisions: Used to maintain hierarchical regional data including provinces, cities, districts and towns under corresponding countries or regions.
-
Address Format: Used to define address rules for form entry, detail display and text splicing for specific countries or regions.
-
Dynamic Address Fields: Must be used in conjunction with address formats. The original regional positioning fields will not be affected by address formats and are still applicable to scenarios that do not require complex international address rules.
2. Operation Guide
2.1 Create a New Address Format
-
Function Entry: 【Admin Backend】 → 【Enterprise Settings】 → 【Address Format】
-
Configure basic information: including address format name, apiName, applicable countries/regions, and default format setting.
-
Countries/Regions: Multiple countries or regions can be selected for one format.
-
Default Format: Only one default format can be set for a single country/region. Repeated setting will trigger a conflict prompt.
-
Form Format: Controls the display effect of address fields on the creation page, editing page and detail page.
-
Text Splicing Format: Controls the generation rules of standardized formatted addresses.
Note: Multiple address formats can be configured for a single country or region, while only one can be set as the default format. When a user selects a country/region with multiple available formats, the system will adopt the default format by default, and users can switch to other enabled formats according to business needs.
2.1.1 Configure Form Format
-
The form format is used to control the display effect of dynamic address fields on the creation, editing and detail pages.
-
The system provides commonly used address fields. You can configure the visibility, sorting and display name of fields as required.
| Configuration Item | Function Description |
|---|---|
| Display | If checked, the field will be displayed in the dynamic address component. |
| Required | If checked, this field cannot be empty on the data creation page. |
| New Line | If checked, the field and subsequent content will be displayed on a new line. |
| Display Name | Mainly applicable to scenarios where the same field has different names in different countries and regions. For example, the field of “Province” is referred to as “State” in the United States. This configuration allows setting the display name as “State” in U.S. address formats and supports multilingual translation. |
| Display Width | Used to configure the display width of the field on the page. Full Width: occupies the entire row; Multi-column: adapts to the number of field columns based on the page layout. |
| Sorting | Drag the sorting button on the right to adjust the field order. |
| Form Format Preview | Click the 【Form Format Preview】 button in the upper right corner of the page to preview the display effect of the component on the creation and editing pages. |
2.1.2 Configure Text Splicing Format
- The text splicing format is used to automatically splice address fields into standardized formatted addresses.
| Configuration Item | Function Description |
|---|---|
| Include | If checked, the field will be involved in address splicing. |
| New Line | If checked, the field and subsequent content will be displayed on a new line during splicing. |
| Replace with Attribute | This configuration only applies to option-type fields. For example, for the country/region name field in the U.S. address format, you can configure it to display the country code instead of the full name during address splicing. |
| Prefix/Suffix | Fixed text can be configured before or after the target field. |
| Space Separator | If checked, a space will be added after the current field. |
| Sorting | Drag the sorting button on the right to adjust the field sequence. |
2.1.3 Special Notes
-
Modifying address formats will not affect historical address data and only takes effect on newly created or newly edited data.
-
If an address field with existing values is hidden, the original historical data will be retained. The field will not be displayed during re-editing, and the original values will not be cleared.
-
After adding or modifying required fields, required field verification will be triggered when re-editing historical data.
-
The system has pre-configured standard address formats for Chinese mainland, Hong Kong, Macao, Taiwan and international regions, which can be used directly or modified based on actual needs.
2.2 Address Format Management
-
The system has pre-configured address formats for commonly used countries, which can be modified as required.
-
Enable/Disable: Newly created and saved address formats are enabled by default. Disabled address formats will no longer be selectable during address entry.
-
Delete: Only disabled address formats can be deleted.
3. How to Use Address Formats
Address formats must be used with Dynamic Address type fields. Dynamic address fields can dynamically display corresponding address fields based on the selected country or region.
For details, refer to: 【Dynamic Address】 Field Help Manual
4. Frequently Asked Questions
-
Why is a formatted address generated after saving? The formatted address is automatically generated by the system according to text splicing rules, which facilitates list display, printing and mailing scenarios.
-
Will historical data change automatically after modifying the address format? No. Address format modifications only affect new data by default. Original historical data will be retained, and historical data will be displayed and verified according to the latest address format when re-edited.
-
Can multiple dynamic address fields be created for one object? No. A maximum of one dynamic address field can be created for a single object, and disabled fields are also included in the quantity limit.
-
What is the difference between dynamic address and regional positioning? Regional positioning is applicable to basic scenarios requiring selection of countries, provinces, cities and districts. Dynamic address is designed for international businesses, supporting dynamic display of differentiated address fields, field names, sequences and splicing rules for different countries and regions.