Custom Fields
- administrator
- Custom
Configuration > Custom Objects > Custom Fields
Related Guides:
Details
| Field | Type | Description |
| Field Name | Alphanumeric | The name given to the custom field. This must only contain alphanumeric characters and no spaces. The letters "CF" will automatically be prefixed to the name when created, to indicate that it is a custom field. Can't be edited after creating. |
| Field Label | Free Text | The label that can be searched for when attaching this custom field to a field list. Can be edited after creating. |
| Type of Field | Single Select | Custom fields can be of type: Text (a singular line text box), Memo ( A larger text box than "Text"), Rich (A text box that can accept pictures, canned text, formatting, links, emojis, lists, etc), checkbox (appears as a checkbox on halo), single select/ multi select will be dropdown fields. |
| Sequence | Integer | (Only available for CRM Note custom fields) Here you can set a sequence for the field. This will determine what order this field displays in when logging a new CRM note for a customer. |
Field Configuration
| Field | Type | Description |
| Input Type | Single Select | The input type to the custom field can be restricted to i.e. integer, money, alphanumeric, etc... Keep in mind input type options will vary based on the entity you are creating a field for. |
| Lookup Type | Single Select | Sets if the values in a selection field are static or dynamic. |
| Values | Text | Sets the values for a static dropdown for Single Selection or Multiple Selection fields. |
| Add new choices dynamically | Checkbox | Allows additional values to be added to the Single Selection or Multiple Selection dropdown as you go. |
| Default Sort | Single Select | Allows values to be sorted alphabetically or by sequence in a Single Selection or Multiple Selection. |
| Default Value | Text | Sets a default value on the Single Selection field. This will be used as the value of the field on any tickets unless changed. From version 2.242+, custom field default values will be applied if the ticket type of a ticket is changed and the field would be blank. |
| Lookup ID | Text (Read Only) | Only appears once the Single Selection or Multiple Selection field is saved. Shows the lookup ID of the custom field for easier reporting. |
| Maximum Selections | Integer | Sets the maximum number of options that can be chosen on a Multiple Selection field. |
| Default Date | Single Select | Sets if a Date field should have a default. |
| Days | Integer | Sets how many days in the past/future the Date field should default to. |
| Custom Validation | Table | Allows restrictions on submitting when the Date field is within a certain range into the past/future. Excuses can also be made instead of restricting use. |
Validation Error Message | Text | The message set here will show when validation of a Date field fails. |
| Lookup Method | Single Select | Sets if SQL or a custom integration is used for the lookup. |
| Default to first value | Checkbox | Only available when 'dynamic' lookup type selected. When enabled the first value returned by the query will be used as the default value for the field. |
| Identifier (ID) is a non-integer value | Checkbox | If enabled, allows returns from custom integrations to be non-integer IDs. This is read-only upon creation, and the field will only show in these conditions:
|
| Encrypted Field | Checkbox | When selected, the custom field will become encrypted, it will also have the same UI as a password. |
| Display Type | Checkbox | Determines how the characters in the encrypted field display. All can be hidden, or only starting/ending values. |
| Number of characters to display | Checkbox | If the display type is set to hide starting/ending values here you can set how many characters are displayed, e.g. the first 3. Any characters before/after this will be hidden. |
| Default Value | Free Text | This will be the default value for the custom field, which is populated in the input box by default, it can be changed. |
| Calculation | Text | Sets the calculation used for a Calculated Text Custom Field. These calculations should be formatted using mathematical operators (+,-,*,/) on existing numerical fields in Halo. These fields can be included within your formula using their associated variable. For more information and examples on calculated fields see the guide linked here. |
| Calculation Rounding | Integer | Sets the number of decimal places to round the calculation to. |
| Simplify Rich Note | Checkbox | Only applicable when 'Rich' type of field selected. When checked, the rich note box will only display the image upload button in the menu bar, the other rich text options (such as font size/colour) will not appear. |
| Character limit | Single Select | (Text Fields) Allows setting of a character limit for a Text Custom Field. Upon selection, a "Max characters" Field will appear alongside it to set the limit. From 2.232.1+, Memo Fields can have a limit up to 4000 characters. |
| Max characters | Integer | If a limit type is set above, the limit can be set here. |
Settings
| Field | Type | Description |
| Field Summary | Free Text | The summary will be displayed beside the field label in brackets, when adding the custom field to a field list. |
| Hint for Field | Free Text | The hint will be displayed as faded out text on the custom field input. This is not an input, so if the custom field visibility is set to "Required" there must be a value added to the box, whether it be manually or a default value. The hint will be displayed below the field label after ticket creation. NB: If a default value has been added, the hint will not be visible. |
| Hint Display Type | Single Select | The hint can be a 'placeholder' located as a hint within the input box. If the checkbox CF type is selected it will show below the custom field label regardless of hint display type. The second type is 'Underneath Label', which will display under the label. The option 'Hover Icon' will show a question mark (?) next to the field name which when hovered over will display the hint. |
| Show hint on Ticket Details | Checkbox | When selected, the hint field will show below the field name of the custom field on the i.e. additional fields tab of a ticket. NB: This hint will show above the actual value given to the custom field. If this button is selected, all previous tickets etc with that custom field, will update to now show the hint as well. |
| Hyperlink when in read mode | Free Text | When the custom field is displayed on i.e. a ticket, there can be a hyperlink attached to it, which will send the user to that link when clicked on. The $value can be added to the link, this will pull whatever value is inputted into the custom field input. Example: The value given on the input field is "tenants" and then the hyperlink field is populated with "https://$value.com" if this hyperlink (custom field value) is now clicked on, it will take you to the tenants homepage |
Only show this field to Agents (End-Users will not be able to access any lookup values or the field) | Checkbox | When selected, the user wont be able to use the dollar variable associated to the custom field. Example: If the field name was test, then nothing would be returned if the user used $cftest |
| Allow Users to edit this Field on the Portal | Checkbox | Only applicable to custom fields for the entity "User". When enabled, users will be able to update this field themselves in the portal. They can edit this under the "Settings and Preferences" section of the portal. |
| Allow Supplier Users to edit this Field on the Portal | Checkbox | Only applicable to custom fields for the entity "User". When enabled, supplier users will be able to update this field themselves in the portal. They can edit this under the "Settings and Preferences" section of the portal. |
| Show on the Ticket details and new Ticket screen | Checkbox | When enabled, the field will show on the ticket details and new ticket screen within the end-user's information. This applies to custom fields of type "Customer" and "Site". |
| Filterable on the Calendar screen | Checkbox | Only visible if the Type of Field is set to Single Selection. When checked, this option will allow you to add the filterable single select to the calendars module (Navigation Menu > Calendars Area) "Filters" Dropdown. You can restrict your appointment visibility based on this filter, by changing what the dropdown contains. |
| Hide this Field from the Agent search filters | Checkbox | When this setting is enabled, the custom field will not appear on the agents search filter when they use the quick search function found in the top right. When in the search screen, the filter found on the left hand side will not contain this custom field as search filter option when i.e. searching through tickets. |
| Exclude from $ALLFIELDS and $ALLFIELDSQA variables | Checkbox | When selected, the custom field will not be pulled through by the $ALLFIELDS $ALLFIELDSQA variables (these variables pull through a table of all the fields on the ticket) i.e. an email template using the $ALLFIELDS or $ALLFIELDSQA. When checked the field will also be excluded from the $ALLFIELDSCARD variable. |
| Regex | Code | The variables that can be inputted for the custom field could be restricted to only numbers and letters using the regular expression [A-Za-z0-9_]. This regex function is only to be used for very specific restrictions, it might be that the input is an email address and the agents will be restricted to only input emails using an email regex. This would be useful to stop incorrect email values being inputted. |
| Delete Data X days after Ticket closure | Checkbox | When selected, there will be an option to select how many days after closure the custom field data is to be deleted. The default value of -1 stops the data from being deleted. This is a useful feature if the ticket data is private/sensitive data. |
| Days | Integer | Decide how many days the data of the custom field should be deleted after the ticket is closed. |
| Allow modify access if Agent has modify access to a Ticket Type using this custom field | Checkbox | When selected, agents will be able to edit the custom field value based on the permissions they have on the specific ticket type. |
| Tab | Single Select | The tab which the custom field will populate within. Example: The additional tab is displayed in the same bar as the "Progress" tab of a ticket. The tabs to select from can be configured in the custom tabs section, there are also a list of default tabs to select from. |
| Show on CRM Notes | Checkbox | When selected, the CRM Notes tab on customers will contain an option to add a value to this custom field when adding a new note. |
Allow the use of dollar variables in the field value | Checkbox | (Only available for Rich Text Custom Fields). When enabled, variables can be entered and populate in rich text custom fields on the entity itself. This allows agents to enter variables into fields when logging tickets, and then have the field populated with the once the ticket is saved/logged. |
Exclude from Audit/Change History | Checkbox | (v2.244+) (Only avaliable for Client, Site, User, Asset and Ticket Custom Fields). When selected, changes to this Custom Field's value will not show in the Audit log, or Change History. |
Parent/Child/Related Tickets
| Field | Type | Description |
| Copy values to child Tickets | Checkbox | When selected, the custom field will be displayed on the child tickets if they exist. |
| Copy values to child Tickets when parent value is updated | Checkbox | When selected, if the custom field on the parent ticket is changed, the value on the corresponding child ticket will also be updated. |
| Copy values to grandchild Tickets when parent value is updated | Checkbox | ("Copy values to child Tickets when parent value is updated" enabled) When selected, if this field is updated on a project ticket (grandparent parent), the values in the field will be copied down to grandchild tickets of the project. |
| Copy values to parent Ticket | Checkbox | When selected, if a parent ticket is created, then it will also have this custom field attached to it. |
| Copy values to parent Ticket when child values are updated | Checkbox | When selected, if the custom field on the child ticket is changed, the value on the corresponding parent ticket will also be updated. If the field on the parent is already populated this will be overridden. |
| Copy values to parent Tickets on new Ticket screen | Checkbox | ("Copy values to parent Ticket" enabled) When enabled, when creating a new parent ticket from an action on an existing ticket, data in this field on the child ticket will be copied onto the respective field on the new ticket screen. |
| Copy values to related Tickets | Checkbox | When selected, if a related ticket is created, then it will also have this custom field attached to it. |
Visibility Restrictions
| Field | Type | Description |
| Customer Restrictions | Table | Here you can configure this custom field to only appear for particular customers. If no customers are added, the field will appear for all. |
| Organisation Restrictions | Table | Here you can configure this custom field to only appear for particular organisations. If no organisations are added, the field will appear for all. |
| Dynamic Field Visibility | Table | Here you can configure this custom field to only appear after conditions from other fields have been satisfied. If no conditions are added, the field will appear for all. |
Other Uses
| Field | Type | Description |
| Used in Ticket Types | Read Only | This read-only field will show which ticket types the custom field is added to. |
| Used in Actions | Read Only | This read-only field will show which actions the custom field is added to. |
| Used in Field Groups | Read Only | This read-only field will show which field groups the custom field is added to. |