Difference between revisions of "Custom Fields – General Information"

Revision as of 16:23, 11 October 2018

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

General Description

A custom field is created on an as-needed basis, and is associated with a SmartSimple entity such as a contact, company, role, or activity. These fields can be accessed and controlled via links on the Global Settings page or on the Entity Settings Page within a UTA. New custom field types are added on a regular basis, so check the upgrade notes in the Wiki for the latest field types.

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

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

• General Settings
• Display & Formatting
• Validation
• Feature Options
• Value Storage

General Settings

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

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:

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.

Validation

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

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:

Value Storage

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

Permissions & Availability

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.

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

Visibility Condition

Whether or not a custom field is visible can be controlled using conditional statements in this box. (Appears on the Permissions and Availability tab, once the Advanced Options are enabled.)

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

Tab Name

• If you add a text value to the tab Name, the 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 named Default.
• The Tab Name option appears once the Advanced Options are enabled, on the Classic Options tab.

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:

• Other custom field options/visibility condition, including JavaScript Validation, Visibility Condition, calculated values, etc.
• Template formulas
• Submit buttons
• Submit Logic
• SmartCheck Validation
• Workflow Task
• Workflow connectors
• Data class policy

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:

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:

• 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 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

• Batch Update Custom Field Settings
• Reporting on Custom Fields