Help Guide Screen + Sample Files

Updated 13 July 2026

This module includes a built-in Help Guide screen (inside Odoo) and sample files you can use to practice imports safely.

Overview

If you’re new to bulk imports, start with sample files. They help you understand column naming, formats, and mapping—without risking real data.

The Help Guide inside Odoo is a quick reference when you forget a step. The sample files are for practice: they show how data is typically structured for Contacts-style imports (in different formats like CSV, Excel, JSON, and XML).

Best practice Use the sample files to learn mapping + preview first, then copy the same column style into your real business file. This reduces mistakes and makes Auto Map work better.

Good first practice Import a small sample into a non-critical screen (or a test database) first. Then repeat with your real file once you feel confident.

How It Works

  • The Help Guide menu opens a read-only page that explains the import workflow and troubleshooting.
  • The module also provides sample files (CSV, Excel, JSON, XML) that you can use to test mapping and preview.

Step-by-Step Guide

  • Open the Help Guide Go to Odoo All import → Help Guide.
  • Practice with a sample file Use a sample CSV/Excel/JSON/XML file to try mapping and preview.
  • Use “Preview” before importing Confirm values appear under the right fields.
  • If errors happen, check Import Logs Open a log entry to see the message and original row data.

Tip

Keep your first test file small (5–20 rows). It’s faster, easier to review, and safer.

Fields Table

Field explanations

This section explains every field shown in the Fields Table above.

  • Help Guide (menu) Use this when you need a quick reminder of the workflow or troubleshooting tips directly inside Odoo.
  • All Imports (menu) This is the main wizard list where you create and run import configurations.
  • Sample File (CSV) Good for learning delimiters, headers, and simple mapping. Open it in a text editor or spreadsheet tool.
  • Sample File (Excel) Good when your team works in spreadsheets. It helps you learn sheet selection and mapping columns.
  • Sample File (JSON) Useful when importing from modern apps/APIs. If the records are nested, you may need to set JSON Root Path.
  • Sample File (XML) Useful when your source system exports XML. If needed, set XML Root Element to identify record elements.

Tips

  • Keep a “clean template” based on sample files so everyone in your team uses the same columns.
  • Name columns clearly (Email, Phone, Country) so Auto Map works better.
  • Use a test database when possible for your first imports.

Common Mistakes

Mistake: Practicing on production data
Use a test database or a small file first. Big imports are hard to undo.

Mistake: Changing sample columns without updating mapping
If you rename columns, Auto Map may change and your mapping may need updates.