Skip to main content

How to Use the FieldAware Import Export Tool?

Step-by-step guide to using the FieldAware Import Export Tool to upload, map, validate, and import or export records with ease.

R
Written by Ruairi Shanahan
Updated over 2 months ago

The FieldAware Import Tool helps you import, update, and export business records via CSV files—quickly and accurately. This guide walks you through the full workflow so you can make the most of this powerful feature.

Step 1: Select an Entity

Before uploading a CSV, start by selecting the entity you want to work with. An entity represents the type of data you're importing or exporting—like customers, jobs, quotes, or users.

💡 The available schema and validation rules will change based on the entity you select.

Step 2: Download a Template (Optional)

To save time and reduce errors, you can download a template CSV file for the selected entity. Templates include:

  • Asset

  • Customer

  • Contact

  • Item

  • Job

  • Historical Jobs

  • Location

  • Quote

  • Task

  • User

Each template includes the default attributes for each entity, plus the corresponding custom fields (if any). Access templates via the Navigation Bar.

Step 3: Upload Your CSV File

Upload your file in one of two ways:

  • Click to browse your system files, or

  • Drag and drop your .csv file into the upload area

✅ Your CSV must include a header row with unique column names.

Step 4: Map CSV Columns to API Schema

Once uploaded, map each column in your CSV to the appropriate schema field in FieldAware:

  • Flat fields are mapped directly (e.g., name → "Name")

  • Nested fields use dot notation (e.g., address.city → "City")

  • Custom fields are shown with a CF badge

You can use Auto Mapping to let the tool guess mappings, or manually adjust them as needed.

🧠 Mappings are saved for future imports and can be cleared from the Navigation Bar.

Step 5: Validate Your Data

After mapping, the Import Tool will validate each row based on the schema rules. It checks for:

  • Required fields

  • Valid data types (e.g., numbers, strings)

  • Acceptable values and formats

Any validation errors will appear in the CSV Validation Preview. Rows with errors won’t be imported.

Step 6: Run the Import

Once all rows are valid, proceed to run the import. The Import Tool will send each row to the FieldAware API.

  • If a uuid field is mapped, the tool will update existing records

  • If not, new records will be created

You’ll see a real-time summary of successful and failed imports.

Step 7: Review and Export Errors

If any records fail during the import (due to API rejections or network issues), the tool will show you:

  • The request data sent

  • The error message returned by the API

You can export failed rows to a new CSV file, which includes detailed error messages for easy troubleshooting and re-importing.

Bonus: Export Existing Records

You can also export data from FieldAware for any supported entity using the Export workflow—available in the Navigation Bar. Use this to:

  • Review existing records

  • Prepare data for bulk updates

  • Create templates for future imports

That’s It!

With the FieldAware Import Export Tool, you can manage your business data at scale all while avoiding manual entry errors and API confusion. Start by selecting your entity and uploading your file and the tool will guide you the rest of the way.

Did this answer your question?