2,299
edits
Changes
no edit summary
__TOC__
==Overview==
The '''Address Types '''setting allows you to define a number of different address types to be used elsewhere in the system.
==Configuration - Essentials==
===Example of Address Type===
'''Address Types '''are available to a [[User|user]] with a [[User role|role]] that an '''Address Type '''has been made available to.
===Accessing Address Types===
In order to use this feature, follow these steps:
:: {{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.
===Manually Creating a New Address Type=== To create a new Address Typemanually, after clicking the '''+ '''icon from the '''Address Types '''page, you must fill in the fields for the new type.
:: [[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.
* '''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 the default type for organization records.
|-
||'''Maximum Number of Addresses'''
||The maximum quantity of this specific type of address allowed.
|}
<br />
* '''IMPORTANT:''' when enabling you '''''must''''' follow the instructions on the [[Importing 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.
* User can click on New to use the Import and Export options to copy across address types from other instances or can click on Addresses to manually enter new address type details.
* The fields available include:
*** '''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 the default type for company records.
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">Notes: If a Default Type is not set on an Address Type, the combo box for Address Types will not be displayed when adding/editing an address record.
If an Address Type is made a "Default Type for Users," all roles will have access to this Address Type.
If an Address Type is made a "Default Type for Companies," all categories will have access to this Address Type.</pre>
**
**:* '''Maximum Number of Addresses''' - The maximum quantity of this type of address allowed.
**:* '''Address Book Template''' - This setting can be used to personalize the block of text that is returned when using the @addressbook@ [[variable]]. See the [[Address Book Template]] page for configuration instructions.
* **
[[image:New Multiple Address Permissions.PNG|link=]]
**
**:* '''Roles Available to''' - User Roles that will be able to access and complete the specific address type from within their User Profile
**:* '''Categories Available To''' - Organization Categories that will be able to access and complete the specific address type from within their Organization Profile
*** Once the fields are populated as required then click Save.
*** The Address Type will now be visible in the list of available address types.
[[image:Address_Types_Saved.png]]
*** Click on the New Field tab at the top of the screen.
[[image:AddessTypeNewField2.png]]
*** The '''New Custom Field''' window is displayed, with existing options for configuring required custom fields. See [[Custom Fields – General Information]] for further details.
*** Click on the Standard Fields tab at the top of the screen.
[[image:AddessTypeStandardNew.png]]
*** User is presented with a list of available [[Contact and Account Standard Fields|Standard fields]].
[[image:AddessTypeStandardOptions.png]]
*** Click on the hyperlink for a standard field and configure the visibility and validation that you wish to apply for that specific field.
*** Click Save
==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.
==See Also==
*** [[Viewing Address Types]]
