Difference between revisions of "Custom Fields – General Information"

From SmartWiki
Jump to: navigation, search
 
(100 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==Custom Fields – Standard Properties==
+
{{Banner-UnderConstruction}}
  
The following settings are common to all custom field types.
 
  
[[Image:Cf1.png]]
 
  
==='''Display Order'''===
+
=Overview=
 +
A '''Custom Field '''is the basic unit of data storage, created on an as-needed basis for your system, and is associated with a [[SmartSimple]] [[entity]] such as a [[User|contact]], [[Organization|organization]], [[User Role|role]], or activity. These fields can be accessed and controlled from either the [[Global Settings]] area of your system, or on the Entity-based '''Settings '''page within a {{UTA}}.
  
* This setting determines the order that the field will be displayed on the page. The first field that is added to an [[Entity|entity]] will use a display order of 10.
+
New custom fields are added on a regular basis - we currently have over 50 field types that can be used to capture and store data. For a full list of Custom Fields, see [[:Category:Custom Fields#Types of Custom Fields|Types of Custom Fields]]. You can also check the [[Upgrades]] section of our Wiki for continuous notice of the latest field types. 
* Additional fields that you add will automatically increase the display order by increments of 10.
 
* If you wish to insert a field between two fields you can set the display order to a number that will position the field where required.
 
* You can change the display order by setting the display order to a different number. For example, if you set the display order on a field to 5000 then the next field added will automatically become 5010.  
 
  
==='''Display Order with Related Entities'''===
+
'''Custom Fields '''are used in addition to [[Standard Fields]], which are automatically built into your system (for example, '''Name '''or '''Address '''are typical Standard Fields). While '''Custom Fields '''can be added, removed, and customized, as a general rule Standard Fields cannot be changed, although they might be renamed or modified. 
  
If you add [[Custom Field|custom fields]] to the basic contact [[Entity|entity]] and then add fields to [[Role|roles]] associated with contacts, you will need to take care, as the fields will become mixed if they have the same number sequence.
+
All fields display data in configurable ways: for example, they can be grouped into tabs or displayed in multiple columns to avoid cluttering the page. 
  
The following table outlines where you need to be careful:
+
* The maximum number of custom fields that can be displayed on a single page is 400 total.
  
[[Image:Cf3.png]]
+
==Accessing Custom Fields==
 +
1. Click the 9-square menu icon on the top right of your page.
  
You should start the number sequence for these types of related fields at some higher level. For example, role 1 starts at 5000, role 2 starts at 8000.
+
:: {{Icon-Menu}} 
 +
2. Under the heading '''Configuration, '''select '''Global Settings.'''
  
==='''Tab Order'''===
+
The hyperlink to '''Custom Fields '''will be available under ''each ''tab. Clicking the '''Custom Fields '''link under a specific tab will bring you to the custom fields that are associated with the purpose of that tab - for example, if you click on the '''Custom Fields '''under the '''User '''tab, this will bring you to a list of all custom fields specifically associated with [[User|users]], both [[Internal|internal]] and [[External|external]]. 
  
* By adding a text value to the tab order to the field will be displayed on that tab.
+
{| class="wikitable"
* The tab name can be any text string required.
+
|-
* Custom fields that are not associated with a tab will be displayed on a tab named Default.  
+
||'''System - Custom Fields'''
 +
||A list of all custom fields from ''all ''object types in the system.
 +
|-
 +
||'''Organizations - Custom Fields'''
 +
||Create and manage custom fields for '''Branch '''([[Internal]] organization on the [[Organization hierarchy|organization hierarchy]]) and '''Organization '''([[External]])
 +
|-
 +
||'''Users - Custom Fields'''
 +
||Create and manage custom fields for [[User|users]], both [[Internal]] '''Staff '''and [[External]] '''Contacts'''
 +
|-
 +
||'''Associations - Custom Fields'''
 +
||Create and manage custom fields for [[Association Settings|associations]], which can be between companies and users or company-to-company 
 +
|-
 +
||'''Transactions - Custom Fields'''
 +
||Create and manage custom fields for [[:Category:Transactions|Transactions]] and [[Transaction Attribution|transactions attributions]]
 +
|}
 +
:: [[File:All custom fields.png|thumb|none|600px|border|All custom fields for system objects]]
 +
:: [[File:Organization custom fields.png|thumb|none|500px|border|Custom fields for Organizations under the Organizations tab]]
 +
When you click into a '''Custom Fields''' hyperlink from the '''Global Settings''' area, you will be brought to a [[List View Overview|list display]] of all available custom fields relating to that part of the system. In order to modify a Custom Field, you can simply select the '''pencil icon''' to the left side of the custom field name, as shown below:
 +
:: [[File:Edit custom field.png|950px|border]]
 +
:
 +
:* Using the '''Search''' function on the top right, you can search through all '''Object Entities''' or through the fields of specific {{UTA}}s. Simply select or deselect to control your results.
 +
:* '''Tip: '''A Search-based strategy for troubleshooting is to clear your past search, select '''All Object Entities '''within the search bar, then click on the '''Last Modified '''field in the list view so that it is in descending [[Sort By|Sort Order]] and you can see the date that a custom field was changed, added, etc. 
 +
:* You can also access all deleted fields by clicking into the second tab. There is no time limit within the system that removes deleted records; therefore, you can simply select and restore or purge these previously deleted fields.
 +
:* There should be no reason to purge as Custom Fields do not take up much space within the system.
 +
:* When you restore fields, there is no loss of data. 
  
==='''Fields with No Tab Set'''===
+
=Configuration - Essentials=
 +
<pre>This page will serve as the main repository for setup information that is shared between most field types. To find setup options that are specific to a certain field type, look into the Wiki page for that field type itself. </pre>
 +
==Common Custom Field Functions==
 +
On the top left of the Custom Field record will be a row of buttons, each with different functions relating to the field.
  
[[Image:Cf4.png]]
+
::: [[File:Custom field menu buttons.png|200px|border]] 
 +
The following table describes the functionality of each button from left to right: 
  
<u>'''Same Fields with Tab set to Creation Details'''</u>
+
{| class="wikitable"
 +
|-
 +
||'''Custom Fields [[List View Overview|list]]'''
 +
||Clicking this '''list chart '''icon will bring you to the list of all custom fields available in this part of the system. For example, if you are on a Custom Field that is found under the '''Organizations '''tab of '''Global Settings, '''you will be brought to a comprehensive list of all custom fields relating to '''Organizations. '''
 +
|-
 +
||
 +
'''New Custom Field '''
  
[[Image:Cf5.png]]
+
('''+ icon''')
  
<u>'''Field Name and Field ID'''</u>
+
||Clicking this '''plus icon '''will allow you to create a '''New Custom Field''' in this part of the system. To understand how to create a new custom field by appropriately filling out the different settings, keep on reading the sections in this page below. 
 +
|-
 +
||
 +
'''[[Field Data]] '''
  
* The field name is mandatory.
+
('''stack of coins icon) '''
* The name can be up to 255 characters long and should not include special characters that could be misinterpreted by the [[Browser|browser]].
 
* The Field ID is automatically generated by the system as a number value and is displayed to the right.
 
  
[[Image:Cf6.png]]
+
||
 +
Clicking this will open up a page that displays all the values that have been saved to the field.
  
<u>'''Referencing Fields Names and Field ID in other Custom Fields Types'''</u>
+
Custom Field Data consists of two general types: '''text type '''fields (saved as a text string) and '''object type''' fields (consisting of any files such as documents or images).''' '''
  
You can reference fields by name or by ID in other fields. The following field types support this type of referencing:
+
|-
 +
||
 +
'''[[Update History]] '''
  
* '''Display Only''' – External Entity Details.
+
('''reload icon''')
* '''Display Only''' - Web Page View.
 
* '''Special''' – Calculated Value.
 
  
The syntax for these field types varies (some are processed on the server and other in a JavaScript in the client) and is explained for the individual field type.
+
||
 +
Clicking this will open up a page with a [[List View Overview|list]] of all of the updates to field settings that have been made on this field.
  
<u>'''Special Field Name Syntax'''</u>
+
|-
 +
||
 +
'''Search Reference'''
  
There are two special characters that can be used to prefix the field name. These prefixes control the presentation on the field name in relation to the presentation of the data.
+
('''magnifying glass icon''') 
  
* The '''Tilde''' ~ is used to display the field name above the field.  
+
||
 +
Clicking this will display all of the locations where the custom field is referenced in the system. For more information, see [[Custom Fields – General Information#Custom Field References]]. 
  
[[Image:Cf7.png]]
+
Fields are fully searchable for any related application. For example, [[User Role|role]]-level fields can be searched through the '''Search People '''feature or any application that provides access to contact data. You can also search and replace these values in bulk by using the '''Field Data '''button and specifying the old and new value required. 
  
* A '''Hyphen''' “-“ is used exclusively with the '''Title Bar – Multiple Columns''' field to suppress the title bar but display a multiple column layout.
+
|}
* A '''@''' sign can be used with the built-in field Location in the [[Universal Tracking Application]] to connect the field to the [[User|user’s]] selected mapping service.
+
<!--Custom Fields share many of the same setup options, so we've listed them here. Please see below:-->
 +
<!--
 +
<span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="FieldOptionsINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name=" FieldOptionsINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="  FieldOptionsINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="  FieldOptionsINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="    FieldOptionsINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="    FieldOptionsINFO" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="      FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="      FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="        FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="        FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="          FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="          FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="            FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="            FieldOptionsINFO" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="              FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="              FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="                FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="                FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="                  FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                  FieldOptionsINFO" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                    FieldOptionsINFO" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                    FieldOptionsINFO" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="                      FieldOptionsINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                      FieldOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                        FieldOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                        FieldOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                          FieldOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                          FieldOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                            FieldOptionsINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                            FieldOptionsINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                              FieldOptionsINFO" data-bs-type="template" data-bs-id="4">{{                              FieldOptionsINFO }}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>
 +
<span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="DisplayINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name=" DisplayINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="  DisplayINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="  DisplayINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="    DisplayINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="    DisplayINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="      DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="      DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="        DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="        DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="          DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="          DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="            DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="            DisplayINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="              DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="              DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                  DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="                  DisplayINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="                    DisplayINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="                    DisplayINFO" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                      DisplayINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                      DisplayINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                        DisplayINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                        DisplayINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                          DisplayINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                          DisplayINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                            DisplayINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                            DisplayINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                              DisplayINFO" data-bs-type="template" data-bs-id="5">{{                              DisplayINFO }}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>
 +
<span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="ValidationINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name=" ValidationINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="  ValidationINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="  ValidationINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="    ValidationINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="    ValidationINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="      ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="      ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="        ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="        ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="          ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="          ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="            ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="            ValidationINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="              ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="              ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                  ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="                  ValidationINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="                    ValidationINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="                    ValidationINFO" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                      ValidationINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                      ValidationINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                        ValidationINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                        ValidationINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                          ValidationINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                          ValidationINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                            ValidationINFO" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                            ValidationINFO" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                              ValidationINFO" data-bs-type="template" data-bs-id="6">{{                              ValidationINFO }}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>
 +
<span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="FeatureOptionsINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name=" FeatureOptionsINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="  FeatureOptionsINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="  FeatureOptionsINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="    FeatureOptionsINFO" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="    FeatureOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="      FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="      FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="        FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="        FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="          FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="          FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="            FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="            FeatureOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="              FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="              FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                  FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                  FeatureOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                    FeatureOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="                    FeatureOptionsINFO" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="                      FeatureOptionsINFO" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                      FeatureOptionsINFO" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                        FeatureOptionsINFO" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                        FeatureOptionsINFO" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                          FeatureOptionsINFO" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                          FeatureOptionsINFO" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name="                            FeatureOptionsINFO" data-bs-type="template" data-bs-id="7"><span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name="                            FeatureOptionsINFO" data-bs-type="template" data-bs-id="7"><span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name="                              FeatureOptionsINFO" data-bs-type="template" data-bs-id="7">{{                              FeatureOptionsINFO }}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>
 +
<span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="ValueStorage" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name=" ValueStorage" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="  ValueStorage" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="  ValueStorage" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL5@@@" data-bs-name="    ValueStorage" data-bs-type="template" data-bs-id="5"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="    ValueStorage" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="      ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="      ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="        ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="        ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="          ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="          ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="            ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="            ValueStorage" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="              ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="              ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                  ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                  ValueStorage" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                    ValueStorage" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL4@@@" data-bs-name="                    ValueStorage" data-bs-type="template" data-bs-id="4"><span class="mceNonEditable template" id="bs_template:@@@TPL6@@@" data-bs-name="                      ValueStorage" data-bs-type="template" data-bs-id="6"><span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name="                      ValueStorage" data-bs-type="template" data-bs-id="7"><span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name="                        ValueStorage" data-bs-type="template" data-bs-id="7"><span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name="                        ValueStorage" data-bs-type="template" data-bs-id="7"><span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name="                          ValueStorage" data-bs-type="template" data-bs-id="7"><span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name="                          ValueStorage" data-bs-type="template" data-bs-id="7"><span class="mceNonEditable template" id="bs_template:@@@TPL8@@@" data-bs-name="                            ValueStorage" data-bs-type="template" data-bs-id="8"><span class="mceNonEditable template" id="bs_template:@@@TPL8@@@" data-bs-name="                            ValueStorage" data-bs-type="template" data-bs-id="8"><span class="mceNonEditable template" id="bs_template:@@@TPL8@@@" data-bs-name="                              ValueStorage" data-bs-type="template" data-bs-id="8">{{                              ValueStorage }}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>
 +
-->
 +
The following settings are common to nearly all [[Custom Fields|Custom Field]] types:
 +
:* [[#General Settings|General Settings]]
 +
:* [[#Display & Formatting|Display & Formatting]]
 +
:* [[#Validation|Validation]]
 +
:* [[#Feature Options|Feature Options]]
 +
:* [[#Value Storage|Value Storage]]
 +
{{FieldOptionsINFO}}
 +
{{DisplayINFO}}
 +
{{ValidationINFO}}
 +
{{FeatureOptionsINFO}}
 +
{{ValueStorageINFO}}
 +
<!--
 +
[[Image:Cf1.png]]-->
 +
<!--===Field Name and Field ID===
 +
* The field name is mandatory and can be up to 50 characters in length.
 +
* The name should not include special characters that could be misinterpreted by the [[Browser|browser]].
 +
* The Field ID is automatically generated by the system as a number value and is displayed to the right when viewing the list of custom fields.
 +
<!--
 +
[[Image:Cf6.png]] -->
 +
<!--<u>'''Referencing Field Names and Field IDs in other Custom Field Types'''</u>
  
<u>'''Field Type'''</u>
+
You can reference fields by name or by ID in other fields. The following field types support this type of referencing:
  
The field type is used to define the characteristics of the field. There are '''40''' field types currently available.
+
* '''Display Only''' – External Entity Details.
 +
* '''Display Only''' - Web Page View.
 +
* '''Special''' – Calculated Value.
  
 +
The syntax for these field types varies (some are processed on the server and other in a JavaScript in the client) and is explained for the individual field type.-->
  
==='''Visibility Condition'''===
+
==Permissions & Availability==
 +
The second tab available when opening a '''Custom Field '''is usually the '''Permissions & Availability '''section. Although the sectioning of permissions and availability will differ depending on what type of Custom Field it is, as well as to what part of the system it is attached to, the '''Permissions & Availability '''options might look something like this: 
  
Whether or not a [[Custom Field|custom field]] is visible can be controlled using conditional statements in this box.
+
::: [[File:Custom fields permissions and availability.png|500px|border]]
 +
Access to a [[Custom Field|custom field]] is controlled by permissions. These can be found and set in any custom field, on the Permissions and Availability tab. You can set only certain roles to be able to see/edit a field, or you can do the same thing with statuses. An example would be denying the '''Applicant''' role permission to see the '''Decision '''custom field (as this would reveal pre-emptively whether or not their application has been approved or denied). 
  
For example, if you used the following '''Visibility Condition''':
+
{| class="wikitable"
*now()>'2009-02-06'
+
|-
The field will only be visible after 06 February 2009.
+
||'''Role - Field Permissions'''
 +
||
 +
'''Allow View Field: '''Click into this text box to select which roles will have the permission to ''view ''this field. When they open up a record in the system that has this field, they will be able to see the field and any content already inputted into it.
  
 +
'''Allow Modify Field: '''Click into this text box to select which roles will have the permission to ''modify ''this field. When they open up a record in the system that has this field, they will be able to see the field as well as modify any content that is inputted into it, or put content if there is nothing inputted already.
  
These conditional statements can also refer to other fields:
+
'''Deny View Field: '''Click into this text box to select which roles will be ''denied ''permission to view this field. If they open up a record in the system with this field attached, they will not be able to see it on the record details.
*'@Date initiated@' >'2009-01-31'
 
The field will only be visible if the date in the field named '''Date Initiated''' is after 2009-01-31
 
  
 +
'''Deny Modify Field: '''Click into this text box to select which roles will be ''denied ''permission to ''modify ''this field. If they open up a record in the system with this field attached, they will be able to view this field but ''not ''have the ability to modify its content at all. 
  
*'@Destination City@'='Toronto'
+
|-
The field will only be visible if the entry in the '''Destination City''' field is '''Toronto'''
+
||'''Organizations Status - Field Permissions'''
 +
||
 +
'''Allow View Field: '''Click into this text box to select which [[Status|statuses]] will have permission to ''view ''this field. In this case the status must be relating to the organization - that is, only an organization that ''is ''in the selected statuses will be able to see this field when opening a record.
  
 +
'''Allow Modify Field: '''Click into this text box to select which statuses will have permission to ''modify ''this field.
  
*'@status@' in ('Draft','Open')
+
'''Deny View Field: '''Click into this text box to select which statuses will be ''denied ''permission to view this field. For example, an organization that is in '''Inactive ''''''Status '''might be denied permission to view fields as there is no need for them to know that information.
The field will only be visible when the status is '''Draft''' or '''Open'''
 
  
 +
'''Deny Modify Field: '''Click into this text box to select which statuses will be ''denied ''permission to ''modify ''this field.
  
'''Note:''' remember to include the @fieldname@ in single quotes.
+
|-
 +
||'''Category - Field Availability'''
 +
||
 +
'''Include Field For: '''Click into this text box to select which [[Client Categories|organization categories]] will have permission to have this field to fill out. 
  
==='''Role Permissions'''===
+
'''Exclude Field For: '''Click into this text box to select which [[Client Categories|organization categories]] will not have permission to have this field to fill out. 
  
Access to a [[Custom Field|custom field]] is controlled by permissions.
+
|}
  
[[Image:Cf8.png]]
+
See [[Role Field Permissions]] , [[Field Permissions]], or [[Status Field Permissions]] for more information.
 +
<!--<u>'''Special Field Name Syntax'''</u>
  
* '''Allow View Field''' –If you associate this setting with [[Role|roles]], then the field will only be displayed to people with these [[Role|roles]]. If you leave this field blank, then everyone will be able to see the field.
+
There are two special characters that can be used to prefix the field name. These prefixes control the presentation on the field name in relation to the presentation of the data.
* '''Allow Modify Field''' –If you associate this setting with [[Role|roles]], then the field will only be modifiable by people with these [[Role|roles]]. If you leave this field blank, then everyone will be able to modify the value on the field.
 
* '''Deny View Field''' –If you associate this setting with [[Role|roles]], then the field will not be displayed to people with these [[Role|roles]]. If you leave this field blank, then everyone will be able to see the field.
 
* '''Deny Modify Field''' –If you associate this setting with [[Role|roles]], then the field will not be modifiable by people with these [[Role|roles]]. If you leave this field blank, then everyone will be able to modify the value on the field.  
 
  
<u>'''How Field Data is Stored'''</u>
+
* The '''Tilde''' ~ is used to display the field name above the field.
  
Custom field data consists of two general types – '''text type''' fields and '''object type''' fields.
+
[[Image:Cf7.png]]
  
* Text Types fields are stored in the database as text strings.  
+
* A '''Hyphen''' “-“ is used exclusively with the '''Title Bar – Multiple Columns''' field to suppress the title bar but display a multiple column layout.
 +
* A '''@''' sign can be used with the built-in field Location in the [[Universal Tracking Application]] to connect the field to the [[User|user’s]] selected mapping service.
 +
-->
 +
<!--<u>'''Field Type'''</u>
 +
The field type is used to define the characteristics of the field. There are over '''50''' field types currently available.
 +
===[[display order|Display Order]]===
 +
* This setting determines the order that the field will be displayed on the page. The first field that is added to an [[Entity|entity]] will use a display order of 10.
 +
* Additional fields that you add will automatically increase the display order by increments of 10.
 +
* If you wish to insert a field between two fields you can set the display order to a number that will position the field where required.
 +
* You can change the display order by setting the display order to a different number. For example, if you set the display order on a field to 5000 then the next field added will automatically become 5010.
  
These fields are fully searchable to any related application. For example, [[Role|role]] level fields can be searched though the '''Search People''' feature or any application that provides access to contact data.
+
===Display Order with Related Entities===
 +
If you add [[Custom Field|custom fields]] to the basic contact [[Entity|entity]] and then add fields to [[Role|roles]] associated with [[contact]]s, you will need to take care, as the fields will become mixed if they have the same number sequence.
  
You can also search and replace these values in bulk by using the '''Field Data''' tab and specifying the old and new value required.
+
The following table outlines where you need to be careful:
  
[[Image:Cf9.png]]
+
{| border="1"
 +
|-
 +
||'''Entity'''
 +
||'''Related Entity'''
 +
|-
 +
||Contact
 +
||Roles
 +
|-
 +
||Companies
 +
||Categories
 +
|-
 +
||UTA <span class="mceNonEditable template" id="bs_template:@@@TPL11@@@" data-bs-name="l1" data-bs-type="template" data-bs-id="11"><span class="mceNonEditable template" id="bs_template:@@@TPL11@@@" data-bs-name=" l1" data-bs-type="template" data-bs-id="11"><span class="mceNonEditable template" id="bs_template:@@@TPL10@@@" data-bs-name="  l1" data-bs-type="template" data-bs-id="10"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="  l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="    l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="    l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="      l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="      l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="        l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="        l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL10@@@" data-bs-name="          l1" data-bs-type="template" data-bs-id="10"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="          l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="            l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="            l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="              l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="              l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                  l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                  l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                    l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                    l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                      l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                      l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                        l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                        l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                          l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="                          l1" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="                            l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="                            l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="                              l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name="                              l1" data-bs-type="template" data-bs-id="12"><span class="mceNonEditable template" id="bs_template:@@@TPL13@@@" data-bs-name="                                l1" data-bs-type="template" data-bs-id="13"><span class="mceNonEditable template" id="bs_template:@@@TPL13@@@" data-bs-name="                                l1" data-bs-type="template" data-bs-id="13"><span class="mceNonEditable template" id="bs_template:@@@TPL13@@@" data-bs-name="                                  l1" data-bs-type="template" data-bs-id="13"><span class="mceNonEditable template" id="bs_template:@@@TPL13@@@" data-bs-name="                                  l1" data-bs-type="template" data-bs-id="13"><span class="mceNonEditable template" id="bs_template:@@@TPL13@@@" data-bs-name="                                    l1" data-bs-type="template" data-bs-id="13"><span class="mceNonEditable template" id="bs_template:@@@TPL14@@@" data-bs-name="                                    l1" data-bs-type="template" data-bs-id="14"><span class="mceNonEditable template" id="bs_template:@@@TPL14@@@" data-bs-name="                                      l1" data-bs-type="template" data-bs-id="14"><span class="mceNonEditable template" id="bs_template:@@@TPL14@@@" data-bs-name="                                      l1" data-bs-type="template" data-bs-id="14">{{                                        l1 }}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span> Entities
 +
||UTA Level 1 Template Entities
 +
|}
  
* '''Object Type''' fields are stored on the server in a resource folder on the server.  
+
You should start the number sequence for these types of related fields at some higher level. For example, role 1 starts at 5000, role 2 starts at 8000.
  
These fields can consist of files of any type such as documents or images. Document type fields are searchable provided the '''File Index''' option is selected (this option is only available for these types of fields).
+
==Common Custom Field Settings==
 +
Each custom field contains a button at the top linking it to the three following settings pages:
  
<u>'''Import and Export Custom Fields'''</u>
+
* [[Field Data]] - displays all the values that have been saved to the field.
 +
* [[Update History]] - displays all the updates to field settings.-->
 +
<!--* [[Custom Field Language Settings|Language Setting]] - -->
 +
<!--* Search Reference - displays all locations where the custom field is referenced in the system.
  
You can use the custom field '''Import''' and '''Export''' features to move or copy custom fields from one [[Entity|entity]] to another (or even another instance of [[SmartSimple|SmartSimple]]).
+
===Tab Name===
 
+
* If you add a text value to the tab Name, the field will be displayed on that tab.
[[Image:Cf10.png]]
+
* The tab name can be any text string.
 
+
* Custom fields that are not associated with a tab will be displayed on a tab named Default.
<u>'''Field Type Descriptions'''</u>
+
* The Tab Name option appears once the Advanced Options are enabled, on the Classic Options tab.-->
 
+
<!--
The following section provides the details of each field type currently available. The number in brackets next to the '''Field Type''' indicates the internal system field type ID.
+
====Fields with No Tab Set====
 
+
[[Image:Cf4.png]]
==[[Custom Field Type: Creation – Created By]]==
 
 
 
'''General Description''':
 
 
 
Displays the name of the user that created the entity.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type: Creation – Creation Date]]==
 
 
 
'''General Description''':
 
 
 
Displays the date/time stamp for the creation date of the entity.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type: Display Only – External Entity Details]]==
 
 
 
'''General Description''':
 
 
 
* Copies one or more field values from an [[External|external]] entity to the current [[Entity|entity]]. This field is used in conjunction with the '''Display Only External Entity''' field.
 
* The purpose of the field is to carry forward details of a related [[External|external]] entity record to a new [[Entity|entity]], such as a level 1 or level 2 UTA entity.
 
* The [[User|user]] has the ability to overwrite the value or retrieve the value multiple times.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type: Display Only – Image]]==
 
 
 
'''General Description''':
 
 
 
* Displays an uploaded image.
 
* Any image file type can be uploaded to a maximum of 200MB.
 
* The image size can be constrained by setting the height and width properties; otherwise the image will be displayed at its original size.
 
 
 
Alternatively, the image file can be referenced from a [[Smart Folder]]. If the image referenced in the SmartFolder changes, the displayed image will also change.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type: Display Only – Text or System Object]]==
 
 
 
'''General Description''':
 
 
 
* Displays a block of static text for instructional purposes, or a link to some other [[SmartSimple]] entity (or external [[URL]]).
 
* Typically this field type is used to embed a chart into some related [[Entity|entity]]. For example, a chart of the [[User|user’s]] login history into their profile.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type: Display Only – Web Page View]]==
 
 
 
'''General Description''':
 
 
 
A '''Web Page View''' field is used to create a “document” based on underlying [[Entity|entity]] data. The field type has a wide variety of document management options associated, including the conversion to '''PDF''' or '''XML'''.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
 
 
==[[Custom Field Type: Display Only – Web Page View - Tabbed]]==
 
 
 
'''General Description''':
 
 
 
A '''Web Page View - Tabbed''' functions exactly as a '''[[Custom Field Type: Display Only – Web Page View|Web Page View]]]''' field, but allows multiple pages to be displayed on different tabs.
 
 
 
==[[Custom Field Type (88): Dynamic Data – Data Grid]]==
 
 
 
'''General Description''':
 
 
 
Displays sets of additional [[Custom Field|custom fields]] as records in a grid layout. A summary value. For example, a sum or a count can be displayed.
 
 
 
Click on the link above for a more detailed description.
 
 
 
==[[Custom Field Type (87): Dynamic Data – Dynamic Control Field]]==
 
 
 
'''General Description''':
 
 
 
* This field type is used to create sets of fields that are dependent on a value selected from the '''Dynamic Control''' field.
 
* This field type is displayed as a combo box. Depending on the options selected, additional fields will be displayed. In the example above, selecting '''Yes''' as the value for the '''Legal Representation''' field displays all related fields.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (37): Link – Email]]==
 
 
 
'''General Description''':
 
 
 
Stores an email address.
 
 
 
When the email address is clicked in '''View''' mode, the '''SmartSimple Email Agent''' is launched with the email address set as the recipient of the email.
 
 
 
Click on the link above for a more detailed description.
 
 
 
==[[Custom Field Type (80): Link – Multiple Files]]==
 
 
 
'''General Description''':
 
 
 
Stores multiple files into a single field. This field type is used to store:
 
 
 
* Uploaded documents.
 
* Documents that are created using the '''Web Page View''' type field using the '''Store to Server''' option.
 
 
 
Click on the link above for a more detailed description.
 
 
 
==[[Custom Field Type (33): Link – Single File]]==
 
 
 
'''General Description''':
 
 
 
Stores a single file into a single field. This field type is used to store a single uploaded document.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (32): Link – SmartFolder]]==
 
 
 
'''General Description''':
 
 
 
Provides a link to a [[Smart Folder]].
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (35): Link – Website]]==
 
 
 
