Changes

Jump to: navigation, search

Address Types

4,935 bytes added, 19:17, 17 June 2019
no edit summary
==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===
Once the fields are populated as required, click '''Save.'''
 
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]].
 
On the left hand side, the menu items related to Address Types will be displayed: 
 
:: [[File:Menu 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
 
The second '''Permissions & Availability '''tab denotes the roles, statuses, and categories able to access this Address Type. 
 
|-
||'''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===
:
:* The '''import '''option is on the left; the '''export '''button is on the right. 
 
===Exporting Address Types===
In order to use this feature, you must first go to [[Global Settings]] > [[Business & System Configuration|System]] and check off the "Enable Multiple Address" option.
:* '''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
 
==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.
 
:: [[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 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. 
A list of the available Standard Fields associated with Address Type will appear. 
:* '''IMPORTANT:''' when enabling you '''''must''''' follow the instructions on the [[Importing File:Addresstype standard fields.png|450px|border]] Wiki article to ensure the existing addresses are retained. If the ''Enable Multiple Address'' option is turned Click 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.:** :**:* the '''Address Book Templatepencil icon ''' - This setting can be used next to personalize the block of text Standard Field that is returned when using the @addressbook@ [[variable]]. See the [[Address Book Template]] page for configuration instructionsyou 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. 
:*** The Address Type will now be visible in See the list of available address types.[[image:Address_Types_Saved.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. 
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. 
==Add Custom Fields To toggle from HTML template configuration to Address Type==:*** Click the Field Picker, toggle on the the '''FieldsUse Field Picker ''' button to option at the right top of the the '''Address Type name you wish to add custom fields against.[[image:AddessTypeNewFieldTemplate '''page.png]]
:: [[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.
:*** Click on the New Field tab at the top of the screen.: [[imageFile:AddessTypeNewField2Address 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. 
===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 />'''
To enable Multiple Address Types, follow these steps:*** The '''New Custom Field''' window is displayed, with existing options for configuring required custom fields. See [[Custom Fields – General Information]] for further details. 
==Add Standard Fields to Address Type==:*** 1. Click on the name 9-square menu icon on the top right of the Address Type as displayed in the Name columnyour page.[[image::AddessTypeStandard2{{Icon-Menu}} 2. Under the heading '''Configuration, '''select '''Global Settings.png]] '''
3. On the first tab, scroll down until the subheading '''System Options '''and toggle on the '''Enable Multiple Addresses '''feature.
:*** Click on the Standard Fields tab at the top of the screen.: [[imageFile:AddessTypeStandardNewAddress type enable multiple address.png|450px|border]]
4. Press '''Save''' at the bottom of the page.
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===:*** User is presented with a list of available The @primaryaddress@ and @addressbook@ variables can be used to reference addresses when multiple address types are enabled. See [[Contact and Account Standard Fields|Standard fieldsAddress Book Template]]for more information.:* Individual Address Type values can be referenced using the [[image:AddessTypeStandardOptionsWeb_Page_View_Field_Variables#To_Display_a_List_of_Activities.2C_Notes.2C_Transactions.2C_Contacts.2C_Companies.2C_Consumers.png2C_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.
If you have other problems with Address Types and would like more hands-on support, please feel free to contact our [[How the SmartSimple Support Desk Works|Support Desk]], which provides 24-5 support for all of our clients.
:*** 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]]:*** [[Troubleshooting Address Types]]:*** [[Address Book Template]]:*** [[Importing Address]]
[[Category:Global Settings]][[Category:Contacts]]
2,299
edits

Navigation menu