Changes

Custom Fields – General Information

1,407 bytes added, 14:46, 23 August 2018
no edit summary
__TOC__
 
==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===
Many areas in SmartSimple are comprised mainly of custom fields--such as the Universal Tracking Application--so understanding their proper setup and use is vital in order to create an easy-to-use instance that addresses your organization's needs. There are over 50 field types that you can use to capture and store data; these can be grouped on 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. New fields can be created at any time, without affecting current data.
The following settings are common to almost all [[Custom Fields|Custom Field]] types:
===Role Field Permissions and Status Field Permissions===
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
<!--[[Image:Cf8.png]]-->
<!--
These fields can consist of files of any type such as documents or images. Document type fields are searchable provided the '''File Index''' option is selected (this option is only available for these types of fields). -->
===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.<!--[[Image:SearchReference1.png|border]]-->
Each Custom field has a '''Search Reference''' [[Image:SearchReference1.png|border]] 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]], [[Custom Field Type: Special – Calculated Value|calculated values]], etc.
===Import and Export Custom Fields===
You can use the custom field '''Import''' and '''Export''' features to move or copy custom fields from one [[Entity|entity]] to another (or even another instance of [[SmartSimple]]). The custom fields are exported and importing by using [[XML]] format.
<!--[[Image:Cf10.png|link=]]-->
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:
[[Image:ImportExportCustomFields.png|link=|500px]]
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:
Smartstaff, administrator
421
edits