'''General Description''':
 
 
 
Provides a link to an [[External|external]] website. When the link is clicked the website will be displayed in a new [[Browser|browser]] window.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (76): Lookup – Entity and People]]==
 
 
 
'''General Description''':
 
 
 
* [[User]] is able to look up people and store their organisation names and individual names.
 
* Both [[Internal]] and [[External]] people and organisations can be searched.
 
* The resulting data is read only and not linked to the underlying [[Entity|entity]].
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (95): Lookup – External Entity]]==
 
 
 
'''General Description''':
 
 
 
[[User]] is able to look up external [[Entity|entity]] (company) and store the [[Entity|entity]] name. The resulting data is read only and not linked to the underlying [[Entity|entity]].
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (75): Lookup – External People]]==
 
 
 
'''General Description''':
 
 
 
[[User]] is able to look up [[External|external]] people and store the names (multiple select). The resulting data is read only and not linked to the underlying [[Entity|entity]].
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (90): Select One – Internal Entity]]==
 
 
 
'''General Description''':
 
 
 
* [[User]] is able to look up internal [[Entity|entities]] and store the name – single selection.
 
* [[Internal]] entities are displayed in a combo box.
 
* The resulting data is read only and not linked to the underlying [[Entity|entity]].
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (70): Select One – Internal People]]==
 
 
 
