Changes

Jump to: navigation, search

Address Types

4,154 bytes added, 19:17, 17 June 2019
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. 
|}
<br />
<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==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.
* The fields available include:** second '''NamePermissions & Availability ''' - text used to identify an address type** '''Caption''' - used if you want to have a label for the address that is different than tab denotes the name** '''Display Order''' - address types will be displayed in the drop-down with regards to the "[[Display Order]]"roles, with lowest value appearing first in the drop-down list.** '''Description''' - a general description for the address type.** '''Color Code'''- an optional color code for the address type when displayed.** '''Default Type''' - In order to use the Multiple Address featurestatuses, a default address must be selected.*** '''As Default Type for Users''' - Select this option and categories able to make access 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;">||'''Notes'''||You can create, edit and view [[Notes: If a Default Overview|notes]] attached to this Address Type is not set on an .|-||'''Address TypeTemplate'''||You can create, edit and view the combo box for [[Address Types will not be displayed when adding/editing an Book Template|address record.If an template]] associated with this Address Type . The address template is made a "Default Type feature used to personalize the block of text that is returned when using the @addressbobok@ [[variable]]. See the [[Address Book Template]] page for Users," all roles will have access configuration instructions. |-||'''Standard Fields'''||Learn how to add Standard Fields to this Address Type.If an Address Type is made a "Default Type for Companies," all categories will have access |-||'''Custom Fields'''||Learn how to add Custom Fields to this Address Type.</pre> |}
** ===Importing Address Types===**:* On the main '''Maximum Number of AddressesAddress Types ''' - The maximum quantity of this type of address allowed.**:* page, you have the options to either '''import '''new records as Address Book TemplateTypes into the system, or '''export ''' - This setting can be used to personalize the block of text that is returned when using the @addressbook@ [[variable]]. See the [[existing Address Book Template]] page for configuration instructionsTypes.* *  
:: [[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. 
** ===Exporting Address Types===**:* '''Roles Available In order to''' - User Roles that will be able use this feature, you must first go to access [[Global Settings]] > [[Business & System Configuration|System]] and complete check off the specific address type from within their User Profile**:* '''Categories Available To''' - Organization Categories that will be able to access and complete the specific address type from within their Organization Profile"Enable Multiple Address" option.
:*** 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.
*** :: [[File:New custom field address type.png|500px|border]] The Address Type will now be visible in the list of available address typesNew Custom Field window is displayed, with existing options for configuring required custom fields. 
:: [[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. 
==Add Custom Fields to Address Type==*** Click on A list of the '''available Standard Fields''' button to the right of the associated with Address Type name you wish to add custom fields against.[[image:AddessTypeNewFieldwill 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.
:: [[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. 
*** Click on See the New Field tab at the top of the screen[[Standard Fields]] page if you require more information about Standard Fields. 
[[image:AddessTypeNewField2===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.png]] 
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.
*** The :: [[File:Address type template html.png|300px|border]]The '''New Custom FieldPicker ''' window is displayed, with existing options for configuring required custom feature will allow you to drag and drop available fields. See [[Custom Fields – General Information]] to customize the display that you want to appear for further detailsthat 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.
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.
*** Click on :: {{Icon-Menu}} 2. Under the Standard Fields tab at the top of the screenheading '''Configuration, '''select '''Global Settings[[image:AddessTypeStandardNew.png]] '''
3. On the first tab, scroll down until the subheading '''System Options '''and toggle on the '''Enable Multiple Addresses '''feature.
*** User is presented with a list of available :: [[Contact and Account Standard FieldsFile:Address type enable multiple address.png|Standard fields450px|border]].
[[image:AddessTypeStandardOptions4. Press '''Save''' at the bottom of the page.png]]
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.
*** 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]]
2,299
edits

Navigation menu