Changes

Jump to: navigation, search

Address Types

5,381 bytes added, 19:17, 17 June 2019
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: 
:: {{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 Type manually, after clicking the '''+ '''icon from the '''Address Types '''page, you must fill in the fields for the new type. 
To create :: [[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 new label for the address type that is different|-||'''Display Order'''||Address Typetypes will be displayed in the drop-down with regards to the [[Display order|display order]], after clicking the with the lowest value of display order appearing first in the drop-down list.|-||'''Description '''icon you must fill in ||A general description for the fields address type|-||'''Colour Code'''||An optional colour code for the new address typewhen displayed|-||'''Default Type'''||In order to use the '''Multiple Addresses '''feature, a default address must be selected. 
:: [[File:New address * '''As Default Type for Users - '''Select this option to make this Address Type the default typefor user records.png|650px|border]] * '''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. 
|-
||'''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>
In order to use this featureClick '''Save '''once you are done filling out the fields, you must first go to [[Global Settings]] > [[Business & System Configuration|System]] and check off click onto the "Enable Multiple Address" optionsecond tab, '''Permissions and Availability.'''
:: [[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.'''
* '''IMPORTANT:''' when enabling you ''The details of the new '''must''''' follow the instructions on the [[Importing Address]] Wiki article to ensure the existing addresses are retained. If the Type ''Enable Multiple Address'' option is turned will display on without importing addresses from existing profiles or loading a new set of addressespage, whenever a new address   indicating that it is added to a profile, now available on the original data stored list of Address Types available in the profile address will be lostyour [[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: 
==Creating New * Address Type==ID * Name* Caption* Click on '''Address Types''' link within the [[Business & System Configuration|Business & System ConfigurationDisplay order]] section * Description * Default Type options * Maximum Number of the [[Global Settings]] page.Addresses
* User can click on New to use The second '''Permissions & Availability '''tab denotes the Import roles, statuses, and Export options to copy across address types from other instances or can click on Addresses categories able to manually enter new address type detailsaccess this Address Type. 
|-||'''Notes'''||You can create, edit and view [[image:New Multiple Notes Overview|notes]] attached to this Address SettingsType.PNG|-||link='''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. 
:: [[File:Import export address types.png|border]]
:
:* The '''import '''option is on the left; the '''export '''button is on the right. 
* The fields available include:** '''Name''' - text used to identify an address type** '''Caption''' - used if you want to have a label for the address that is different than the name** '''Display Order''' - address types will be displayed in the drop-down with regards to the "[[Display Order]]", with lowest value appearing first in the drop-down list.** '''Description''' - a general description for the address type.===Exporting Address Types===** '''Color Code'''- an optional color code for the address type when displayed.** '''Default Type''' - In order to use the Multiple Address this feature, a default address you must be selected.*** '''As Default Type for Users''' - Select this option first go 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;"[[Global Settings]] >Notes: If a Default Type is not set on an Address Type, [[Business & System Configuration|System]] and check off 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 Enable Multiple Address Type is made a "Default Type for Companies," all categories will have access to this Address Typeoption.</pre>
:**'''IMPORTANT:* '''Maximum Number of Addresseswhen enabling you '''' - The maximum quantity of this type of address allowed.**:* 'must''Address Book Template''' - This setting can be used to personalize follow the block of text that is returned when using instructions on the @addressbook@ [[variableImporting Address]]Wiki article to ensure the existing addresses are retained. See If the [[''Enable Multiple Address Book Template]] page for configuration instructions.'' 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.'''
[[image:New Multiple Address PermissionsOnce the custom fields page is open, click the '''+ '''icon on the top right above the Custom Fields list to create a new Custom Field.PNG|link=]]
**:* '''Roles Available to''' - User Roles that will be able to access and complete the specific : [[File:New custom field address type from within their User Profile.png|500px|border]] **:* '''Categories Available To''' - Organization Categories that will be able to access and complete the specific address type from within their Organization ProfileThe New Custom Field window is displayed, with existing options for configuring required custom fields. 
** :: [[File:Edit custom field for address types.png|500px|border]] *** Once the See [[Custom Fields - General Information]] for further details about configuring custom fields are populated as required then click Save.
===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. 
*** The Address Type will now be visible in the list of available address types.:: [[imageFile:Address_Types_SavedAddress 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 standard fields.png|450px|border]]
Click on the '''pencil icon '''next to the Standard Field that you want to add and configure.
==Add Custom Fields to :: [[File:Address Type==type edit standard field specific.png|400px|border]]*** Click on the '''Fields''' button The Standard Field configuration window will open, allowing you to configure the right of the Address Type name visibility and validation that you wish to add custom fields againstapply for this specific field.[[image:AddessTypeNewField.png]] 
See the [[Standard 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. 
*** Click on There are two options to configuring the New Address Template: through HTML or through the '''Field tab at the top of the screen.[[image:AddessTypeNewField2Picker, '''which allows more accessible and easy drag-and-drop functionality for configuration.png]] 
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.
*** The :: [[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 '''New Custom Field+''' window is displayedicon located on the right side of the page, with existing options for configuring required custom fields. See [[Custom underneath the '''Selected Fields – General Information]] for further details''' 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: 
==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 column.[[image:AddessTypeStandard2your page.png]]
:: {{Icon-Menu}} 
2. Under the heading '''Configuration, '''select '''Global Settings. '''
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