'''General Description''':
 
 
 
[[User]] is able to look up [[Internal|internal]] people and store a single name. The resulting data is read only and not linked to the underlying [[Entity|entity]].
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (109): Read Only – System Variables]]==
 
 
 
'''General Description''':
 
 
 
This field type is similar to a web page view field and can contain HTML, text field references and expressions. Unlike a web page view field there are no options to save the data.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (39): Read Only – Text]]==
 
 
 
'''General Description''':
 
 
 
This field is used in two circumstances:
 
 
 
* Display a read only version of field value linked through the '''Store to Value'''.
 
* Display the results of a [[Template|template]] level formula in the [[Universal Tracking Application]].
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (20): Select Many – Check Boxes]]==
 
 
 
'''General Description''':
 
 
 
* Displays as a set of check boxes in '''Edit''' mode. The [[User|user]] can select multiple values.
 
* In '''View''' mode, the values are displayed as text, semi-colon delimited.
 
* The # of columns option is used to define the number of columns required for display.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (22): Select Many – List Box]]==
 
 
 
'''General Description''':
 
 
 
* Displays as a '''List''' box in '''Edit''' mode.
 
* Displays as a list of values the [[User|user]] can select multiple values. The [[User|user]] needs to use '''Control + Click''' to select multiple items or '''Shift + Click''' to select a set of contiguous items.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (21): Select Many – Scrolling Check Box]]==
 
 
 
