Difference between revisions of "Creating Custom Fields"

From SmartWiki
Jump to: navigation, search
Line 2: Line 2:
  
 
===Overview===
 
===Overview===
−
Custom fields can be created at any time, and associated with any one of a list of objects: UTA records (at any level), contacts, companies, and roles. They can be accessed and controlled via links on the Global Settings page or on the Entity Settings Page within a UTA, and that's also where they can be created.
+
Custom fields can be created at any time, and associated with any one of a list of objects: UTA records (at any level), contacts (Users), companies (Organizations), and roles. They can be accessed and controlled via links on the Global Settings page or on the Entity Settings Page within a UTA, and that's also where they can be created.
  
 
====Locating and Viewing a Custom Field====
 
====Locating and Viewing a Custom Field====
−
To see a list of all custom fields, navigate to Global Settings > System tab > Custom Fields. From here, you can search for, and view, any custom field; click on any of the column headings to sort by that column.<br /> [Example: click on Last Modified to see the most recently modified field.] If you already know to which type of object the field is attached, you can search directly on either the applicable settings page under '''Configuration''', or on the entity settings page within the appropriate UTA.
+
To see a list of all custom fields, navigate to Global Settings > System tab > Custom Fields. From here, you can search for and modify any custom field; click on any of the column headings to sort by that column.<br />  
  
−
* Example: for an Organization custom field, you can navigate directly to the Configuration icon > Global Settings > Organizations > Custom Fields.
+
This page in Global Settings is also where you can view all Deleted Fields--click on the Deleted Fields button in the top left-hand corner. From the Deleted Fields list view, you can either '''Restore''' or '''Purge''' any field: select the checkbox next to the desired field, then click either the '''Restore''' (clock) or '''Purge''' (garbage bin) button, and when the confirmation window appears, select 'yes' or 'no'.
−
* Example 2: for a UTA level 2 custom field, you can access the custom fields from within the UTA itself. To do this: select the cogwheel to access the UTA Settings, then select the level 2 tab, followed by the Custom Fields link.
 
−
 
 
−
This page is also where you can view all Deleted Fields--simply click on the Deleted Fields button in the top left-hand corner. From the Deleted Fields list view, you can either '''Restore''' or '''Purge''' any field: just select the checkbox next to the desired field, then click either the '''Restore''' (clock) or '''Purge''' (garbage bin) button, and when the confirmation window appears, select 'yes' or 'no'.
 
  
 
====Creation and Setup====
 
====Creation and Setup====
−
When creating a new custom field, it's a good idea to keep in mind the field's intended function: what kind of data will it be handling, and who will need to use it?
+
When creating a new custom field, consider its intended function: what kind of data will it contain, and who will need to use it?
−
These answers will directly affect how the field is set up.
+
These answers will directly affect field configuration.
  
−
To create a new custom field, navigate to the appropriate location (UTA, role, organization settings or Contact settings) and then select the New Field button, which looks like a plus sign: '+'.
+
To create a new custom field, navigate to the appropriate location (UTA, role, Organization settings or Contact settings) and then select the New Field button, which looks like a plus sign: '+'.
 
The New Custom Field screen will then appear.
 
The New Custom Field screen will then appear.
 
The below table shows where each associated custom field can be created:
 
The below table shows where each associated custom field can be created:
Line 26: Line 23:
 
|-
 
|-
 
||UTA: L1, 2 or 3
 
||UTA: L1, 2 or 3
−
||UTA settings > Object Tab > Custom Fields
+
||Navigate to the desired UTA > Configuration Settings > L1, 2, or 3 Object Tab > Custom Fields
 
|-
 
|-
 
||Role
 
||Role
Line 38: Line 35:
 
|}
 
|}
  
−
Only three values on this screen must be populated before you can save your new field:
+
Only two values on this screen must be populated before you can save your new field:
−
* Field ID (populated automatically)
+
 
 
* Field Type
 
* Field Type
 
* Field Name
 
* Field Name
  
