Skip to main content

How to Bulk Upload or Update Users in Forwood (Batch Process Guide)

Use this guide to upload new user accounts or update existing users in bulk using the Batch Process tool.

Written by Aurora

1. Template Field Information

Before beginning any bulk upload or update, review this section carefully.
It contains all editable fields, required values, and system rules.


1.1 Using Search Before Exporting (Required for BOTH Upload & Update)

Before you begin, you’ll need the correct upload template or user information.

  1. Go to User Administration.

  2. In the search field, enter the name of an existing user whose account setup is similar to the new users you want to create.

  3. Select Export for your latest Template.

  4. Save the file to your computer.

This step ensures:

  • Correct companyStructure and physicalLocation

  • Correct information needed

  • Fewer rows to delete

  • Template with correct field structure

Important:
Do not add, remove, or rename any columns in the template.


1.2 User Data Template - Full Field Definitions

Column

Example

Notes

id

5457724

* System-generated. Do NOT edit. Used to identify existing users during updates. Leave blank for new users.

forwoodUuid

bdasfki-2692-45ad-bff3ca4ca0a

* System-generated. Do NOT edit. Leave blank for new users.

username

john.smith

* Must be lowercase, can include numbers, hyphens, underscores, and periods.

email

john.smith@company.com

*Must be unique and valid.

firstName

John

* Text only.

middleName

lastName

Smith

* Text only.

preferredName

Text only. Optional

roles

SiteAdmin, MapReportAccess, TeamAccess

Can be left blank. Default role auto-assigned based on Job Role Category (JRC). Only add additional roles. Comma-separated, case-sensitive.

status

ACTIVE

* Accepted: ACTIVE, DISABLED (case-sensitive).

phoneNumber

12345678

Optional. Numbers only, no spaces.

companyStructure

Forwood Safety

* Must match system list exactly.

physicalLocation

Site Area

Must match site list exactly.

locale

en

* Accepts Locale codes.

timezone

Australia/Brisbane

Optional. Must be valid TZ database value.

clientUserId

09333333

Optional. Must be unique. Numbers only.

jobRoleCategory

Operator

* Value is either Operator, Supervisor, Manager or External

employmentStatus

Employee

* Value is Employee, Contractor or Other

contractorCompany

Company AAA

Only use if employmentStatus = Contractor. Must match Teams naming convention. Case-sensitive. The contractor company must first be set up in the Teams in order to assign it. Must match Teams naming convention. Case-sensitive

inCrmLeadershipRole

TRUE

Optional. Accepted: TRUE / FALSE.

inOperationalRole

FALSE

Optional. Accepted: TRUE / FALSE.

federatedIdentity

FALSE

Optional. Accepted: TRUE (SSO) / FALSE (non-SSO).

federatedIdentityDetails

Forwood

Mandatory if SSO is true.

delegateUuid

Uuid of person in charge. Mandatory if managed is TRUE.

delegateEmail

* Email of person in charge. Mandatory if managed is TRUE.

managed

False

Optional. Accepted: TRUE / FALSE. If TRUE → delegateUuid and delegateEmail required. For more information read here.

dac

FSS391273

Reveal value of latest DAC.

dacCreatedAt

2024-07-16T06:32:33

Reveal when the DAC was created.

generateNewDac

True

Optional. Accepted: TRUE / FALSE.

Note:

  1. DAC fails if user has both CRM and SafetyPlus product access — only ONE product allowed.

  2. DAC generation can only happen after a NEW user has been saved.

dacTarget

CRM

Mandatory if user is using both CRM and SafetyPlus. Select which product DAC is needed.

mfaEnabled

True

Optional. Accepted: TRUE / FALSE.

mfaType

Email

Optional. Currently only supported value: Email.


2. How to Bulk Upload New Users

Use this process when creating new user accounts.

2.1 Download the Template

  1. Go to User Administration

  2. Use the search bar to filter for a user with similar structure

  3. Click Export

  4. Save the file