'''General Description''':
 
 
 
* Displays as a set of check boxes within a scrolling window when viewed in '''Edit''' mode. The [[User|user]] can select multiple values.
 
* The size of the scrolling window is controlled by the '''Height Setting'''.
 
* In '''View''' mode the values are displayed as text, semi-colon delimited.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (10): Select One – Combo Box]]==
 
 
 
'''General Description''':
 
 
 
* Displays as a set of values in a combo box. The [[User|user]] can select a single value.
 
* The size of scrolling window is controlled by the '''Height Setting'''.
 
* In '''View''' mode the values are displayed as text, semi-colon delimited.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (72): Select One – Ledger Code]]==
 
 
 
'''General Description''':
 
 
 
Links the [[Custom Field|custom field]] to the set of account codes stored in the [[Global Settings]], '''Business Configurations''', '''Ledger Codes'''.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (127): Select One – Multi-Level Combo]]==
 
 
 
'''General Description''':
 
 
 
* Displays up to three combo boxes linked by the selected value.
 
* When the [[User|user]] selects a value for the first combo box, only the related values are displayed in the second combo box.
 
 
 
Click on the link above for a more detailed description.
 
 
 
==[[Custom Field Type (50): Special – Auto Number]]==
 
 
 
'''General Description''':
 
 
 
