Field Validation for User Module

Overview

This article outlines the required fields and validation rules for User Bulk Uploads using Add, Edit, or Delete actions. Ensure your data follows these rules for a smooth upload process.

For Add, the following fields are required: Username, Email, First Name, Last Name, and Role.
For Edit, Username is used to identify the user. All other fields are optional and will only be updated if included in the file.
For Delete, only the Username is required to remove the user record.

Username serves as the unique identifier for users during bulk uploads and should be used whenever available.

If the Username is not visible or known from the User page, you may use the Email instead— the system will treat the email as the username during upload if applicable.

Note: For each operation, ensure that all required fields are provided. Optional fields that are omitted will be saved as blank during Add, or will remain unchanged during Edit.

For detailed field-level validation rules, see the table below.

Add User

Field	Description	Example	Required/Optional	Validation Rule
Email	Enter the user's email address.	jacksonsons@gmail.com	Required	Must be a valid, unique email address.
Username	Enter the username for the user (typically same as email).	jacksonsons@gmail.com	Required	Must be unique in the system.
First Name	Enter the user’s first name.	Jackson	Required	Free text.
Last Name	Enter the user’s last name.	Sons	Required	Free text.
Role	Enter the user’s role.	Default Role	Required	Must match an existing role in the system.
Employee ID	Enter an employee identifier, if applicable.	1223	Optional	Must be unique if provided.
Phone Number	Enter the user’s phone number.	+1-9237982322	Optional	Valid phone number format.
Password	Enter a password for the user.	+1-9237982322	Required	Should meet system password requirements (if enforced).
Timezone	Enter the user’s timezone.	Pacific Time	Required	Must match a supported timezone name.
Group(s)	Enter one or more group names to assign the user to.	New 2 group	Required	Each group must exist in the system. Use comma to separate multiple.
User Type	Enter the type of user access.	Web Admin	Required	Must match supported user types like Web Admin.

Edit User

Field	Description	Example	Required/Optional	Validation Rule
Email	Email address of the user. Use if updating the email.	john.doe@example.com	Optional	Must be unique if provided.
Username	Existing username of the user you want to update.	john.doe@example.com	Required	Must match an existing user in the account.
New Username	New username to assign to the user.	john.doe.new@example.com	Optional	Must be unique if provided.
First Name	First name to update.	John	Optional	Free text.
Last Name	Last name to update.	Doe	Optional	Free text.
Role	Role to assign to the user.	Default Role	Optional	Must match an existing role in the system.
Employee ID	Employee ID of the user.	112233	Optional	Must be unique if provided.
Phone Number	Updated phone number.	+1-9876543210	Optional	Must be a valid phone number format.
Password	New password to set for the user.	********	Optional	Should meet system password rules if enforced.
Timezone	Timezone to assign.	Pacific Time	Optional	Must match a valid system-supported timezone.
Group(s)	Group(s) the user should belong to.	Support, North America	Optional	Must match existing groups; separate multiple values with commas.
User Type	Type of user being edited.	Web Admin	Optional	Must match supported user types (e.g., Web Admin, Mobile User, etc.).

Delete User

Field	Description	Example	Required/Optional	Validation Rule
Username	Username of the user to be deleted.	jacksonsons@gmail.com	Required	Must match an existing username in the account.

📥 Related Resources

How to Perform a Bulk Upload