Custom Fields – General Information

From SmartWiki
Jump to: navigation, search


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 Universal Tracking Application™.

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 Universal Tracking Application™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