* Generate a '''unique sequential''' number for this field.
 
* The '''Start''' number is entered in the '''Start Number''' setting and will increment by one for each new record created.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (103): Special – Browser Script]]==
 
 
 
'''General Description''':
 
 
 
* This field type adds a JavaScript to the page on which it is located.
 
* This script will execute whenever the page is saved.
 
* This field type is used by programmers to create enhanced functionality.
 
* The field is not displayed.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (60): Special – Calculated Value]]==
 
 
 
'''General Description''':
 
 
 
* Executes an expression to calculate a value and store the result.
 
* Additional information can be found in the [[SmartSimple]] wiki.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (126): Special – Color Code]]==
 
 
 
'''General Description''':
 
 
 
Used to display a colour box based on the value selected by the [[User|user]].
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (61): Special – Drawing Pad]]==
 
 
 
'''General Description''':
 
 
 
Used to display a drawing pad on which the [[User|user]] can draw and store the drawing into the field.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (100): Special – ePad Signature]]==
 
 
 
'''General Description''':
 
 
 
In conjunction with signature pad hardware, is used to capture a written signature and store in the field.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (38): Special – Hidden Value]]==
 
 
 
'''General Description''':
 
 
 
This field type is used to store a value that you do not want to display to the [[User|user]], but that you may wish to use in a calculated value field or a report.
 
 
 
'''Click on the link above for a more detailed description'''.
 
 
 
==[[Custom Field Type (31): Special – Timer]]==
 
 
 
'''General Description''':
 
  
Used to time the amount of time an [[Entity|entity]] is being edited.
+
====Same Fields with Tab set to Creation Details====
 +
[[Image:Cf5.png]] -->
  
'''Click on the link above for a more detailed description'''.
+
===Visibility Condition===
 +
The '''Visibility Options '''section when opening a Custom Field is available under the '''Permissions and Availability '''tab once the '''Advanced Options '''feature has been enabled.
  
==[[Custom Field Type (111): Store Values – System Variables]]==
+
::: [[File:Custom fields visibility.png|500px|border]]
 +
