2,299
edits
Changes
no edit summary
{{Banner-UnderConstruction}}
__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; 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. ===Accessing Address Types===In order to use this feature, follow these steps: 1. Click on the 9-square menu icon on the top right of your page. :: {{Icon-Menu}} 2. Under the heading '''Configuration, '''select '''Global Settings.''' 3. Under the first tab, select '''Address Types. ''' :: [[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 Type manually, after clicking the '''+ '''icon from the '''Address Types '''page, you must first go to fill in the fields for the new type. :: [[Global SettingsFile: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 [[Business & System ConfigurationDisplay order|display order]] and check off , 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 "Enable 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 optionto make this Address Type the default type for organization records.
'''Note: '''Enabling either of these will make ''all ''roles (for Users) and ''all ''categories (for Companies) have access to this Address Type.
<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>
Click '''Save '''once you are done filling out the fields, and click onto the second tab, '''Permissions and Availability.'''
Once the fields are populated as required, click '''Save.'''
:: [[imageFile:NewAddressTypeMenu 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 [[image:NewAddressTypePageNotes Overview|notes]] attached to this Address Type.png|-||'''Address Template'''||You can create, edit and view the [[Address Book Template|link=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 [[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
:: [[File:New 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.
===Add Custom Standard Fields to Address Type===On the Address Type list page, click on the '''pencil icon '''to the left of the Address Type you want to add and configure Standard Fields to.
: [[File:Address type standard fields.png|450px|border]]
Click on the '''pencil icon '''next to the Standard Field that you want to add and configure.
See the [[image:AddessTypeNewField2.pngStandard Fields]]page if you require more information about Standard Fields.
===Address Template===
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.
To toggle from HTML template configuration to the Field Picker, toggle on the '''Use Field Picker '''option at the top of the '''Address Template '''page.
:: [[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.
:: [[File:Address type template drag and drop.png|600px|border]]
Add different variables together in one column; for example, you might want to combine both Address lines together. If you would like labelled captions above each row, toggle on '''Include Caption'''. When you want to add a new row, click the '''+''' icon located on the right side of the page, underneath the '''Selected Fields''' square.
1. Click on the 9-square menu icon on the top right of your page.
:: [[File:Address type enable multiple address.png|450px|border]]
===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]]* [[Troubleshooting Address Types]]:* [[Address Book Template]]:* [[Importing Address]]
[[Category:Global Settings]][[Category:Contacts]]