2.2 Prepare Your File

  • Clear system fields (id, forwoodUuid, delegateUuid, delegateEmail)

  • Add new users as new rows

  • Copy and paste field required.

  • Delete unnecessary columns (createdAt, updatedAt, lastLogin)

  • Delete first row used to copy information

  • Save as .xlsx

2.3 Upload Your File

  1. Go to Batch Process → New Batch Process

  2. Drag or select your file

  3. Click Upload

2.4 Validation

File Format Validation Fails If:

  • File is not .xlsx

  • Columns renamed or rearranged

  • Merged cells or hidden characters exist

Data Validation Fails If:

  • Required field missing

  • Value does not match allowed list

  • Format incorrect (roles, locale, structure, etc.)

Fix errors → re-upload.

2.5 Submit the Batch

  • Click Start Process

  • Confirm “Yes”

  • System will create all users

2.6 Check Results

  • Go to Transaction Page

  • Review Success or Fail logs for details


3. How to Bulk Update Existing Users

Use this process for modifying user details (e.g., location, roles, names, or deactivating an entire structure's user).

3.1 Export Users for Update

  1. Go to User Administration

  2. Use search to filter users, structure, roles needing updates

  3. Click Export

  4. Save the file

3.2 Prepare Your Update File

  • Keep ID AND email

  • Delete rows for users you aren’t updating

  • Only keep columns you need to change

  • If updating structure or site include both fields

  • Remove last 3 columns

  • Save as .xlsx

3.3 Upload, Validate, Submit

Same process as new users:

  1. Batch Process → New

  2. Upload

  3. Fix validation errors

  4. Start Process

  5. Review logs


4. Bulk Create DACs for Existing Users (Selected Users)

Use this process to bulk generate new DACs for users who already exist in the system. This uses the same Bulk Changes to Existing Users batch process. This is helpful when DACs need to be reissued or regenerated for a selected group of users.

4.1 Export the Selected Users

  • Go to User Administration.

  • Filter or select the users who need a new DAC.

  • Click Export to download the Excel file. The export includes three DAC-related columns:

    • dac - Shows any existing DAC value for the user.

    • dacCreatedAt - Shows the date and time the DAC was created.

    • generateNewDac - Defaults to FALSE.

These columns are reference fields. Only generateNewDac should be edited.

4.2 Mark Users for DAC Generation

  • In the generateNewDac column, change the value from FALSE to TRUE (or 1) for each user who needs a new DAC.

  • Remove Users that do not need to receive a new DAC.

4.3 Save and Run the Batch Process

  • Save the updated file as .xlsx.

  • Go to Batch Process → New Batch Process.

  • Upload the file and complete validation.

  • Click Start Process to apply the changes.

Once complete, the new DAC values appear in User Administration and an email will be sent to users.

DAC generation will fail if a user has access to both CRM+ and Safety+ products. Make sure to fill dacTarget field to CRM or Safety to specify the correct product.


5. Troubleshooting Common Errors

❌ “Value does not match predefined value”

Check correct formatting for roles, languages, job categories, or status.

❌ “Email already exists”

The user account might already be in the system.

❌ "Field is required"

A mandatory field is blank.

❌ File fails during ‘Validation File Format’

Ensure:

  • It is saved as .xlsx

  • No columns were renamed

  • No hidden spaces or merged cells

❌ Contractor fields missing

If employmentStatus = Contractor, the field contractorCompany must be completed.

❌Saved user record but Failed to generate DAC

The system cannot generate a DAC when the user has access to both CRM and SafetyPlus products. You must select only one product for the user before generating a DAC.


6. Best Practices

  • Export a clean file every time before uploading

  • Do not modify column names

  • Fix errors directly specified from the failure log

  • Re-upload after corrections


7. Need Assistance?

Contact Forwood Support with:

  • Your .xlsx file

  • Error file

  • Screenshot of the batch page

Did this answer your question?