Changes

Jump to: navigation, search

Address Types

6,040 bytes added, 19:17, 17 June 2019
no edit summary
{{Banner-UnderConstruction}}
 
 
 
__TOC__
The '''Address Types''' setting in the [[Business & System Configuration]] section of the [[Global Settings]] page allows you to define a number of different address types to be used elsewhere in the system.
[[image:Address_Types.png]]
In order ==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 use this feature; similarly, you must first go they are available to an [[Organization|organization]] with a [[Global SettingsClient Categories|category]] > that an '''Address Type '''has been made available to. When accessing the [[Business & 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 ConfigurationAdministrator]] and check off role, you will also have the ability to modify the Address Type from the profile by editing the "Enable Multiple 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" optionTypes. '''
:: [[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 '''IMPORTANT:+ ''' when enabling you ''icon from the '''must''''' follow the instructions on the [[Importing Address]] Wiki article to ensure the existing addresses are retained. If the Types ''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 profilepage, you must fill in the original data stored in fields for the profile address will be lostnew 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.
==Creating New '''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. 
|}
* Click <pre> If a Default Type is not set on '''an Address Type - either for Users or Companies - the combo box for Address Types''' link within the [[Business & System Configuration]] section of the [[Global Settings]] pagewill not be displayed when adding/editing an address record.</pre>
* User can Click '''Save '''once you are done filling out the fields, and click on New to use onto the Import second tab, '''Permissions and Export options to copy across address types from other instances or can click on Addresses to manually enter new address type detailsAvailability. '''
:: [[imageFile:NewAddressTypeNew 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.'''
* If User selects Addresses they can enter the The details of the new '''Address Type '''will display on a new address type into a number page,  indicating that it is now available on the list of Address Types available fieldsin your [[SmartSimple]] [[instance]].
[[imageOn the left hand side, the menu items related to Address Types will be displayed:New Multiple Address Settings.PNG|link=]] 
:: [[File:Menu for address type.png|border]] 
{| class="wikitable"
|-
||'''Main'''
||
The '''General '''tab displays the descriptive information related to the Address Type: 
* The fields available include: Address Type ID :* '''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 Orderorder]]", with lowest value appearing first in the drop-down list. :* '''Description''' - a general description for the address type. Description :* '''Color Code'''- an optional color code for the address type when displayed. :* '''Default Type''' - In order to use the Multiple Address feature, a default address must be selected.options ::*'''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: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; 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
:* '''Maximum Number of Addresses''' - The maximum quantity of this type of address allowed.:* second '''Address Book TemplatePermissions & Availability ''' - This setting can be used tab denotes the roles, statuses, and categories able to personalize the block of text that is returned when using the @addressbook@ [[variable]]. See the [[access this Address Book Template]] page for configuration instructionsType. 
|-
||'''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. 
|}
[[image:New Multiple ===Importing Address Types===On the main '''Address PermissionsTypes '''page, you have the options to either '''import '''new records as Address Types into the system, or '''export '''the existing Address Types.PNG|link=]] 
:: [[File:Import export address types.png|border]]: :* The '''Roles Available toimport ''' - User Roles that will be able to access and complete option is on the specific address type from within their User Profile:* left; the '''Categories Available Toexport ''' - Organization Categories that will be able to access and complete button is on the specific address type from within their Organization Profileright. 
* Once ===Exporting Address Types===In order to use this feature, you must first go to [[Global Settings]] > [[Business & System Configuration|System]] and check off the fields are populated as required then click Save"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
* The ==Configuration - Advanced=====Add Custom Fields to Address Type will now be visible in ===After clicking into the list of available address typesspecific Address Type you want to configure, go to the left-hand menu and select '''Custom Fields. '''
[[image:Address_Types_SavedOnce 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]]
:: [[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. 
* Click on :: [[File:Address type edit standard field.png|600px|border]]On the left hand menu of that Address Type page, select the '''FieldsStandard Fields ''' button to the right of the Address Type name you wish to add custom fields againsttab.  
[[image:AddessTypeNewFieldA list of the available Standard Fields associated with Address Type will appear.png]] 
: [[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.
* Click on the New :: [[File:Address type edit standard field specific.png|400px|border]]The Standard Field tab at the top of configuration window will open, allowing you to configure the screenvisibility and validation that you wish to apply for this specific field. 
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. 
* The There are two options to configuring the Address Template: through HTML or through the '''New Custom FieldPicker, ''' window is displayed, with existing options for configuring required custom fields. See [[Custom Fields – General Information]] which allows more accessible and easy drag-and-drop functionality for further detailsconfiguration.  
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.
==Add Standard Fields to Click '''Save '''when the Address Type==Template is complete. 
* Click on ===Enabling Multiple Address Types===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. 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 />'''
[[imageTo enable Multiple Address Types, follow these steps:AddessTypeStandard2.png]] 
1. Click on the 9-square menu icon on the top right of your page.
* Click on the Standard Fields tab at the top of :: {{Icon-Menu}} 2. Under the screenheading '''Configuration, '''select '''Global Settings. '''
[[image:AddessTypeStandardNew3. On the first tab, scroll down until the subheading '''System Options '''and toggle on the '''Enable Multiple Addresses '''feature.png]]
:: [[File:Address type enable multiple address.png|450px|border]]
* User is presented with a list 4. Press '''Save''' at the bottom of available [[Contact and Account Standard Fields|Standard fields]]the page.
[[image:AddessTypeStandardOptionsOnce you have toggled on this option and saved your change, you have the ability to associate organizations and users to multiple addresses.png]] 
===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.
* Click on ===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 hyperlink Address Types in their system a '''Default''' for either Users or Organizations, a standard field and configure the visibility and validation function which can be modified directly in that you wish to apply for that specific fieldAddress Type's page.* Click Save
==Referencing If you have other problems with Address Types==* The @primaryaddress@ and @addressbook@ variables can be used would like more hands-on support, please feel free to reference addresses when multiple address types are enabled. See contact our [[Address Book Template]] for more information.* Individual Address Type values can be referenced using How the [[Web_Page_View_Field_Variables#To_Display_a_List_of_Activities.2C_Notes.2C_Transactions.2C_Contacts.2C_Companies.2C_Consumers.2C_ProvidersSmartSimple Support Desk Works|list syntaxSupport Desk]] [#(?object=address) ... #] under a user or company, which provides 24-5 support for all of our clients.
==See Also==
:* [[Viewing Address Types]]* [[Troubleshooting Address Types]]:* [[Address Book Template]]:* [[Importing Address]]
[[Category:Global Settings]][[Category:Contacts]]
Emmy Fu
2,299
edits
Retrieved from ‘https://wiki.smartsimple.com/wiki/Special:MobileDiff/29656...35272’

Navigation menu