Skip to main content

Address autocomplete

Introduction to address autocomplete in ConSol CM​

The address autocomplete feature provides a convenient way to enter addresses in the Web Client. It can be used in cases, contacts and resources. Once the users start typing the name of the city or street, or the zip code, suggestions are displayed. Upon selecting a value, the suggestions for the other fields change accordingly, so that, for example, only streets which exist in the selected city are shown. Therefore, the users can enter addresses more quickly and check if an address exists. In addition, errors, such as mismatches between the city and the zip code, are avoided.

Prerequisits​

The address autocomplete features relies on address data, which you need to purchase from a third-party supplier. The data can contain three items: cities, zip codes and streets with house numbers. It is not part of the ConSol CM distribution.

You need to import the purchased address data into the table cmas_autocomplete_address of the ConSol CM database. Cities are imported into the city column, zip codes into the zip column and streets with house numbers into the street column.

If you have not imported data yet, the Documentation tab is shown when opening the page.

Settings for address autocomplete configurations​

The address autocomplete configuration consists of the name field and the three sections: ZIP, City and Street. Depending on your use case and the address data, you can fill out one or several sections.

  • Name: Mandatory. The internal name of the autocomplete configuration.
  • Data field: The case, contact or resource field, which should contain the zip code, city or street.
  • Field behavior: Determines the behavior of the field. Possible values are:
    • Autocomplete field: The field has an autocomplete functionality and its value determines the autocomplete suggestions of other fields.
    • Use field value to autocomplete other fields: The field itself does not have an autocomplete functionality, but its value is used to determine the autocomplete suggestions of other fields.
  • Minimum characters required: Determines the minimum number of characters which the user must enter in order to see autocomplete suggestions.
  • Maximum number of results: Determines the maximum number of autocomplete suggestions shown for the field.

Managing autocomplete configurations​

The address autocomplete configurations are managed in the Configurations tab of the Address autocomplete page of the Web Admin Suite. The following actions are available:

  • Create a new configuration: Click the New configuration button above the list of autocomplete configurations, or duplicate an existing configuration by clicking the Duplicate icon of a configuration. Provide the required settings, see Settings for address autocomplete configurations.
  • Delete a configuration: You can delete a configuration by clicking the Delete icon.
Index

You need to rebuild the index on the Index page to use a new autocomplete configuration, see Index. This operation might take long on large existing ConSol CM system.