Using Field Names for Cleaner Onboarding Exports

If you've explored the settings when creating an onboarding step template, you may have noticed the Field Name box and wondered what it's for. This small but powerful feature gives you precise control over how your data appears when exported from WorkZerk — and it can make a significant difference when integrating with other systems.

What Does the Field Name Do?

When you export onboarding data from WorkZerk, the platform generates a CSV file containing all the information collected during onboarding. Each column in that CSV needs a header — a name that identifies what data sits beneath it.

By default, WorkZerk uses the Title of each onboarding template as the column header. This works perfectly well in many cases, but sometimes you need something different. That's where Field Name comes in.

The Field Name allows you to specify an alternative column header that will be used in your CSV exports instead of the template title. Think of it as a "technical name" that sits behind the scenes, separate from the user-friendly title your contractors and guests see during onboarding.

Why Would You Need a Different Field Name?

Removing Spaces for System Compatibility

Many business systems, databases, and software applications prefer (or require) field names without spaces. If your template title is "First Name", you might set the Field Name to "FirstName" or "first_name" to ensure smooth imports into your CRM, payroll system, or HR platform.

Keeping Titles User-Friendly While Exports Stay Technical

You want your onboarding experience to feel welcoming and clear. A title like "Please provide your emergency contact's phone number" is far more helpful to a contractor than "EmergencyContactPhone". But when that data lands in a spreadsheet or gets imported into another system, the shorter, standardised field name is exactly what you need.

Field Names let you have both: friendly, descriptive titles for your users, and clean, consistent field names for your data.

Standardising Across Multiple Templates

Over time, you might create several templates that collect similar information — perhaps one for contractors and another for visitors. The titles might differ slightly ("Mobile Number" versus "Contact Phone"), but by using the same Field Name ("MobilePhone") across both, your exports remain consistent and easy to work with.

Matching External System Requirements

If you're importing WorkZerk data into another platform, that system likely expects specific field names. Rather than manually editing your CSV files after every export, simply set your Field Names to match what the destination system requires. Your exports will be ready to import without any additional processing.

How It Works

When WorkZerk generates a CSV export of your onboarding data, it follows a simple rule for each column header:

  1. If a Field Name exists — use it as the column header

  2. If no Field Name is set — fall back to the template Title

This means you only need to set Field Names where they add value. Templates where the title already works well as a column header can be left as they are.

Practical Examples

Template Title Field Name Result in CSV First Name FirstName FirstName Date of Birth DOB DOB Mobile Phone Number Mobile Mobile Upload your White Card WhiteCard WhiteCard Emergency Contact Name (not set) Emergency Contact Name

In the last example, no Field Name was provided, so the CSV uses the original title.

Best Practices for Field Names

Keep them short and descriptive. A good Field Name is concise but still meaningful. "EmergencyPhone" is better than "EP" or "ThePhoneNumberForEmergencyContact".

Avoid spaces and special characters. Stick to letters, numbers, and underscores. This ensures maximum compatibility with other systems. Common conventions include camelCase ("firstName"), PascalCase ("FirstName"), or snake_case ("first_name") — choose whichever matches your other systems.

Be consistent. If you use PascalCase for one Field Name, use it for all of them. Consistency makes your exports predictable and easier to work with.

Document your naming conventions. If you're working in a team, agree on a standard approach so everyone creates Field Names the same way.

Only set them when needed. If your template title already works well as a column header, there's no need to duplicate it in the Field Name box. WorkZerk will simply use the title.

Setting a Field Name

When creating or editing an onboarding step template, you'll find the Field Name box alongside other template settings. Simply enter your preferred field name — no spaces or special characters — and save the template.

The Field Name is completely invisible to anyone completing the onboarding process. It only comes into play when you export your data.

When to Use Field Names

Field Names are particularly valuable when:

  • You regularly export onboarding data for use in other systems

  • Your destination system has specific field name requirements

  • You prefer clean, standardised column headers in your spreadsheets

  • Your template titles are long or descriptive

  • You want consistent field names across similar templates

If you rarely export data or simply review submissions within WorkZerk, you may not need to use Field Names at all, but they're there whenever you need them.

Field Names are available on all onboarding step templates. Start using them today to streamline your data exports and integrations.

Previous
Previous

Download Onboarding Data External Integrations

Next
Next

Using Sections in Onboarding Templates