2,299
edits
Changes
no edit summary
==Configuration - Essentials=====Example of Address Type==='''Address Types '''are available to a [[image:NewAddressType.pngUser|user]] with a [[User role|role]] that an '''Address Type '''has been made available to; similarly, they are available to an [[Organization|organization]] with a [[Client Categories|category]]that an '''Address Type '''has been made available to.
When accessing the [[profile]] of a user or organization, viewing their address details will reveal the relevant Address Type. If you are in the [[Global User Administrator|System Administrator]] role, you will also have the ability to modify the Address Type from the profile by editing the existing address or adding new addresses.
:: {{Icon-Menu}}
2. Under the heading '''Configuration, '''select '''Global Settings.'''
:: [[File:Address types.png|500px|border]]
The list of available Address Types will be displayed. If there are none in the system, this page will be blank. You can create and configure new Address Types by selecting the '''+ '''icon on the top left of your page. You can edit existing Address Types by selecting the '''pencil '''icon on the left of each Type name.
:: [[File:New address type.png|650px|border]]
{| class="wikitable"
|-
||'''Name'''
||Text used to identify an address type
|-
||'''Caption'''
||Normally the same as '''Name, '''unless you want to add a label for the address type that is different
|-
||'''Display Order'''
||Address types will be displayed in the drop-down with regards to the [[Display order|display order]], with the lowest value of display order appearing first in the drop-down list.
|-
||'''Description '''
||A general description for the address type
|-
||'''Colour Code'''
||An optional colour code for the address type when displayed
|-
||'''Default Type'''
||
In order to use the '''Multiple Addresses '''feature, a default address must be selected.
* The '''As Default Type for Users - '''Select this option to make this Address Type the default type for user records. * '''As Default Type for Companies - '''Select this option to make this Address Type should now be visible in the list of available address typesdefault type for organization records.
|-
||'''Maximum Number of Addresses'''
||The maximum quantity of this specific type of address allowed.
|}
<pre> If a Default Type is not set on an Address Type - either for Users or Companies - the combo box for Address Types will not be displayed when adding/editing an address record. </pre>
The details of the new '''Address Type '''will display on a new page, indicating that it is now available on the list of Address Types available in your [[SmartSimple]] [[instance]].
:: [[imageFile:AddessTypeNewField2Menu for address type.png|border]] {| class="wikitable"|-||'''Main'''||The '''General '''tab displays the descriptive information related to the Address Type:
* Address Type ID
* Name
* Caption
* [[Display order]]
* Description
* Default Type options
* Maximum Number of Addresses
|-
||'''Notes'''
||You can create, edit and view [[Notes Overview|notes]] attached to this Address Type.
|-
||'''Address Template'''
||You can create, edit and view the [[Address Book Template|address template]] associated with this Address Type. The address template is a feature used to personalize the block of text that is returned when using the @addressbobok@ [[variable]]. See the [[Address Book Template]] page for configuration instructions.
|-
||'''Standard Fields'''
||Learn how to add Standard Fields to Address Type.
|-
||'''Custom Fields'''
||Learn how to add Custom Fields to Address Type.
|}
===Importing Address Types===
On the main '''Address Types '''page, you have the options to either '''import '''new records as Address Types into the system, or '''export '''the existing Address Types.
:* '''IMPORTANT:''' when enabling you '''''must''''' follow the instructions on the [[image:AddessTypeStandard2.pngImporting Address]]Wiki article to ensure the existing addresses are retained. If the ''Enable Multiple Address'' option is turned on without importing addresses from existing profiles or loading a new set of addresses, whenever a new address is added to a profile, the original data stored in the profile address will be lost
==Configuration - Advanced==
===Add Custom Fields to Address Type===
After clicking into the specific Address Type you want to configure, go to the left-hand menu and select '''Custom Fields.'''
:: [[imageFile:AddessTypeStandardNewNew custom field address type.png|500px|border]] The New Custom Field window is displayed, with existing options for configuring required custom fields.
:: [[File:Edit custom field for address types.png|500px|border]]
See [[Custom Fields - General Information]] for further details about configuring custom fields.
:: [[imageFile:AddessTypeStandardOptionsAddress type edit standard field.png|600px|border]]On the left hand menu of that Address Type page, select the '''Standard Fields '''tab.
A list of the available Standard Fields associated with Address Type will appear.
:: [[File:Address type edit standard field specific.png|400px|border]]
The Standard Field configuration window will open, allowing you to configure the visibility and validation that you wish to apply for this specific field.
See the [[Standard Fields]] page if you require more information about Standard Fields.
==Viewing =Address TypesTemplate===The '''Address Template '''feature, found as a tab on the left hand menu when opening an Address Type's details, allows users to modify and configure how the Address Type is displayed and what it displays.
:: [[File:Address type template html.png|300px|border]]
The '''Field Picker '''feature will allow you to drag and drop available fields to customize the display that you want to appear for that Address Type.
===Enabling Multiple Address Types===
Enabling multiple address types will allow multiple addresses for the same organization. To add the multiple addresses, this is configured on the '''Custom Field: Address Type '''for that organization. This is a useful feature when you would like, for example, to associate one organization with numerous addresses that might respectively correspond to Office, Primary, Alternate, etc. '''<br />'''
:: {{Icon-Menu}}
2. Under the heading '''Configuration, '''select '''Global Settings. '''
:: [[imageFile:PrimaryAddressTypesAddress type enable multiple address.png|450px|border]]
4. Press '''Save''' at the bottom of the page.
===Referencing Address Types===
:* The @primaryaddress@ and @addressbook@ variables can be used to reference addresses when multiple address types are enabled. See [[Address Book Template]] for more information.
:* Individual Address Type values can be referenced using the [[Web_Page_View_Field_Variables#To_Display_a_List_of_Activities.2C_Notes.2C_Transactions.2C_Contacts.2C_Companies.2C_Consumers.2C_Providers|list syntax]] [#(?object=address) ... #] under a user or company.
===Troubleshooting Address Types===
The two key issues that we experience with users needing troubleshooting for Address Types is that they have not enabled '''Multiple Address''' function from the '''Global Settings''' page, or they have not made one of the Address Types in their system a '''Default''' for either Users or Organizations, a function which can be modified directly in that Address Type's page.
==See Also==:* The [[Viewing Address Type values can be referenced using the list syntax Types]]:* [[#(?object=address) ... #Address Book Template]]:* [[Importing Address]][[Category:Global Settings]][[Category:Contacts]] under a user or company.