Custom field settings determine how a custom field behaves, displays, and validates data in SmartSimple.
It is recommended that global administrators enable the new syntax. Locate the System Options section in Global Settings, and toggle Enable New Variable Syntax on.
Common Custom Field Functions
The action bar at the top left of a custom field record provides the following functions, listed from left to right.
| Button | Description |
|---|---|
| Custom Fields list | Opens the list of all custom fields in the current system section. For example, when viewed under the Organizations tab in Global Settings, it displays all custom fields related to organizations. |
| New Custom Field | Starts the creation of a new custom field in the current system section. |
| Field Data | Opens a page showing all values stored in the field. Field data falls into two categories: text type fields, stored as text strings, and object type fields, such as documents or images. |
| Update History | Opens a page listing all updates made to the field's settings. |
| Search Reference | Displays all locations in the system where the field is referenced. Fields are searchable across the system and related features. For example, role-level fields can be searched using Search People. Bulk search and replace can be performed through the Field Data button. |
Custom Field Groupings
The following custom field groupings are available from Global Settings:
| Grouping | Description |
|---|---|
| System - Custom Fields | A comprehensive list of all custom fields across all object types in the system. |
| Organizations - Custom Fields | Custom fields for Branch, the internal organizations within the organizational hierarchy, and Organization, the external entities. |
| Users - Custom Fields | Custom fields for users, including both internal Staff and external Contacts. |
| Associations - Custom Fields | Custom fields for associations, which may exist between companies and users or between companies. |
| Transactions - Custom Fields | Custom fields related to transactions and transaction attributions. |
General Settings
The General Settings section appears immediately when a custom field is opened for editing.
| Option | Description | New Syntax | Old Syntax |
|---|---|---|---|
| Custom Field ID | The unique identifier assigned to the custom field. It is generated automatically as a numeric value and displayed to the right in the custom fields list. | Not applicable | Not applicable |
| Field Type | The selected field type. Different field types may offer different options. | {{fieldtype}} | @fieldtype@ |
| Field Name | The internal name used to reference the input. This field is mandatory and may contain up to 255 characters. It should not include special characters that browsers might misinterpret. | {{fieldname}} | @fieldname@ |
| Caption | The introductory text or question displayed before the field. If left blank, the field name appears as the caption, except in List View. | {{caption}} | @caption@ |
| Display Order | Determines the relative position of the field among others on the page. The first field added to an entity is assigned a display order of 100, and subsequent fields increase in increments of 100. To insert a field between existing fields, assign an intermediate value. | {{displayorder}} | @displayorder@ |
| Description | A definition or description of the custom field. This information is not displayed to end users. | {{description}} | @description@ |
Display
The Display section is available by scrolling down within the General Settings tab. Settings differ depending on the custom field type.
| Option | Description |
|---|---|
| Caption Location | Sets the position and visibility of the caption. Options include Left of Field, Above Field, No Caption, and Hide Caption. This option was formerly called Label Display. |
| Instructions | Text displayed below the caption. It appears above the input field even when the caption is hidden. |
| Placeholder Text | Text shown inside the input box that disappears once the user interacts with the field. Unlike default text, it does not populate the field with stored content. |
| Tool Tip | Text displayed when the user hovers over the question mark icon next to the field. |
| Classify as Personal Data | Identifies fields that contain personal data. |
| Width / Max Width | Sets the width of the input box. Options include Full, Large, Medium, and Small. |
| Number of Columns | Sets how many columns are used for display. |
| Align | Controls text alignment within the field: Left, Center, or Right. |
| Number Format | Sets the format of numerical data in View mode, such as Comma, Currency, or Percent. |
| Number Precision | Sets the precision of numerical values, such as Whole Number, a set number of decimals, or Nearest Ten. |
| Thumbnail Width | Sets the width of image thumbnails in pixels. |
| Thumbnail Height | Sets the height of image thumbnails in pixels. |
| Sort Order | Sets the sort order for uploaded files: file name, file size, or upload date. |
| Stroke Colour | Sets the stroke color. |
| Button Label | Sets the label for a custom button. |
| Apply Format in Edit Mode | Applies field data formatting while in Edit mode. |
| Fixed Column Widths | Sets uniform column widths when multiple columns are used. Used with Layout fields. |
SmartField
The following options apply within the SmartField section of General Settings.
| Option | Description |
|---|---|
| SmartField View | Sets whether the field is included in, excluded from, or shown only within SmartField View. |
| SmartFields PDF Formatting | Sets PDF formatting options when the field is rendered from SmartField View. |
Validation
The Validation section is located under the General Settings tab.
| Option | Description |
|---|---|
| Mandatory | Designates the field as required. It must be completed. |
| Appear Mandatory | Makes the field appear required, typically alongside browser scripts, JavaScript Validation, or Submit Logic. A red asterisk indicates the mandatory status to the user. |
| Custom Validation | Sets validation rules using JavaScript syntax. |
| Failed Validation Message | The message displayed if validation fails. |
| Minimum Length | The minimum number of characters required for the input. For example, a minimum of 9 characters may suit a mandatory Phone Number field. |
| Maximum Length | The maximum number of characters permitted for the input. For example, a maximum of 6 characters may suit a Postal Code field in a Canadian address. |
| Show Counter | Displays a counter showing the remaining characters before the maximum, including negative values when the maximum is exceeded. |
| Show Words | Applies the maximum and minimum lengths by number of words rather than characters. |
| Exceeded Maximum Message | Available when Show Counter or Show Words is enabled. The message displayed when the user exceeds the maximum length. |
Feature
The Feature section is located under the General Settings tab.
| Option | Description |
|---|---|
| Track Changes | Logs all modifications to specified custom or standard fields, including within a UTA/module, contact, company, or transaction record. |
| Show Display Value in List Views | Shows the display value in List Views. By default, the stored value is displayed when fields are referenced. |
| Enable Multiple Select | Allows users to select multiple values from the available options. |
| Enable Map Service | Displays a map icon next to the field name. Clicking it opens the selected map service using a valid address stored in the field. |
| Enable Translation Service | Provides language translation of entered text through integration with Google Translate. |
Value Storage
The Value Storage section is the final area within General Settings.
| Option | Description |
|---|---|
| From Custom Field(s) | Displays the source field from which the current field retrieves data. |
| To Custom Field | Indicates the field to which this field sends data. |
Permissions & Availability
The Permissions & Availability tab controls access to a custom field. The organization of options varies by field type and by the component the field is attached to. Permissions can be assigned to roles or statuses.
| Setting Group | Description |
|---|---|
| Role - Field Permissions |
Allow View Field selects roles that can view the field. Allow Modify Field selects roles that can view and edit it. Deny View Field selects roles that cannot see the field. Deny Modify Field selects roles that can view but not edit it. |
| Status - Field Permissions |
Allow View Field selects statuses that can view the field. Allow Modify Field selects statuses that can modify it. Deny View Field selects statuses denied view access, such as organizations with an Inactive status. Deny Modify Field selects statuses denied modify access. |
| Category - Field Availability |
Include Field For selects organization categories that can access and complete the field. Exclude Field For selects categories that cannot. |
Visibility Condition
The Visibility section is available under the Permissions & Availability tab. Conditional statements entered here control when a custom field is displayed. See Visibility Conditions Syntax Reference for more information on syntax options in the Visibility Conditions field.
Visibility for new records can be set to one of the following: Always Display, Hide on New Record, or Only Show on New Record.
Classic Options
The Classic Options tab is typically the final tab on a custom field record.
| Option | Description |
|---|---|
| Tab Name | Assigns the custom field to the named tab. The tab name may be any text string. Fields not assigned to a tab appear on a tab labeled Default. |
| Custom HTML Tag |
Adds attributes to the field's HTML tag. For example, Related options include Searchable, Read Only, Enable KML, Disable Quick Edit which prevents editing through Quick Edit, and Disable Field from Global Search which excludes the field from Global Search results. |