User Tools


List of coreBOS UITypes

UI typePurpose
1A single line text field. Changes color when selected.
2Same as uitype 1, but this is a mandatory field. A star is present before the field label. Changes color when selected.
3AutoGenerated AccessKey in Users module
4An non-editable single line text field that displays auto-generated and incremental input, like invoice number. Used for generating Auto number of configured type in any module.
5Date field. Contains a link to “jsCalendar” which can be used to fill it in. Also displays the current users date format below it. Takes input date based on the current users date format. Does not allow to enter an invalid date like 30th February. Does not change color on selection.
7A single line text field that is used to take numeric input primarily. Changes color on selection.
8Internal field that holds a list of emails for the TO, FROM, and CC email fields on the Emails module.
9A single line text field that is used to accept percentage inputs from users. Checks if the input is less than 100 or not and gives an error otherwise. Changes color on selection.
10To create an input type of 'Linked Entity' wherein a field can be linked to one of the entities from multiple modules (e.g.: Member of field)
11Phone and fax
12Email id field which stores the single email id (from email address), when mail is sent from the system
13A single line text field. Used to take the email-addresses as input from user. Checks for the validity of the entered email and gives an error if it is invalid. Changes color on selection.
14Time
15A dropdown combo that accepts input from the value selected in it. The values in the dropdown vary from module to module and Role-based.
16A dropdown combo that accepts input from the value selected in it. The values in the dropdown vary from module to module and don't depend on the current user's role (non-role based).
1613A dropdown of the entity modules available in the application
1614A dropdown of the entity and non-entity (extensions) modules available in the application
1615A dropdown of all the picklists in the application
1616A dropdown of all the filters in the application (use view permission module with a uitype 10)
1024A dropdown of all the roles in the application
17Single line text field which is used to accept the names of websites from the users. In other words a URL. Does not check for the validity of input, but does parse the protocol. Changes color on selection.
19Textarea used for accepting large inputs like “Description”, “Solutions” etc. Changes color on selection.
21textarea sized around five lines. Used to take small details like “Street Address” from user as input. Changes color on selection.
25Email Status Tracking (Used to count the number of times an email is opened). This is a special uitype, value for which is computed based on the values of the other table.
26Documents folder
27File type information (Internal/External). This uitype is special as it gives a picklist selection on the left side where the label appears and based on which the input type for the value changes.
28Field for filename holder (which was previously merged with another uitype). Now this field exists independent of the other uitype, but its type varies based on the value of the other uitype
30This consists of three dropdowns that are used to set the reminder time in case of any activity creation.
31Reserved User theme dropdown
32Reserved User language dropdown
33Multipicklist. Does not change color on selection.
3313Multipicklist of the entity modules available in the application
3314Multipicklist of the entity and non-entity (extensions) modules available in the application
50Datetime field. Contains a link to “jsCalendar” which can be used to fill it in. Also displays the current users date format below it. Takes input date based on the current users date format. Does not allow to enter an invalid date like 30th February. Does not change color on selection.
55This uitype provides a combination of Salutation and Firstname. The Salutation field is a dropdown while the Firstname field is a single line text field that changes its color on selection.
255In leads and contacts module, last name is mandatory but first name is not. So when the first name is disabled for the profile, the salutation gets handled and added for the last name using this uitype.
56A checkbox which takes input in the form of yes or no.
69Image field. In products 69m which is special as it can hold multiple images
71Currency for application usage. Read more here
72Currency special for inventory module lines and totals. Read more here
85Skype
117Currency picklist. field must be named currency_id
1025MultiSelect autocomplete
User Fields
52CreatedBy and ModifiedBy user read-only fields. Note that this uitype is prepared to be editable. By default, they are set to displaytype 2 which makes them non-editable, but if they are changed to displaytype 1 they will be editable.
53Combination of a dropdown combo and a radio button that accepts input from the value selected in the combo. The value of the radio button, in turn, decides the values in the combo. The input is the name of the user or group to which an activity is assigned to.
77A dropdown with a list of current active users. It is a second assigned user field with no permissions attached to it. The column name must be named inventorymanager and the fieldname assigned_user_id1
101User capture widget

Steps to add a new uitype

  • add the uitype to data/CRMEntity.php: this is for formatting the input value to be saved in the database, if no formatting is needed you will not need to modify this file
  • add the uitype to include/ListView/ListViewController.php: formatting output on list view
  • add the uitype to include/utils/ListViewUtils.php: formatting output on related list view
  • add the uitype to include/utils/DetailViewUtils.php: formatting output on detail view
  • add the uitype to include/utils/EditViewUtils.php: formatting output on edit view
  • add the uitype to Smarty/templates/EditViewUI.tpl: formatting edit options
  • review include/js/dtlviewajax.js, Smarty/templates/DetailViewFields.tpl and Smarty/templates/DetailViewUI.tpl in case you need to add some functionality for inline edit
  • create a changeset to insert the new type into webservice table: vtiger_ws_fieldtype
  • add support for this uitype in Layout Editor (Example commit)
    • Smarty/templates/Settings/LayoutBlockEntries.tpl
    • include/js/customview.js
    • modules/Settings/LayoutBlockList.php
    • themes/images/{your uitype image}

coreBOS Documentación