Changes

Custom Fields – General Information

3,465 bytes added, 20:23, 11 October 2018

no edit summary

===Overview===

This page will serve as the main repository for setup information that is shared between most field types--setup options that are specific to a certain field type will be explained on the field page itself.

===Common Field Options===

<!--

{{ FieldOptionsINFO }}{{ DisplayINFO }}{{ ValidationINFO }}{{ FeatureOptionsINFO }}{{ ValueStorage }}

-->

The following settings are common to nearly all [[Custom Fields|Custom Field]] types:

* [[#General Settings|General Settings]]* ~~'''Custom Field ID'''~~[[#Display & Formatting|Display & Formatting]]* ~~'''Field Type'''~~[[#Validation|Validation]]* ~~'''Field Name'''~~[[#Feature Options|Feature Options]]* ~~'''Caption'''~~[[#Value Storage|Value Storage]]* '''Display Order'''{{FieldOptionsINFO}}{{DisplayINFO}}{{ValidationINFO}}{{FeatureOptionsINFO}}* '''Description'''{{ValueStorageINFO}}

<!--

[[Image:Cf1.png]]-->

<!--===Field Name and Field ID===

* The field name is mandatory and can be up to 255 characters in length.

* The name should not include special characters that could be misinterpreted by the [[Browser|browser]].

<!--

[[Image:Cf6.png]] -->

<!--'''Referencing Field Names and Field IDs in other Custom Field Types'''

You can reference fields by name or by ID in other fields. The following field types support this type of referencing:

* '''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.-->==Permissions & Availability==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.

See [[Role Field Permissions]] or [[Status Field Permissions]] for more information.

<!--'''Special Field Name Syntax'''

* 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.

-->

<!--'''Field Type'''

The field type is used to define the characteristics of the field. There are over '''50''' field types currently available.

===[[display order|Display Order]]===

||Categories

|-

||UTA {{l1}} Entities

||UTA Level 1 Template Entities

|}

* [[Field Data]] - displays all the values that have been saved to the field.

* [[Update History]] - displays all the updates to field settings.-->

<!--* Search Reference - displays all locations where the custom field is referenced in the system.

===Tab Name===

* 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.

* The Tab Name option appears once the Advanced Options are enabled, on the Classic Options tab.-->

<!--

====Fields with No Tab Set====

See [[Visibility Condition]] for more information.

==Classic Options==

===Common Custom Field Settings===

Each custom field contains buttons at the top that link to the following functions:

* [[Field Data]] - displays all the values that have been saved to the field.

* [[Update History]] - displays all the updates to field settings.

* Search Reference - displays all locations where the custom field is referenced in the system. (see '''Custom Field References''', farther down this page.)

===~~Role Field Permissions and Status Field Permissions~~Tab Name===~~Access~~ * If you add a text value to ~~a [[Custom Field|custom~~ the tab Name, the field~~]] is controlled by permissions~~will be displayed on that tab. ~~These~~ * The tab name can be ~~found and set in~~ any ~~custom field, on the Permissions and Availability~~ text string.* Custom fields that are not associated with a tab~~. You can set only certain roles to~~ will be ~~able to see/edit~~ displayed on a ~~field, or you can do the same thing with statuses~~tab named Default. ~~An example would be denying~~ * The Tab Name option appears once the ~~Applicant role permission to see~~ Advanced Options are enabled, on the ~~Decision custom field~~Classic Options tab. ~~See [[Role Field Permissions]] or [[Status Field Permissions]] for more information~~

<!--

[[Image:Cf8.png]] -->

Nancy Sabo

Smartstaff, administrator

421

edits

Changes

Custom Fields – General Information

SmartWiki