Appearance
Custom fields
Also known as
- custom field
- user-defined fields
- UDF
- extra fields
- custom attribute
- flex fields
- form extension
- metadata
- additional information
- dropdown field
Custom fields let your organisation record information Roari ERP does not have a field for: a shelf life on an item, a badge number on an employee, a client reference on a project. An account administrator defines them once in Settings › Custom fields; they then appear in a Custom fields section ("Defined by your organisation in Settings.") on the record's form and on its detail page.
Add a custom field (administrators)
Go to SettingsCustom fields.
Choose the Record type the field belongs to, for example Item.
Select New field. The New custom field drawer opens.
Fill in the field:
Field What to enter Label The name people see on the form, for example "Shelf life (days)". Required ("Enter a label."). Key The technical name: lower case letters, digits and underscores, starting with a letter, for example shelf_life_days. Filled in from the label; used in imports, exports and the API. It cannot be changed once the field is saved.Type Text, Number, Money, Date, Choice (one), Choice (several), Yes / no, User or Web address. Choices For the two choice types: type each choice and press Enter. At least two ("Add at least two choices."). Required People must fill it in before saving the record. Select Add field. The field appears in the list and on the record's form from the next time it is opened.
Change the order, edit or delete a field
- In the list, use Move up and Move down to change the order the fields appear on the form.
- Select the pencil icon (Edit label) to change its label, choices or required flag, then Save field.
- To delete, select the bin icon (Delete label) and confirm Delete field. This removes the field from every form and hides the values already stored in it. Imports that use its key ignore the column.
Fill in custom fields on a record
- Open the record's form (new or edit), for example CatalogueItemsNew item.
- Scroll to Custom fields.
- Fill them in like any other field. A required custom field shows the usual required marker and "This field is required" if you leave it empty.
- Save the record. The values show on the record's detail page in the same order.
Where custom fields appear
| Module | Record type in Settings | Shown on |
|---|---|---|
| Catalogue | Item | Item form |
| Finance | Customer, Vendor | Customer, Vendor |
| Sales & CRM | Lead, Opportunity, Sales order | Leads, Opportunity, Sales order |
| Procurement | Purchase order | Purchase order |
| Service | Service case | New case |
| People | Employee, Employment contract, Leave request, Job requisition, Candidate | Employee form, Employment contract, Job requisition, Candidates |
| Projects | Project | Project form |
| Assets | Asset, Maintenance work order | Asset form, Request maintenance |
Settings lists exactly these record types, and only for modules that are switched on. On sales orders, purchase orders and service cases the custom fields can be edited while the document is a draft (or the case is new) and are read-only afterwards.
Permissions
| What | Who |
|---|---|
| Define, edit, reorder and delete custom fields | Account administrators (API permission Permission: settings.company.manage, "Manage company settings, sequences, custom fields, localisation"). |
| Fill in values | Anyone who may edit the record. |
| See values | Anyone who may open the record. |
Limits and things to know
- Values are checked on save: a number field only takes numbers ("must be a number"), a text field at most 4,000 characters, a choice field only its choices.
- A field's Key and Type cannot be changed once it is saved; to use another type, add a new field instead.
- Custom fields are per organisation. Every legal entity of the organisation sees the same fields.
- Every change to a definition is recorded in Activity ("Added custom field …", "Removed custom field …").
- Integrations read and write the values under
customwith the field's Key (API keys).