−
'''Field Type''': this choice will determine how the field will handle (and possibly manipulate) the data it will hold. For a complete list of all custom field types, see the table on the [[Custom Fields]] page.<br />
+
'''Field Type''': this choice will determine how the field will handle and display the data it will hold. For a complete list of all custom field types, see the table on the [[Custom Fields]] page.<br />
 
'''Note''': to see all available field types when creating a new custom field, enable '''Advanced Options''' on the top right of the display.<br />
 
'''Note''': to see all available field types when creating a new custom field, enable '''Advanced Options''' on the top right of the display.<br />
−
'''Field Name''': This should be unique (to simplify locating it at a later date) and can only contain alphanumeric, underscore, or dash characters.
+
'''Field Name''': This should be unique (to simplify locating and referencing it at a later date) and can only contain alphanumeric, underscore, or dash characters.
−
Once these three settings are populated, you can '''Save''' your new field, or add further specifications.
+
Once these settings are populated, you can '''Save''' your new field, or add further specifications.
  
 
'''Note''': please visit [[Custom Fields General Information]] to see the more common custom field settings.
 
'''Note''': please visit [[Custom Fields General Information]] to see the more common custom field settings.
Line 203: Line 200:
  
 
[[Image:Creat19.png]]-->
 
[[Image:Creat19.png]]-->
−
<!--<span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name=" Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="  Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="  Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="    Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="    Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="      Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="      Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="        Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="        Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="          Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="          Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="            Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="            Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="              Template:Move to Common Level" data-bs-type="template" data-bs-id="1">{{               Template:Move to Common Level }}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>-->
+
<!--<span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name=" Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="  Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="  Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="    Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="    Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="      Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="      Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="        Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="        Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="          Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="          Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="            Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="            Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="              Template:Move to Common Level" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="              Template:Move to Common Level" data-bs-type="template" data-bs-id="1">{{               Template:Move to Common Level }}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>-->
 
[[Category:System Management]][[Category:Custom Fields]]
 
[[Category:System Management]][[Category:Custom Fields]]

Revision as of 12:57, 3 October 2018


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

Overview

Custom fields can be created at any time, and associated with any one of a list of objects: UTA records (at any level), contacts (Users), companies (Organizations), and roles. They can be accessed and controlled via links on the Global Settings page or on the Entity Settings Page within a UTA, and that's also where they can be created.

Locating and Viewing a Custom Field

To see a list of all custom fields, navigate to Global Settings > System tab > Custom Fields. From here, you can search for and modify any custom field; click on any of the column headings to sort by that column.

This page in Global Settings is also where you can view all Deleted Fields--click on the Deleted Fields button in the top left-hand corner. From the Deleted Fields list view, you can either Restore or Purge any field: select the checkbox next to the desired field, then click either the Restore (clock) or Purge (garbage bin) button, and when the confirmation window appears, select 'yes' or 'no'.

Creation and Setup

When creating a new custom field, consider its intended function: what kind of data will it contain, and who will need to use it? These answers will directly affect field configuration.

To create a new custom field, navigate to the appropriate location (UTA, role, Organization settings or Contact settings) and then select the New Field button, which looks like a plus sign: '+'. The New Custom Field screen will then appear. The below table shows where each associated custom field can be created:

Entity Location
UTA: L1, 2 or 3 Navigate to the desired UTA > Configuration Settings > L1, 2, or 3 Object Tab > Custom Fields
Role Menu Icon > Roles and Security > User Roles > Edit Role > Custom Fields tab
Organization Menu Icon > Global Settings > Organizations tab > Custom Fields
Contact/User Menu Icon > Global Settings > Users tab > Custom Fields

Only two values on this screen must be populated before you can save your new field:

  • Field Type
  • Field Name

Field Type: this choice will determine how the field will handle and display the data it will hold. For a complete list of all custom field types, see the table on the Custom Fields page.
Note: to see all available field types when creating a new custom field, enable Advanced Options on the top right of the display.
Field Name: This should be unique (to simplify locating and referencing it at a later date) and can only contain alphanumeric, underscore, or dash characters. Once these settings are populated, you can Save your new field, or add further specifications.

Note: please visit Custom Fields General Information to see the more common custom field settings.

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Creating_Custom_Fields&oldid=33496’