2,299
edits
Changes
no edit summary
{{Banner-UnderConstruction}}
__TOC__
==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===
* '''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.
'''Note: '''Enabling either of these will make ''all ''roles (for Users) and ''all ''categories (for Companies) have access to this Address Type.
|-
||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>
:: [[File:New address type permissions.png|600px|border]]
Click into each text box to select which statuses, roles, and categories will have access to this Address Type from within their user or company [[Profile|profile]]. Depending on whether you have enabled the Address Type as a default for Users or Categories, you will not have the option to select specific roles or categories - instead, the default function makes this Address Type available to all.
Once the fields are populated as required, click '''Save.'''
On the left hand side, the menu items related to Address Types will be displayed:
:: [[File:Menu for address type.png|border]] {| class==Creating New Address Type=="wikitable"|-||'''Main'''||* Click on The '''Address TypesGeneral ''' link within tab displays the [[Business & System Configuration|Business & System Configuration]] section of descriptive information related to the [[Global Settings]] page.Address Type:
* User can click on New to use the Import and Export options to copy across address types from other instances or can click on Address Type ID * Name* Caption* [[Display order]]* Description * Default Type options * Maximum Number of Addresses to manually enter new address type details.
:: [[imageFile:New Multiple Address PermissionsImport export address types.PNGpng|link=border]]: :* The '''import '''option is on the left; the '''export '''button is on the right.
:*** Once '''IMPORTANT:''' when enabling you '''''must''''' follow the instructions on the [[Importing Address]] Wiki article to ensure the fields existing addresses are populated as required then click Saveretained.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.'''
Once the custom fields page is open, click the '''+ '''icon on the top right above the Custom Fields list to create a new Custom Field.
:: [[imageFile:Address_Types_SavedEdit custom field for address types.png|500px|border]] See [[Custom Fields - General Information]] for further details about configuring custom fields.
===Add 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 edit standard field.png|600px|border]]
On the left hand menu of that Address Type page, select the '''Standard Fields '''tab.
: [[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.
:: [[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.
There are two options to configuring the Address Template: through HTML or through the '''Field Picker, '''which allows more accessible and easy drag-and-drop functionality for configuration.
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 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.
Click '''Save '''when the Address Template is complete.
==Add Standard Fields to =Enabling Multiple Address TypeTypes===*** Click on Enabling multiple address types will allow multiple addresses for the name of same organization. To add the multiple addresses, this is configured on the '''Custom Field: Address Type as displayed in the Name columnType '''for that organization.[[image:AddessTypeStandard2This 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.png]] '''<br />'''
To enable Multiple Address Types, follow these steps:
1. Click on the 9-square menu icon on the top right of your page.
3. On the first tab, scroll down until the subheading '''System Options '''and toggle on the '''Enable Multiple Addresses '''feature.
Once you have toggled on this option and saved your change, you have the ability to associate organizations and users to multiple addresses.
===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==
[[Category:Global Settings]][[Category:Contacts]]