Changes

Custom Fields – General Information

45,613 bytes added, 12:46, 14 April 2023

no edit summary

~~==Custom Fields – Standard Properties==~~{{Banner-UnderConstruction}}

~~The following settings are common to all custom field types.~~

~~[[Image:Cf1.png]]~~

=Overview==A '''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 [[User|contact]], [[Organization|organization]], [[User Role|role]], or activity. These fields can be accessed and controlled from either the [[Global Settings]] area of your system, or on the Entity-based '''~~Display Order~~Settings '''~~===~~page within a {{UTA}}.

* This setting determines 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 [[:Category:Custom Fields#Types of Custom Fields|Types of Custom Fields]]. You can also check the ~~order that~~ [[Upgrades]] section of our Wiki for continuous notice of the latest field ~~will~~ 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. :: {{Icon-Menu}} 2. Under the heading '''Configuration, '''select '''Global Settings.''' The ~~first field~~ 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 ~~is added~~ 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 [[User|users]], both [[Internal|internal]] and [[External|external]]. {| class="wikitable"|-||'''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|organization hierarchy]]) and '''Organization '''([[External]])|-||'''Users - Custom Fields'''||Create and manage custom fields for [[User|users]], both [[Internal]] '''Staff '''and [[External]] '''Contacts'''|-||'''Associations - Custom Fields'''||Create and manage custom fields for [[Association Settings|associations]], which can be between companies and users or company-to an -company |-||'''Transactions - Custom Fields'''||Create and manage custom fields for [[~~Entity~~:Category:Transactions|~~entity~~Transactions]] and [[Transaction Attribution|transactions attributions]]|}:: [[File:All custom fields.png|thumb|none|600px|border|All custom fields for system objects]]:: [[File:Organization custom fields.png|thumb|none|500px|border|Custom fields for Organizations under the Organizations tab]]When you click into a '''Custom Fields''' hyperlink from the '''Global Settings''' area, you will ~~use~~ be brought to a [[List View Overview|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 10the custom field name, as shown below::: [[File:Edit custom field.png|950px|border]]: :* ~~Additional fields that~~ Using the '''Search''' function on the top right, you ~~add will automatically increase~~ can search through all '''Object Entities''' or through the ~~display order by increments~~ fields of 10specific {{UTA}}s. Simply select or deselect to control your results.:* ~~If you wish~~ '''Tip: '''A Search-based strategy for troubleshooting is to ~~insert a~~ clear your past search, select '''All Object Entities '''within the search bar, then click on the '''Last Modified '''field ~~between two fields~~ in the list view so that it is in descending [[Sort By|Sort Order]] and you can ~~set~~ see the ~~display order to~~ date that a ~~number that will position the~~ custom field ~~where required~~was changed, added, etc. :* You can ~~change~~ also access all deleted fields by clicking into the ~~display order by setting~~ second tab. There is no time limit within the ~~display order~~ system that removes deleted records; therefore, you can simply select and restore or purge these previously deleted fields.:* There should be no reason to ~~a different number~~purge as Custom Fields do not take up much space within the system. ~~For example~~:* When you restore fields, ~~if you set~~ there is no loss of data. =Configuration - Essentials=<pre>This page will serve as the ~~display order on~~ 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. </pre>==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 ~~5000 then~~ the ~~next~~ field ~~added will automatically become 5010~~.

~~==='''Display Order with Related Entities'''===~~::: [[File:Custom field menu buttons.png|200px|border]] The following table describes the functionality of each button from left to right:

~~If you add~~ {| class="wikitable"|-||'''Custom Fields [[~~Custom Field~~List View Overview|~~custom fields~~list]] '''||Clicking this '''list chart '''icon will bring you to the ~~basic contact [[Entity|entity]] and then add~~ list of all custom fields ~~to [[Role|roles]] associated with contacts~~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 ~~need~~ be brought to ~~take care, as the~~ a comprehensive list of all custom fields ~~will become mixed if they have the same number sequence~~relating to '''Organizations. '''|-||'''New Custom Field '''

~~The following table outlines where you need to be careful:~~('''+ 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. |-||'''[[~~Image:Cf3.png~~Field Data]] '''

~~You should start the number sequence for these types~~ ('''stack of ~~related fields at some higher level. For example, role 1 starts at 5000, role 2 starts at 8000.~~coins icon) '''

~~==='''Tab Order'''===~~||Clicking this will open up a page that displays all the values that have been saved to the field.

* By adding Custom Field Data consists of two general types: '''text type '''fields (saved as a text ~~value to the tab order to the field will be displayed on that tab.~~* The tab name can be string) and '''object type''' fields (consisting of any ~~text string required.~~* Custom fields that are not associated with a tab will be displayed on a tab named Defaultfiles such as documents or images). ''' '''

~~===~~|-||'''~~Fields with No Tab Set~~[[Update History]] '''~~===~~

~~[[Image:Cf4.png]]~~('''reload icon''')

~~'''Same Fields~~ ||Clicking this will open up a page with ~~Tab set~~ a [[List View Overview|list]] of all of the updates to ~~Creation Details'''~~field settings that have been made on this field.

~~[[Image:Cf5.png]]~~|-||'''Search Reference'''

~~~~('''~~Field Name and Field ID~~magnifying glass icon'''~~~~)

* The ||Clicking this will display all of the locations where the custom field ~~name~~ is ~~mandatory~~referenced in the system.* The name can be up to 255 characters long and should not include special characters that could be misinterpreted by the For more information, see [[~~Browser|browser~~Custom Fields – General Information#Custom Field References]].* The Field ID is automatically generated by the system as a number value and is displayed to the right.

Fields are fully searchable for any related application. For example, [[~~Image:Cf6.png~~User Role|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 Fields|Custom Field]] types::* [[#General Settings|General Settings]]:* [[#Display & Formatting|Display & Formatting]]:* [[#Validation|Validation]]:* [[#Feature Options|Feature Options]]:* [[#Value Storage|Value Storage]]{{FieldOptionsINFO}}{{DisplayINFO}}{{ValidationINFO}}{{FeatureOptionsINFO}}{{ValueStorageINFO}}<!--'''Referencing ~~Fields~~ Field Names and Field ID IDs in other Custom ~~Fields~~ Field Types'''

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

* '''Display Only''' – External Entity Details.

* '''Display Only''' - Web Page View.

* '''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==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:

~~The syntax for these~~ ::: [[File:Custom fields permissions and availability.png|500px|border]]Access to a [[Custom Field|custom field]] is controlled by permissions. These can be found and set in any custom field ~~types varies (some are processed~~ , on the ~~server~~ Permissions and ~~other in~~ Availability tab. You can set only certain roles to be able to see/edit a ~~JavaScript in~~ field, or you can do the ~~client) and is explained for~~ same thing with statuses. An example would be denying the ~~individual~~ '''Applicant''' role permission to see the '''Decision '''custom field ~~type~~(as this would reveal pre-emptively whether or not their application has been approved or denied).

{| class="wikitable"|-||'''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 [[Status|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 [[Client Categories|organization categories]] will have permission to have this field to fill out. '''Exclude Field For: '''Click into this text box to select which [[Client Categories|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.<!--'''Special Field Name Syntax'''

There are two special characters that can be used to prefix the field name. These prefixes control the presentation on the field name in relation to the presentation of the data.

* A '''Hyphen''' “-“ is used exclusively with the '''Title Bar – Multiple Columns''' field to suppress the title bar but display a multiple column layout.

* 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]]===

* This setting determines the order that the field will be displayed on the page. The first field that is added to an [[Entity|entity]] will use a display order of 10.

* Additional fields that you add will automatically increase the display order by increments of 10.

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

~~~~===Display Order with Related Entities===If you add [[Custom Field|custom fields]] to the basic contact [[Entity|entity]] and then add fields to [[Role|roles]] associated with [[contact]]s, 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: {| border="1"|-||'''Entity'''||'''~~Field Type~~Related Entity'''|-||Contact||Roles|-||Companies||Categories|-||UTA {{ l1 }}</uspan> 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. ==Common Custom Field Settings==Each custom field contains a button at the top linking it to the three following settings pages: * [[Field Data]] - displays all the values that have been saved to the field.* [[Update History]] - displays all the updates to field settings.--><!--====Fields with No Tab Set====[[Image:Cf4.png]]

~~The field type is used~~ ====Same Fields with Tab set to ~~define the characteristics of the field. There are '''40''' field types currently available~~Creation Details====[[Image:Cf5.png]] -->

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

~~===~~::: [[File:Custom fields visibility.png|500px|border]]In order to enable '''~~Visibility Condition~~Advanced Options, '''~~===~~you must toggle on the feature from the top right of your page.

::: [[File:Advanced options.png|150px|border]]Whether or not a [[Custom Field|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.

::: [[File:Custom fields classic options.png|750px|border]]

{| class="wikitable"

|-

||'''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 '''~~Role Field Permissions~~Default.''' ~~and~~ :* The '''~~Status Field Permissions~~Tab Name '''~~===~~option only appears once the '''Advanced Options '''are enabled on the '''Classic Options '''tab.

~~Access to a [[~~|-||'''Custom ~~Field~~HTML Tag'''|~~custom~~ |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~~]] is controlled by permissions~~box.

~~See [[Role Field Permissions]] or [[Status Field Permissions]] for more information~~'''Searchable - '''

~~[[Image:Cf8.png]]~~'''Read Only - '''

'''Enable [[KML]] - '''

~~~~'''~~How Field Data is Stored~~Disable Quick Edit - '''~~~~Toggling on this option will not allow the user to modify this field using the system's [[Quick Edit]] functionality.

~~Custom field data consists of two general types –~~ '''~~text type~~Disable Field from Global Search - ''' ~~fields and '''object type''~~Toggling on this option will remove this field from any results that appear with the system' ~~fields~~s [[Global Search]] functionality.

* Text Types fields are stored |}===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 ~~database as text strings~~action bar, and can be identified by the magnifying glass icon.

~~These fields are fully searchable to any related application. For example~~When used, ~~[[Role|role]] level fields can be searched though~~ the ~~'''Search People'''~~ feature ~~or any application that provides access~~ will search references to ~~contact data.~~this custom field via variable syntax in various areas, including:

~~You can also search and replace these~~ :* Other custom field options/visibility condition, including [[JavaScript Validation]], [[Visibility Condition]], [[Custom Field Type: Special – Calculated Value|calculated values ~~in bulk by using the '''Field~~ ]], etc.:* [[Template / Type Formula|Template formulas]]:* [[Submit buttons]]:* [[Submit Logic]]:* [[SmartCheck Validation]]:* [[Workflow Task]]:* [[Creating_a_Single_Step_Workflow#Connecting_Tasks|Workflow connectors]]:* Data~~''' tab and specifying the old and new value required~~class policy[[Image:SearchReference2.png|border]]

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

* To export a block of custom fields, simply click the ''~~'Object Type'~~Export'' button at the top of a list of custom fields ~~are stored on~~ . A window will pop up showing the ~~server~~ custom field settings in ~~a resource folder on the server.~~ XML format:

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)[[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'~~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 ~~Export Custom Fields~~confirm that you want to import the fields by clicking ''Import''~~~~at the bottom of the Import pop-up.

~~You can use~~ The majority of field settings will be included in the ~~custom field '''Import''' and '''Export''' features to move or copy custom~~ copied fields ~~from one [[Entity|entity]] to another (or even another instance of [[SmartSimple|SmartSimple]])~~.Exceptions include:

:* any [[~~Image~~Field Permissions]]:~~Cf10.png~~* any [[Field Permission Matrix]] assigned to the original custom field:* any [[Value Stores To]] setting assigned on the original custom field:* the ''Description'' settingHowever, [[Field Permissions]] and [[Field Permission Matrix|Field Permission Matrices]] can be assigned to the new fields using the [[Batch Update]]feature.

~~'''Custom Field Types'''<~~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/u>Import feature will be assigned new custom field IDs.

~~The full list of '''Custom Field Types''' can be found on the~~ Also see [[~~:Category:~~Custom ~~Fields~~Field Import Wizard]] ~~page.~~

===Custom Field Types===

The full list of '''Custom Field Types''' can be found on the [[:Category:Custom Field Types|Custom Field Types]] page.

==See Also==

:* [[Batch Update Custom Field Settings]]

:* [[Reporting on Custom Fields]]

[[Category:Custom Fields]]

← Older edit

Ciaran Donnelly

Smartstaff, administrator

4,478

edits

Changes

Custom Fields – General Information

SmartWiki