In order to enable '''Advanced Options, '''you must toggle on the feature from the top right of your page.
  
'''General Description''':
+
::: [[File:Advanced options.png|150px|border]]
 +
Whether or not a [[Custom Field|custom field]] is visible can be controlled using conditional statements in this box. You are able to set this visibility condition for new records based on the following options: '''Always Display, Hide on New Record, '''or '''Only Show on New Record.'''
  
Used to store an existing value from another field. The example above stores a value from a “parent” UTA entity to a level 2 item.
+
See [[Visibility Condition]] for more information.
  
'''Click on the link above for a more detailed description'''.
+
==Classic Options==
 +
The last tab available when opening a Custom Field record is usually the '''Classic Options '''section. 
  
==[[Custom Field Type (44): Text – Password Protected]]==
+
::: [[File:Custom fields classic options.png|750px|border]] 
 +
{| class="wikitable"
 +
|-
 +
||'''Tab Name'''
 +
||
 +
If you add a text value to the '''Tab Name, '''this field will be displayed on that tab. 
  
'''General Description''':
+
:* The tab name can be any text string.
 +
:* Custom Fields that are not associated with a tab will be displayed on a tab that is labelled '''Default.'''
 +
:* The '''Tab Name '''option only appears once the '''Advanced Options '''are enabled on the '''Classic Options '''tab. 
  
Creating a [[Password|password]] protected field will allow you to store data within the system that cannot be viewed by anyone, regardless of [[Role|role]] or permission, without supplying the correct [[Password|password]]. Before you can view or add a value to the field, you must enter the pass phrase and click the [[Password|password]] button.
+
|-
 +
||'''Custom HTML Tag'''
 +
||
 +
Use this field for additional attributes to the field HTML tag. For example, you can add HTML such as ''style="background-color"=00ff00 ''in order to color the background for this field box.
  
'''Click on the link above for a more detailed description'''.
+
'''Searchable - '''
  
==[[Custom Field Type (40): Text – Multiple Lines]]==
+
'''Read Only - '''
  
'''General Description''':
+
'''Enable [[KML]] - '''
  
Text box consisting of one or more lines of text.
+
'''Disable Quick Edit - '''Toggling on this option will not allow the user to modify this field using the system's [[Quick Edit]] functionality.
  
'''Click on the link above for a more detailed description'''.
+
'''Disable Field from Global Search - '''Toggling on this option will remove this field from any results that appear with the system's [[Global Search]] functionality. 
  
==[[Custom Field Type (42): Text – Rich Text]]==
+
|}
 +
===Custom Field References===
 +
This feature is intended to help determine the impact of a custom field change by highlighting where the custom field is referenced within the system.
 +
Each Custom field has a '''Search Reference'''--this button is found in the action bar, and can be identified by the magnifying glass icon.
 +
<!--
 +
[[Image:SearchReference1.png|border]]-->
  
'''General Description''':
+
When used, the feature will search references to this custom field via variable syntax in various areas, including:
  
Text box connected to the HTML Editor.
+
:* Other custom field options/visibility condition, including [[JavaScript Validation]], [[Visibility Condition]], [[Custom Field Type: Special – Calculated Value|calculated values]], etc.
 +
:* [[Template / Type Formula|Template formulas]]
 +
:* [[Submit buttons]]
 +
:* [[Submit Logic]]
 +
:* [[SmartCheck Validation]]
 +
:* [[Workflow Task]]
 +
