How do you create a custom field? - LabCollector

Search Knowledge Base by Keyword

How do you create a custom field?

You are here:
← All Topics
CUSTOM FIELDS

All modules are ready to use with a predefined data structure (fields) adapted to its content. Nevertheless, you may need some extra fields or numbering options for your lab specific information.
LabCollector allows you to create unlimited extra fields in each module in order to personalize your data forms.

NOTE: Custom fields in version 5.2 have changed.
See this post for creating custom fields in v5.2 and above.
See this post for using custom fields in v5.2 and above.

Only accessible to super-administrator and administrator.

i. Go to Admin > Data > Custom Fields

ii. Select the module where you want to add or edit custom fields in the list to the left.

IMPORTANT NOTE: When you edit the custom field name in each language of your requirement (PROFILE ICON ON THE RIGHT-HAND TOP CORNER -> LANGUAGE), then the field will become adapted to that language. Check our KB on how to change the language & name of custom fields.

iii. Add a new field by indicating its name (1)

iv. You have the possibility to add an helper text visible in edition mode (2)

v. Choose the corresponding field option you want (3).

vi. Choose the custom field type (4). For more information, please read our KB.

For the first eight field types, you can indicate if the field is searchable or not. If you check YES (default value), field data will be included in the search (using keywords).

Once created, all the custom fields can be edited , configured  or deleted .

The modification panel is relative to the type of custom field. Usually, you can change the field name, change some options as color and mandatory status or change/add the category.
You can also convert field type, knowing that existing data will be kept:

  • From Checkbox to text or multiple select list
  • From Select list to text
  • From Text to select list (existing data will be grouped as select options)
  • From Text to checkbox (existing data will be grouped as checkbox options)
  • From Text to multiple select list

Some fields can be configured as text field with mask:

  • You can provide basic plain text, just by writing it in the field.
  • If you want to use an intelligent mask, write it between two ~ using the special characters below:
0 = Any number between 0-9
A = Any alphanumerical character [A-Z; a-z; 0-9]
Z = Any letter from A to Z [A-Z], uppercase
z = Any letter from A to Z [a-z], lowercase
X = Any letter from A to Z [A-Z; a-z], case insensitive

This icon indicates that the field has a mask and if you hover over it with the mouse, the field mask appears.

Checkbox and select lists can also be configured by adding values (write the value in the field and click on update button). You can select a default value by checking one of the spots on the left, and add values by uploading a CSV file (only for select lists).

Custom fields can be rearranged by clicking and dragging to move them into the list.

vii. At the end, you have several options

a. As query filter? Indicate if the field will be used as a search filter or not. This function gives additional filtering in the search in a module. This only applies to Select, Date, Checkboxes and Free text field types.
Above: Under Admin > Custom fields, fields with option as filter. Below: Result in module when you expand search options

 

b. As search header? This function is only available for custom modules. With this function, three custom fields can be displayed on the title line of record summary search results in custom modules. Textbox, checkbox, dropdown select lists, and date types can be used.

 

c. As mandatory? Indicate if the field is mandatory when you add a new record in a module. Mandatory custom fields have a red mark.

 

vii. Choose the category of your fields if needed. For more information, see below.

You can also define that the field is only available in the Analysis tab. For more information, see below.

viii. Choose an optional background color for the field row. You can change this color by editing the custom field.

ix. Save new field button when you have done.

CAUTIONS:

  • If you delete a field, all data stored on that field will obviously be lost!
  • When editing a field, if you reduce its size, longer data may be truncated.
  • Some field names can induce MySQL errors. If such problem happens, use another name.

 

Field Category

Fields can be grouped into specific categories. This helps to organize custom fields for specific usage for different types of records.

1. Create a Select List custom field in the module of your choice.
2. Check FIELD CATEGORY.


3. Follow the previous steps and save the new field.
4. Edit the values list using the icon  that will represent the categories. The configuration is the same as for a standard select list (see above).

5. Once that is done, each new field can be assigned to the general category or to a specific category that you have defined.

6. Finally, when you create or edit a record, only common and category related custom fields will be displayed.

Tab Analysis

Some data can only be available in Analysis tab, and not in the general record. For example, data obtained later or which are changed in time.

To create a field in this Analysis tab, choose the option. A green microscope icon identifies fields in Analysis tab.

You can click on the Analysis tab option on the top right corner to view all the custom fields that have been placed in the Analysis tab.

Use the following icon on the left of your record to open the tab.

If you use a line separator, the page is shown as below. To change the view, use one of the icons at the top right. You can print these results independently of the all record. These values are not exportable for the moment.

To add/edit values just click in the button on the bottom. The edition depends of the field type. Don’t forget to click on Save.

You can also import values as in the general export function. This function is only available for text, date and URL fields.

Related topics: