Documentation to assist with the setup and configuration of the HaloPSA platform
Custom Fields - Adding to Your Records
Custom fields can be used to collect additional information in any section. In the client view specfically however they can add a great depth of extra information, whether it's the support supplied by their contract with you, the loyalty of that customer or something more specific to you.
Adding a new Custom Field
Head to the configuration console and then navigate to "Custom Objects" under the advanced heading. This takes you to the lists of custom fields in Halo. Select the client entity to display all of your current custom client fields.
Clicking "New" in the top right-hand corner will take you to the creation screen. First, give the field a name and label. The "Name" is the name of the field in the database, this will contain no spaces but is a descriptor of the field itself and should reflect the field label. The "Label" is what will appear within Halo and is what your agents will see to fill in.
Next is the data type, described in the table below:
|Type of Field
|Single line of plain text.
|Multiple lines of plain text; longer descriptions or notes.
|A single option to be picked from a drop down list.
|Multiple options to be picked from a drop down list.
|This field type will prompt a date selection box when clicked.
|A specific time on a 24 hr clock, for clients this could be the office opening time in your time zone.
|A binary selection of "Yes" or "No" in the form of a checkbox.
|This is used to refer to custom tables within your database such as external information.
|A rich text box allowing a large number of formatting and editing styles. Including images, links, html code editor, emoji's.
The ways in which you can configure a field depend on which data type you have selected. The following field configuration methods are therefore split by data type.
- Anything - this is any plain text input
- Integer - Whole number inputs e.g 13
- Money - A number with two decimal places such as 42.21
- AlphaNumeric - Plain text letters and numbers with no punctuation
- Decimal - A number with more than two decimal places i.e. 12345.98765
- URL - A web Address
The input type can be restricted, this could be set to i.e. “Password” which will be a field that when given inputs, the inputs will show as hidden characters. You can audit for the password custom fields which means it can be seen who has viewed the password by using the "eye" icon.
The password can be unveiled by hitting the eye icon. By default the password field will not show the length of the password, unless clicking on the eye icon. The password can also be copied by clicking the copy icon.
Password visibility(visibility of the eye icon) can be set on permissions tab of agents, options are “Not Visible” or “Visible”
Calculated:The last type of input is the calculated field. The idea of a calculated field is to perform mathematical operations on a field on halo that is numeric. For example if there is a dollar variable $CFIntegerField and the calculated field is when integer field is changed to 5, the Calculated Field updates to 2.5 on the ticket.
The example use case may be that you are topping up accounts via a ticket on Halo. On the ticket creation screen there would be the different accounts along with the amount to top up by. Then to summarise the total amount to top up by across all of the accounts we can use a calculated field
Text fields can also be encrypted via the checkbox, this is useful for fields that contain sensitive information.
You can then submit a default value for any of these inputs, such as:
The only option here is the default value.
- Static list which is a fixed set of options set in a comma seperated string, e.g. Yes,No,Maybe. Radio selection can be used instead of a drop down list
- Dynamic list (SQL)
- This is a list which populates based on a SQL query input below.
- This can be used to pull information from the database to enable your agents to make a choice based on existing data.
- Guide: Dynamic SQL
Choose values for the selections here, these are static and cannot be pulled from another query.
Date, Time and Checkbox
These have no configuration settings.
Similar to the Dynamic List, this will extract data from the database but this time from any custom tables you have attached. These will start CT.
You can display any combinations of the information stored in any custom table.
These are more general for the fields itself with summary being a description of the information contained in the field and the hint being shown in gray when the field is being updated.
Copy values to Child Tickets
This setting decides whether the value of this field is copied to child tickets if this is present in a ticket type.
This setting determines the tab the field will be visible on; these appear on the client screen to the right of settings.
Custom Tabs can be created in Configuration > Custom Objects > Custom Tabs. In the image above there has been a custom tab created for the customer entity with name "Level of support offered". Custom Tabs can be added to many areas of halo, a notable one would be the tabs of the ticket details screen.
This setting decides which client you are restricting the field to be available to, if any.
Once you have completed the creation of your custom field, if it is a ticket or action level field, don't forget to add this to it's respective field list in the relevant configuration area. For example if you had a custom field you wanted to apply to a ticket types field list, you would add it the following way
Then add the field
Once added to the field list, the visibility restrictions can be set by editing the field which will now be showing on the list.
- Asset Import - CSV/XLS/Spreadsheet Method
- Call Management in Halo
- Creating a New Application for API Connections
- Creating Agents and Editing Agent Details
- Departments, Teams and Roles
- Halo Integrator
- Importing Data
- Multiple New Portals with different branding for one customer [Hosted]
- Organisation Basics
- Organising Teams of Agents
- Step-by-Step Configuration Walk Through