:* [[Creating_a_Single_Step_Workflow#Connecting_Tasks|Workflow connectors]]
 +
:* Data class policy
 +
[[Image:SearchReference2.png|border]]
  
'''Click on the link above for a more detailed description'''.
+
===Import and Export Custom Fields===
 +
You can use the custom field '''Import''' and '''Export''' features to move or copy custom fields from one [[Entity|entity]] to another (or even another instance of [[SmartSimple]]). The custom fields are exported and importing by using [[XML]] format.
 +
<!--
 +
[[Image:Cf10.png|link=]]-->
  
==[[Custom Field Type (30): Text – Single Line]]==
+
To export a block of custom fields, simply click the ''Export'' button at the top of a list of custom fields. A window will pop up showing the custom field settings in XML format:
  
'''General Description''':
+
[[Image:ImportExportCustomFields.png|link=|500px]]
  
A single line of text.
+
The XML block for the entire set of custom fields in the list will be displayed. Individual custom fields are delineated by the tags. Simply copy the block of custom fields you want to copy (you can make edits, e.g. to the [[display order]] in a text editor), click on the ''Import'' button at the top of the list of custom fields where you want to place the new fields, paste the XML block into the blank text area, and confirm that you want to import the fields by clicking ''Import'' at the bottom of the Import pop-up.
  
'''Click on the link above for a more detailed description'''.
+
The majority of field settings will be included in the copied fields. Exceptions include:
  
==[[Custom Field Type (5): Title Bar – Multiple Columns]]==
+
:* any [[Field Permissions]]
 +
:* any [[Field Permission Matrix]] assigned to the original custom field
 +
:* any [[Value Stores To]] setting assigned on the original custom field
 +
:* the ''Description'' setting
 +
However, [[Field Permissions]] and [[Field Permission Matrix|Field Permission Matrices]] can be assigned to the new fields using the [[Batch Update]] feature.
  
'''General Description''':
+
As the [[custom field ID]] is unique to each custom field in the system, the custom field IDs will not be copied. Any newly created custom fields using the Export/Import feature will be assigned new custom field IDs.
  
This [[Custom Field|custom field]] will place a title bar above the fields that fall below it based on the order. This option can also control the layout of the fields by placing them in the desired number of columns by setting the "# of Columns".
+
Also see [[Custom Field Import Wizard]]
  
'''Click on the link above for a more detailed description'''.
+
===Custom Field Types===
 +
The full list of '''Custom Field Types''' can be found on the [[:Category:Custom Field Types|Custom Field Types]] page.
  
[[Category:System Management]][[Category:Custom Fields]]
+
==See Also==
 +
:* [[Batch Update Custom Field Settings]]
 +
:* [[Reporting on Custom Fields]]
 +
[[Category:Custom Fields]]

Latest revision as of 08:46, 14 April 2023


Construction warning.png Please note that this page is currently under construction. There is more information to come.


Overview

Custom Field is the basic unit of data storage, created on an as-needed basis for your system, and is associated with a SmartSimple entity such as a contact, organization, role, or activity. These fields can be accessed and controlled from either the Global Settings area of your system, or on the Entity-based Settings page within a .

New custom fields are added on a regular basis - we currently have over 50 field types that can be used to capture and store data. For a full list of Custom Fields, see Types of Custom Fields. You can also check the Upgrades section of our Wiki for continuous notice of the latest field types. 

Custom Fields are used in addition to Standard Fields, which are automatically built into your system (for example, Name or Address are typical Standard Fields). While Custom Fields can be added, removed, and customized, as a general rule Standard Fields cannot be changed, although they might be renamed or modified. 

All fields display data in configurable ways: for example, they can be grouped into tabs or displayed in multiple columns to avoid cluttering the page. 

  • The maximum number of custom fields that can be displayed on a single page is 400 total.

Accessing Custom Fields

1. Click the 9-square menu icon on the top right of your page.

052919 MenuIcon.png 

2. Under the heading Configuration, select Global Settings.

The hyperlink to Custom Fields will be available under each tab. Clicking the Custom Fields link under a specific tab will bring you to the custom fields that are associated with the purpose of that tab - for example, if you click on the Custom Fields under the User tab, this will bring you to a list of all custom fields specifically associated with users, both internal and external

System - Custom Fields A list of all custom fields from all object types in the system.
Organizations - Custom Fields Create and manage custom fields for Branch (Internal organization on the organization hierarchy) and Organization (External)
Users - Custom Fields Create and manage custom fields for users, both Internal Staff and External Contacts
Associations - Custom Fields Create and manage custom fields for associations, which can be between companies and users or company-to-company 
Transactions - Custom Fields Create and manage custom fields for Transactions and transactions attributions
All custom fields for system objects
Custom fields for Organizations under the Organizations tab

When you click into a Custom Fields hyperlink from the Global Settings area, you will be brought to a list display of all available custom fields relating to that part of the system. In order to modify a Custom Field, you can simply select the pencil icon to the left side of the custom field name, as shown below:

Edit custom field.png
  • Using the Search function on the top right, you can search through all Object Entities or through the fields of specific s. Simply select or deselect to control your results.
  • Tip: A Search-based strategy for troubleshooting is to clear your past search, select All Object Entities within the search bar, then click on the Last Modified field in the list view so that it is in descending Sort Order and you can see the date that a custom field was changed, added, etc. 
  • You can also access all deleted fields by clicking into the second tab. There is no time limit within the system that removes deleted records; therefore, you can simply select and restore or purge these previously deleted fields.
  • There should be no reason to purge as Custom Fields do not take up much space within the system.
  • When you restore fields, there is no loss of data. 

Configuration - Essentials

This page will serve as the main repository for setup information that is shared between most field types. To find setup options that are specific to a certain field type, look into the Wiki page for that field type itself. 

Common Custom Field Functions

On the top left of the Custom Field record will be a row of buttons, each with different functions relating to the field.

Custom field menu buttons.png 

The following table describes the functionality of each button from left to right: 

Custom Fields list Clicking this list chart icon will bring you to the list of all custom fields available in this part of the system. For example, if you are on a Custom Field that is found under the Organizations tab of Global Settings, you will be brought to a comprehensive list of all custom fields relating to Organizations. 

New Custom Field 

(+ icon)

Clicking this plus icon will allow you to create a New Custom Field in this part of the system. To understand how to create a new custom field by appropriately filling out the different settings, keep on reading the sections in this page below. 

Field Data 

(stack of coins icon) 

Clicking this will open up a page that displays all the values that have been saved to the field.

Custom Field Data consists of two general types: text type fields (saved as a text string) and object type fields (consisting of any files such as documents or images). 

Update History 

(reload icon)

Clicking this will open up a page with a list of all of the updates to field settings that have been made on this field.

Search Reference

(magnifying glass icon

Clicking this will display all of the locations where the custom field is referenced in the system. For more information, see Custom Fields – General Information#Custom Field References

Fields are fully searchable for any related application. For example, role-level fields can be searched through the Search People feature or any application that provides access to contact data. You can also search and replace these values in bulk by using the Field Data button and specifying the old and new value required. 

The following settings are common to nearly all Custom Field types:

General Settings

The General Settings will appear right when you open up a Custom Field to edit.

Custom fields general settings.png
Option Description Format
Custom Field ID The unique ID number associated with the custom field.
  • automatically generated by the system as a number value and is displayed to the right when viewing the list of custom fields
Not Applicable
Field Type The list of available Field Types.
  • different types may have different options
@fieldtype@
Field Name The name of the field, used internally to reference the user's input;
  • mandatory and can be up to 255 characters in length.
  • should not include special characters that could be misinterpreted by the browser.
@fieldname@
Caption  The leading question or prologue before the field.
  • if left blank, the Field Name will be displayed as the caption (excluding List View).
@caption@
Display Order  The order (relative to other fields) in which this field is displayed.
  • this setting determines the order that the field will be displayed on the page. The first field that is added to an entity will use a display order of 100.
  • additional fields that you add will automatically increase the display order by increments of 100.
  • if you wish to insert a field between two fields you can set the display order to a number that will position the field where required.
  • you can change the display order by setting the display order to a different number. For example, if you set the display order on a field to 5000 then the next field added will automatically become 5100.
@displayorder@
Description Definition and general description of the custom field. Will not be displayed. @description@

Display Order with Related Entities

If you add custom fields to the basic contact entity and then add fields to roles associated with contacts, you will need to take care, as the fields will become mixed if they have the same number sequence.

The following table outlines where you need to be careful:

Entity Related Entity
Contact Roles
Companies Categories
UTA Level 1 Entities UTA Level 1 Template Entities

You should start the number sequence for these types of related fields at some higher level. For example, role 1 starts at 5000, role 2 starts at 8000.

Display & Formatting

The Display & Formatting section of Custom Fields are found by scrolling down the first tab of General Settings when you edit a Custom Field.

Custom fields display and formatting.png
Option Description
Caption Location 

Determines the positioning and visibility of the caption relative to the field. Options include: Left of Field, Above Field, No Caption, Hide Caption.

Instructions Text input here displays under the caption. Even if a caption has Hide Caption enabled, any defined instructions will continue to be displayed above the input.
Placeholder Text

Text input here displays within the text box as placeholder text that will disappear once the user clicks into the field to enter content.

  • Note: this function is different from Default Text, as Placeholder text will not create content to be stored within the field.
Tool Tip When the user hovers their mouse pointer over the question mark next to a field, the text in this section will appear.
Classify as Personal Data For use in identifying personal data.
SmartField View Include or exclude this field from SmartField View (@SmartFields@) or only display this field for SmartField Views. See SmartField View for further details.
SmartFields PDF Formatting PDF formatting option when rendered from SmartField View.
Width / Max Width Width of input box - options include Full, Large, Medium, Small. 
Number of Columns Determines the number of columns to be used for display purposes.
Align Control the justification of the text within the field - Left, Center, Right. 
Number Format Control the format of the data when the field is displayed in View mode - for example, Comma, Currency, or Percent.
Number Precision Control the precision of the numerical amount displayed - for example, Whole Number, number of Decimals, or Nearest Ten. 
Thumbnail Width Determines the width of the image's thumbnail, in pixels.
Thumbnail Height Determines the height of the image's thumbnail, in pixels.
Sort Order Sets the sorting order for files uploaded to the field. Choices are: file name, file size and upload date.
Stroke Colour Allows you to set the color of the stroke.
Button Label Specify what a custom button will be called.
Apply Format in Edit Mode Carry over the field data formatting in Edit mode.
Fixed Column Widths Establishes a uniform width, if multiple columns are specified. Used with Layout fields.

Validation

The Validation section is under the General Settings tab and looks similarly to this: 

Custom fields validation.png
Option Description
Mandatory Selecting this option means that this field is required and must be completed. 
Appear Mandatory Makes the field appear as though it is a required field. Typically used in conjunction with browser scripts, JavaScript Validation or Submit Logic that perform validation. The field from a user perspective will normally appear with a red asterisk (*) in order to indicate that the field is mandatory. 
Custom Validation Specify validation based on Javascript syntax.
Failed Validation Message Input the message that will be displayed if validation fails.
Minimum Length Input the lowest required amount of characters as a restriction on the user's input into the field; they must insert at least this minimum of characters in order for the field to be successfully validated. A good use-case for this would be a minimum of 9 characters for a mandatory Phone Number field.
Maximum Length Input the highest allowed amount of characters as a restriction on the user's input into the field. They must insert less than this maximum of characters (and, if required, more than the minimum) in order for the field to be successfully validated. A good use-case for this would be a maximum of 6 characters for a Postal Code field for a Canadian address.
Show Counter Toggling on this option will enable a counter that counts down the number of characters that are available for the user to input before reaching the maximum. It will also display if the user has exceed the maximum by going into negative digits.
Show Words Toggling on this option will enable the maximum and minimum lengths, if inputted, to be restricted by the amount of individual words rather than characters.
Exceeded Maximum Message Toggling on either Show Counter or Show Words will open this option. Insert the text that you want to be displayed to the user if they exceed the maximum length for either characters or words. 

Feature Options

The Feature Options section of Custom Fields settings is also found under the General Settings tab when you are editing a Custom Field. The Feature Options section will look something like this:

Custom fields feature options.png
Option Description
Track Changes Enables the logging of all changes to any specified Custom Fields or Standard Fields within the system, including within a Universal Tracking Application, contact, company or transaction record.
Show Display Value in List Views Enabling this option will display the display value; by default, the stored value is shown when fields are referenced in List Views.
Enable Multiple Select Enables users to select multiple values from the listed values.
Enable Map Service Displays the map icon next to the field name. This icon will launch the user’s selected map service and display a map of the content of the field – provided a valid address is stored in the field.
Enable Translation Service Allows for language translation of data entered into text fields, achieved by integration with Google Translate.

Value Storage

The Value Storage section is the final area of General Settings when editing a Custom Field. It will look like this: 

Custom fields value storage.png
Option Description
From Custom Field(s): Displays the name of the source field that the current field is pulling data from; refer to Value Stores To.
To Custom Field: The field that this field will be sending data to; refer to Value Stores To.

Permissions & Availability

The second tab available when opening a Custom Field is usually the Permissions & Availability section. Although the sectioning of permissions and availability will differ depending on what type of Custom Field it is, as well as to what part of the system it is attached to, the Permissions & Availability options might look something like this: 

Custom fields permissions and availability.png

Access to a custom field is controlled by permissions. These can be found and set in any custom field, on the Permissions and Availability tab. You can set only certain roles to be able to see/edit a field, or you can do the same thing with statuses. An example would be denying the Applicant role permission to see the Decision custom field (as this would reveal pre-emptively whether or not their application has been approved or denied). 

Role - Field Permissions

Allow View Field: Click into this text box to select which roles will have the permission to view this field. When they open up a record in the system that has this field, they will be able to see the field and any content already inputted into it.

Allow Modify Field: Click into this text box to select which roles will have the permission to modify this field. When they open up a record in the system that has this field, they will be able to see the field as well as modify any content that is inputted into it, or put content if there is nothing inputted already.

Deny View Field: Click into this text box to select which roles will be denied permission to view this field. If they open up a record in the system with this field attached, they will not be able to see it on the record details.

Deny Modify Field: Click into this text box to select which roles will be denied permission to modify this field. If they open up a record in the system with this field attached, they will be able to view this field but not have the ability to modify its content at all. 

Organizations Status - Field Permissions

Allow View Field: Click into this text box to select which statuses will have permission to view this field. In this case the status must be relating to the organization - that is, only an organization that is in the selected statuses will be able to see this field when opening a record.

Allow Modify Field: Click into this text box to select which statuses will have permission to modify this field.

'Deny View Field: Click into this text box to select which statuses will be denied permission to view this field. For example, an organization that is in Inactive 'Status might be denied permission to view fields as there is no need for them to know that information.

Deny Modify Field: Click into this text box to select which statuses will be denied permission to modify this field.

Category - Field Availability

Include Field For: Click into this text box to select which organization categories will have permission to have this field to fill out. 

Exclude Field For: Click into this text box to select which organization categories will not have permission to have this field to fill out. 

See Role Field Permissions , Field Permissions, or Status Field Permissions for more information.

Visibility Condition

The Visibility Options section when opening a Custom Field is available under the Permissions and Availability tab once the Advanced Options feature has been enabled.

Custom fields visibility.png

In order to enable Advanced Options, you must toggle on the feature from the top right of your page.

Advanced options.png

Whether or not a custom field is visible can be controlled using conditional statements in this box. You are able to set this visibility condition for new records based on the following options: Always Display, Hide on New Record, or Only Show on New Record.

See Visibility Condition for more information.

Classic Options

The last tab available when opening a Custom Field record is usually the Classic Options section. 

Custom fields classic options.png 
Tab Name

If you add a text value to the Tab Name, this field will be displayed on that tab. 

  • The tab name can be any text string.
  • Custom Fields that are not associated with a tab will be displayed on a tab that is labelled Default.
  • The Tab Name option only appears once the Advanced Options are enabled on the Classic Options tab. 
Custom HTML Tag

Use this field for additional attributes to the field HTML tag. For example, you can add HTML such as style="background-color"=00ff00 in order to color the background for this field box.

Searchable - 

Read Only - 

Enable KML

Disable Quick Edit - Toggling on this option will not allow the user to modify this field using the system's Quick Edit functionality.

Disable Field from Global Search - Toggling on this option will remove this field from any results that appear with the system's Global Search functionality. 

Custom Field References

This feature is intended to help determine the impact of a custom field change by highlighting where the custom field is referenced within the system. Each Custom field has a Search Reference--this button is found in the action bar, and can be identified by the magnifying glass icon.

When used, the feature will search references to this custom field via variable syntax in various areas, including:

SearchReference2.png

Import and Export Custom Fields

You can use the custom field Import and Export features to move or copy custom fields from one entity to another (or even another instance of SmartSimple). The custom fields are exported and importing by using XML format.

To export a block of custom fields, simply click the Export button at the top of a list of custom fields. A window will pop up showing the custom field settings in XML format:

ImportExportCustomFields.png

The XML block for the entire set of custom fields in the list will be displayed. Individual custom fields are delineated by the tags. Simply copy the block of custom fields you want to copy (you can make edits, e.g. to the display order in a text editor), click on the Import button at the top of the list of custom fields where you want to place the new fields, paste the XML block into the blank text area, and confirm that you want to import the fields by clicking Import at the bottom of the Import pop-up.

The majority of field settings will be included in the copied fields. Exceptions include:

However, Field Permissions and Field Permission Matrices can be assigned to the new fields using the Batch Update feature.

As the custom field ID is unique to each custom field in the system, the custom field IDs will not be copied. Any newly created custom fields using the Export/Import feature will be assigned new custom field IDs.

Also see Custom Field Import Wizard

Custom Field Types

The full list of Custom Field Types can be found on the Custom Field Types page.

See Also