--- title: "Auto-Suggest Default Settings Screen" canonical: "https://kb.myframeworks.com.au/space/FRAM/474316802/Auto-Suggest%20Default%20Settings%20Screen" format: markdown --- ## Overview The **Auto-suggest Default Settings** screen configures address autocomplete and validation services for delivery address entry throughout Frameworks. This screen allows administrators to set up and manage multiple auto-suggest providers (such as Addressify and Smarty), control when suggestions appear, and configure API connection details. Auto-suggest functionality enhances address entry in Sales Order Processing, Point of Sale, and Delivery Maintenance by providing real-time address suggestions as users type, reducing errors and improving data quality. ## Screen Access 1. From the **Frameworks Menu, **navigate to: **System Administration > System Setup > Integrations > Auto-suggest Default Settings** ## Screen Structure ![image-20260208-233926.png](media://fe719eb6-226c-4d37-b9e6-b26b014a00b6) The Auto-suggest Default Settings screen is organised as a single grid displaying all configured auto-suggest providers. 1. **Action Buttons** - Add and Remove buttons for managing provider configurations 2. **Auto-suggest Providers Grid** - Displays all configured auto-suggest service providers with their settings --- ## Action Buttons ### Add The **Add** button creates a new auto-suggest provider configuration row in the grid. - **Action:** Opens a new row for entering provider details - **When to use:** Adding a new auto-suggest service provider or creating a custom configuration ### Remove The **Remove** button deletes the selected auto-suggest provider configuration from the grid. - **Action:** Removes the highlighted configuration row - **Enabled when:** A row is selected in the grid > ❌ **Important:** Cannot remove a configuration that is currently active (uncheck **Active** first) --- ## Auto-suggest Providers Grid The grid displays all auto-suggest service configurations. Each row represents a different provider (Addressify, Smarty, or custom providers) with specific API connection and behaviour settings. ### Line The **Line** field displays the sequential line number for each auto-suggest provider configuration in the grid. **Format:** Integer | **Required:** System-generated | **Editable:** No **Related fields:** This field provides the sequence order for provider configurations ### Code The **Code** field identifies the unique code name for the auto-suggest provider configuration. This code distinguishes between different provider setups such as Addressify, Smarty, or custom default settings. **Format:** Text (alphanumeric) | **Required:** Yes | **Editable:** Yes **Related fields:** The **Purpose** field provides the descriptive name for this code ### Purpose The **Purpose** field provides a descriptive name for the auto-suggest provider configuration. This field explains what the configuration is for and helps administrators identify provider settings at a glance. **Format:** Text | **Required:** Yes | **Editable:** Yes **Related fields:** The **Code** field provides the system identifier for this purpose --- ### Active The **Active** checkbox controls whether this auto-suggest provider configuration is currently enabled and available for use in address entry screens. When enabled (checkbox ticked): - The provider's auto-suggest functionality is active - An **Address Lookup** field becomes available in Sales Order Processing, Point of Sale, and Delivery Maintenance screens where addresses can be added or reviewed - Users can type in the **Address Lookup** field to receive address suggestions - API calls are made to the configured endpoint - Selecting an address suggestion auto-populates the address fields When disabled (checkbox not ticked): - The **Address Lookup** field is not displayed in address entry screens - The provider configuration is stored but not used - No API calls are made - Users enter addresses manually using standard address fields **Format:** Checkbox | **Required:** No (can be enabled or disabled) | **Default:** Disabled | **Editable:** Yes **Related fields:** All other fields in the row define the behaviour when this provider is active > ⚠️ **Important:** > ⚠️ > ⚠️ - Only one auto-suggest provider should be active at a time to avoid conflicting address suggestions. > ⚠️ - After enabling a provider, users must log out and log back into Frameworks for the **Address Lookup** field to become available in address entry screens. ### autoSuggestMinChar The **autoSuggestMinChar** field (auto-suggest minimum characters) sets the minimum number of characters a user must type before address suggestions begin to appear. Lower values (1-2 characters) provide suggestions earlier but may result in too many matches. Higher values (3-4 characters) wait for more specific input before showing suggestions. **Format:** Integer | **Required:** Yes | **Default:** 3 (for Addressify), 2 (for defaults) | **Editable:** Yes **Related fields:** Works with the **autoSuggestDelay** field to control when suggestions appear > ℹ️ **Common values:** > ℹ️ > ℹ️ - **2**: Suggestions appear after 2 characters (may show many results) > ℹ️ - **3**: Balanced approach - specific enough to limit results (recommended) > ℹ️ - **4**: Very specific - fewer false matches but requires more typing ### autoSuggestTimeout The **autoSuggestTimeout** field sets the timeout value (in milliseconds) for how long the system will wait for a response from the auto-suggest API before abandoning the request. This prevents address entry from hanging if the API service is slow or unresponsive. **Format:** Decimal (milliseconds) | **Required:** Yes | **Default:** 10,000.00 (10 seconds for Addressify), 15,000.00 (15 seconds for defaults) | **Editable:** Yes **Related fields:** Works with the **autoSuggestUrl** field to manage API communication > ℹ️ **Common values:** > ℹ️ > ℹ️ - **10,000.00**: 10-second timeout (standard for most providers) > ℹ️ - **15,000.00**: 15-second timeout (for slower connections) ### autoSuggestUrl The **autoSuggestUrl** field contains the API endpoint URL for the auto-suggest service provider. This is the web address where Frameworks sends address lookup requests. The URL must be the complete API endpoint address provided by the auto-suggest service provider. > **Examples:** > > - **Addressify**: https://api.addressify.com.au/addresspro or https://api.addressify.com.au/addressnz/ for New Zealand customers. > - **Smarty**: https://us-autocomplete-pro.api.smarty.com > - **Not applicable**: N/A (for default settings template) **Format:** Text (URL) | **Required:** Yes | **Default:** N/A (provider-specific) | **Editable:** Yes **Related fields:** Works with the **autoSuggestApiKey** field for API authentication and the **autoSuggestEndPoint** field for the specific API method ### autoSuggestDelay The **autoSuggestDelay** field sets the delay (in milliseconds) between when a user stops typing and when the system makes an API call to retrieve address suggestions. This delay prevents excessive API calls while users are still typing. The system waits for this delay period of inactivity before requesting suggestions. **Format:** Integer (milliseconds) | **Required:** Yes | **Default:** 500 (0.5 seconds) | **Editable:** Yes **Related fields:** Works with the **autoSuggestMinChar** field to control when suggestions appear > ℹ️ **Common values:** > ℹ️ > ℹ️ - **300**: Very responsive (0.3 seconds) - more API calls > ℹ️ - **500**: Balanced approach (0.5 seconds) - recommended > ℹ️ - **750**: More conservative (0.75 seconds) - fewer API calls ### autoSuggestApiKey The **autoSuggestApiKey** field contains the API authentication key provided by the auto-suggest service provider. This key authenticates Frameworks with the provider's API service and tracks usage for billing purposes. The API key is obtained through the provider's licensing process and is specific to your organisation's account. **Format:** Text (alphanumeric string) | **Required:** Yes (for active providers) | **Default:** N/A | **Editable:** Yes **Related fields:** Works with the **autoSuggestUrl** field to authenticate API requests > ⚠️ **Important:** > ⚠️ > ⚠️ - The API key must be valid and active with the provider > ⚠️ - Expired or invalid keys will prevent address suggestions from working > ⚠️ - Contact the provider's support if the key is not working ### autoSuggestMaxResults The **autoSuggestMaxResults** field sets the maximum number of address suggestions to display in the dropdown list when users are typing. Lower values keep the list focused on the best matches. Higher values provide more options but may overwhelm users. **Format:** Integer | **Required:** Yes | **Default:** 10 | **Editable:** Yes **Related fields:** Works with the **autoSuggestMinC** field to control the suggestion experience > ℹ️ **Common values:** > ℹ️ > ℹ️ - **5**: Minimal list - only top matches > ℹ️ - **10**: Standard list (recommended) - balanced > ℹ️ - **15**: Extended list - more options available ### autoSuggestEndPoint The **autoSuggestEndPoint** field specifies the API method or endpoint name to use when making requests to the auto-suggest service. This is appended to or used with the **autoSuggestUrl** to form the complete API call. Different providers use different endpoint names for their address lookup services. - **Provider-specific values:** - **Addressify**: autocomplete (for address autocomplete API method) - **Smarty**: lookup (for Smarty's lookup API method) - **Not applicable**: N/A (for default settings template) **Format:** Text | **Required:** Yes (for active providers) | **Default:** N/A (provider-specific) | **Editable:** Yes **Related fields:** Works with the **autoSuggestUrl** field to form the complete API endpoint address ### autoSuggestDisplayField The **autoSuggestDisplayField** field specifies which address format or field mapping to use when displaying and storing address suggestions from the provider. This field controls how the address data returned from the API is mapped to Frameworks address fields (street, suburb, state, postcode). **Provider-specific values:** - **AddressFull**: Addressify's full address format mapping - **n/a**: Not applicable (for providers that use different mapping or for default settings) **Format:** Text | **Required:** Yes (for active providers) | **Default:** N/A (provider-specific) | **Editable:** Yes **Related fields:** Determines how address data from the API populates the address fields in Sales Order Processing, Point of Sale, and Delivery Maintenance screens > ✅ ## Related Information > ✅ > ✅ - [Configure Addressify Integration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/475037700) - Complete setup guide for enabling Addressify > ✅ - [Create a Sales Order](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30521804) - Using auto-suggest when entering delivery addresses in sales orders > ✅ - [Process a Cash Sale with Delivery](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30529154) - Using auto-suggest when entering delivery addresses at point of sale > ✅ - [Maintain Delivery Addresses](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28400456) - Using auto-suggest when creating or updating customer delivery addresses