How to Define a Custom Field for a User
Learn how to create and configure a custom field in the octapipe user profile, including layout, placeholder, mask, required settings, and visibility rules.
Support Team
Last Update 4 months ago
Defining custom fields for a user allows you to include specific information tailored to your operation, controlling layout, required settings, and visibility according to your needs.
1º Accessing the user administration module:
1º Accessing the user administration module:
In the lower-left side menu, click on “Users” to open the list of registered users.
This screen displays all active users and allows you to manage their profiles.
2º Opening the custom field tab:
- In the upper-right corner of the “Users” screen, click the “Module Settings” button represented by the Gear Icon.
- In the modal that appears, all previously created custom fields will be displayed.
If no custom fields have been created yet, the message “No custom fields created.” will appear.
3º Creating a new custom field:
- Click on “Add Custom Field”.
- In the “Create Custom Field” modal, fill in the following:
- Label: name/label displayed to the user (e.g., “Internal Role”).
- Type: select the field type (Text, Number, Email, Text Area, Select, Multi Select, Checkbox, Date, Time, Money, Link, Divider).
- Layout: choose between “Single” or “Double” to define the field width.
- Placeholder (optional): example text displayed inside the field.
- Mask (optional): mask format (e.g., “(###) ###-####” for phone numbers).
- Enable Is the Field Required? if the field must be filled in.
- Enable Is the Field Read-Only? if the field cannot be edited by the user.
- Label: name/label displayed to the user (e.g., “Internal Role”).
4º Configuring visibility rules (optional):
Visibility defines when and for whom the custom field will be displayed.
Visibility defines when and for whom the custom field will be displayed.
- In the same modal, click on the “Visibility” tab.
- In Field, select a base field for the rule (e.g., “Permission Level”).
- In Operator, choose the condition (Equal, Not Equal).
- In Value, select or type the comparison value (e.g., “Administrator”).
- Click “+ Add Filter” to include another rule if needed.
- Finally, click “Apply Filter” to register the rules.
5º Saving the custom field:
You have learned how to create and configure custom fields in the Users module, from filling in metadata to defining visibility rules. If you have any questions, please contact our support team.
Click “Create Field” in the lower corner to save.
The new field will appear in the “User Custom Fields” list and will be available in user profiles.
- Use clear labels aligned with your workflow.
- Use placeholders to guide the expected type of data.
- Apply masks to maintain standardized formats.
- Mark fields as required only when truly necessary.
- Define visibility rules to display fields only to relevant profiles.
- Periodically review custom fields to keep user profiles organized.
You have learned how to create and configure custom fields in the Users module, from filling in metadata to defining visibility rules. If you have any questions, please contact our support team.