Custom Fields allow Administrators to customize their instance of mbrella.
Custom Fields are available for the following Categories:
- Organization
- Document
- Item
- Classification *
- Export Detail *
Available Custom Field Types:
| Text | Most common field type. A basic validator is provided to specify allowed characters: Upper case, lower-case, numeric, and min / max field lengths values |
| Number | accepts only Numeric values. Allows user to specify MIN and MAX values. ex: Age, min/max: 1 / 120 |
| URL | Only VALID fully qualified URLs will be allowed |
| Date | Date-picker widget provided. Date stored in ISO8601 format |
| Checkbox | provides simple true/false checkbox |
| Dropdown | You may specify a comma-separated dropdown list of options. Best practice: no spaces in list ex: "Apple,Orange,Kiwi" |
| accepts only valid email addresses. |
Creating a Custom Field
Select "Custom Fields" from the Admin menu to view a list of all existing Custom Fields configured for your instance.
Field | Description |
| Field Association | Which Domain Object is this Field associated with. |
| Field Type | Choose the best field type to suit your needs. Field Types listed above |
| ISO Code * | * CONDITIONAL: ISO Code only available for Classification and Export Detail Objects. This optional field enables an administrator to target a field to ONLY appear for a select country. You have the flexibility for a field to apply to ONE or ALL Classification/Export elements. |
| Code | a unique programmatic code given to the field. Recommend a camelCase name. This is the FIELD KEY and can be used for integrations (via api) or visible in CSV extracts. |
| Label | Field Label visible to users in view / edit screens |
| Help Text | Description text for users if they need more detail |
| Required | Checkbox. If Checked, Users must populate it correctly in order to save the current record. |
| Minimum Length | Optional. Specify the minimum accepted length for a field value. (available only on relevant field types) |
| Maximum Length | Optional. Specify the maximum accepted length for a field value. (available only on relevant field types) |
| Minimum Number | Optional. Specify the minimum accepted number value. (available only on NUMBER field type) |
| Maximum Number | Optional. Specify the maximum accepted number value. (available only on NUMBER field type) |
| Field Validation (regex) | Allows user to specify a javascript regex validation. Helper available by clicking '?' button. (available only on relevant field types) |
Comments
0 comments
Article is closed for comments.