Import templates

Templates define:

• Import step execution order
• CSV/XLSX column mappings
• Search fields for matching existing records
• State link relations between imported records

Import steps

Each import step is registered as:

• generic.import.step

and dispatched dynamically to:

• generic.import.runner.<code>

Example:

• Step code: partner
• Runner model: generic.import.runner.partner

If the runner model is not installed, the step is skipped automatically.

Steps may also declare required models:

required_models = "res.partner,sale.order"

Unavailable model dependencies automatically disable the step.

Supported file formats

Import steps

Templates use template-specific step ordering.

This means:

• Global step sequence does not affect template execution order
• Each template controls its own pipeline independently

Field mappings

Each mapping line defines:

• CSV/XLSX column name
• Target model
• Target field
• Whether the field is used for record matching

Search fields are used to build lookup domains before creating records.

Example:

• email may be marked as a search field for res.partner

Allowed models are automatically restricted based on selected import steps.

State links

State links allow imported records to reference previously created records.

Two modes are supported:

Create / edit templates

1. Open: Imports -> Templates
2. Create a template
3. Add import steps
4. Configure field mappings
5. Configure optional state links

Run an import

1. Open: Imports -> Templates -> Import (Upload)
2. Select the template
3. Download the CSV template if needed
4. Upload CSV or XLSX file
5. Click Upload

Shared state

Steps may store created/found records into shared state.

Example:

state["partner"] = partner

Later steps may reuse these records.

Automatic model state keys are also generated:

state["res_partner"] = partner

Runner helpers

generic.import.runner.base provides reusable helpers:

• _get_or_create()
• _get_or_create_from_lines()
• _build_domain()
• _clean_vals()
• _set_state_record()

These helpers simplify custom runner implementations.

Example runner

from odoo import models


class ImportPartner(models.AbstractModel):
    _name = "generic.import.runner.partner"
    _inherit = "generic.import.runner.base"

    def run(self, row_index, row, lines_by_model, state):
        partner = self._get_or_create_from_lines(
            "res.partner",
            lines_by_model,
            row_index,
            row,
            state=state,
        )

        return self._set_state_record(
            state,
            "partner",
            partner,
        )

Contributors

• Valtteri Lattu <valtteri.lattu@tawasta.fi>

Maintainer

This module is maintained by Oy Tawasta OS Technologies Ltd.