Odoo - Data Files ?

Odoo is greatly data-driven, and a big part of modules definition is thus the definition of the various records it manages: UI (menus and views), security (access rights and access rules), reports and plain data are all defined via records.

Structure

The main way to define data in Odoo is via XML data files: The broad structure of an XML data file is the following:

• The nested root elements openerp and data
• Any number of operation elements within data

<!-- the root elements of the data file --> <openerp><data> <operation/> ... </data></openerp>

Data files are executed sequentially, operations can only refer to the result of operations defined previously

Core operations

record

record appropriately defines or updates a database record, it has the following attributes:

model (required)

name of the model to create (or update)

id

the external identifier for this record. It is strongly recommended to provide one

• for record creation, allows subsequent definitions to either modify or refer to this record
• for record modification, the record to modify

context

context to use when creating the record

forcecreate

in update mode whether the record should be created if it doesn’t exist

Requires an external id, defaults to True.

field

Each record can be composed of field tags, defining values to set when creating the record. A record with no field will use all default values (creation) or do nothing (update).

A field has a mandatory name attribute, the name of the field to set, and various methods to define the value itself:

Nothing

if no value is provided for the field, an implicit False will be set on the field. Can be used to clear a field, or avoid using a default value for the field.

search

for relational fields, should be a domain on the field’s model.

Will evaluate the domain, search the field’s model using it and set the search’s result as the field’s value. Will only use the first result if the field is a Many2one

ref

if a ref attribute is provided, its value must be a valid external id, which will be looked up and set as the field’s value.

Mostly for Many2one and Reference fields

type

if a type attribute is provided, it is used to interpret and convert the field’s content. The field’s content can be provided through an external file using the file attribute, or through the node’s body.

Available types are:

xml, html

extracts the field‘s children as a single document, evaluates any external id specified with the form %(external_id)s. %%can be used to output actual % signs.

file

ensures that the field content is a valid file path in the current model, saves the pair module,path as the field value

char

sets the field content directly as the field’s value without alterations

base64

base64-encodes the field’s content, useful combined with the file attribute to load e.g. image data into attachments

int

converts the field’s content to an integer and sets it as the field’s value

float

converts the field’s content to a float and sets it as the field’s value

list, tuple

should contain any number of value elements with the same properties as field, each element resolves to an item of a generated tuple or list, and the generated collection is set as the field’s value

eval

for cases where the previous methods are unsuitable, the eval attributes simply evaluates whatever Python expression it is provided and sets the result as the field’s value.

The evaluation context contains various modules (time, datetime, timedelta, relativedelta), a function to resolve external identifiers (ref) and the model object for the current field if applicable (obj)

delete

The delete tag can remove any number of records previously defined. It has the following attributes:

model (required)

the model in which a specified record should be deleted

id

the external id of a record to remove

search

a domain to find records of the model to remove

id and search are exclusive

function

The function tag calls a method on a model, with provided parameters. It has two mandatory parameters model and namespecifying respectively the model and the name of the method to call.

Parameters can be provided using eval (should evaluate to a sequence of parameters to call the method with) or value elements (see list values).

workflow

The workflow tag sends a signal to an existing workflow. The workflow can be specified via a ref attribute (the external id of an existing workflow) or a value tag returning the id of a workflow.

The tag also has two mandatory attributes model (the model linked to the workflow) and action (the name of the signal to send to the workflow).

Shortcuts

Because some important structural models of Odoo are complex and involved, data files provide shorter alternatives to defining them using record tags:

menuitem

Defines an ir.ui.menu record with a number of defaults and fallbacks:

Parent menu

• If a parent attribute is set, it should be the external id of an other menu item, used as the new item’s parent
• If no parent is provided, tries to interpret the name attribute as a /-separated sequence of menu names and find a place in the menu hierarchy. In that interpretation, intermediate menus are automatically created
• Otherwise the menu is defined as a “top-level” menu item (not a menu with no parent)

Menu name

If no name attribute is specified, tries to get the menu name from a linked action if any. Otherwise uses the record’s id

Groups

A groups attribute is interpreted as a comma-separated sequence of external identifiers for res.groups models. If an external identifier is prefixed with a minus (-), the group is removed from the menu’s groups

action

if specified, the action attribute should be the external id of an action to execute when the menu is open

id

the menu item’s external id

template

Creates a QWeb view requiring only the arch section of the view, and allowing a few optional attributes:

id

the view’s external identifier

name, inherit_id, priority

same as the corresponding field on ir.ui.view (nb: inherit_id should be an external identifier)

primary

if set to True and combined with a inherit_id, defines the view as a primary

groups

comma-separated list of group external identifiers

page

if set to "True", the template is a website page (linkable to, deletable)

optional

enabled or disabled, whether the view can be disabled (in the website interface) and its default status. If unset, the view is always enabled.

report

Creates a ir.actions.report.xml record with a few default values.

Mostly just proxies attributes to the corresponding fields on ir.actions.report.xml, but also automatically creates the item in theMore menu of the report’s model.

CSV data files

XML data files are flexible and self-descriptive, but very verbose when creating a number of simple records of the same model in bulk.

For this case, data files can also use csv, this is often the case for access rights:

• the file name is model_name.csv
• the first row lists the fields to write, with the special field id for external identifiers (used for creation or update)
• each row thereafter creates a new record

Here’s the first lines of the data file defining US states res.country.state.csv

"id","country_id:id","name","code" state_us_1,us,"Alabama","AL" state_us_2,us,"Alaska","AK" state_us_3,us,"Arizona","AZ" state_us_4,us,"Arkansas","AR" state_us_5,us,"California","CA" state_us_6,us,"Colorado","CO" state_us_7,us,"Connecticut","CT" state_us_8,us,"Delaware","DE" state_us_9,us,"District of Columbia","DC" state_us_10,us,"Florida","FL" state_us_11,us,"Georgia","GA" state_us_12,us,"Hawaii","HI" state_us_13,us,"Idaho","ID" state_us_14,us,"Illinois","IL"

rendered in a more readable format:

idcountry_id:idnamecode

state_us_1usAlabamaAL

state_us_2usAlaskaAK

state_us_3usArizonaAZ

state_us_4usArkansasAR

state_us_5usCaliforniaCA

state_us_6usColoradoCO

state_us_7usConnecticutCT

state_us_8usDelawareDE

state_us_9usDistrict of ColumbiaDC

state_us_10usFloridaFL

state_us_11usGeorgiaGA

state_us_12usHawaiiHI

state_us_13usIdahoID

state_us_14usIllinoisIL

state_us_15usIndianaIN

state_us_16usIowaIA

state_us_17usKansasKS

state_us_18usKentuckyKY

state_us_19usLouisianaLA

state_us_20usMaineME

state_us_21usMontanaMT

state_us_22usNebraskaNE

state_us_23usNevadaNV

state_us_24usNew HampshireNH

state_us_25usNew JerseyNJ

state_us_26usNew MexicoNM

state_us_27usNew YorkNY

state_us_28usNorth CarolinaNC

state_us_29usNorth DakotaND

state_us_30usOhioOH

state_us_31usOklahomaOK

state_us_32usOregonOR

state_us_33usMarylandMD

state_us_34usMassachusettsMA

state_us_35usMichiganMI

state_us_36usMinnesotaMN

state_us_37usMississippiMS

state_us_38usMissouriMO

state_us_39usPennsylvaniaPA

state_us_40usRhode IslandRI

state_us_41usSouth CarolinaSC

state_us_42usSouth DakotaSD

state_us_43usTennesseeTN

state_us_44usTexasTX

state_us_45usUtahUT

state_us_46usVermontVT

state_us_47usVirginiaVA

state_us_48usWashingtonWA

state_us_49usWest VirginiaWV

state_us_50usWisconsinWI

state_us_51usWyomingWY

For each row (record):

• the first column is the external id of the record to create or update
• the second column is the external id of the country object to link to (country objects must have been defined beforehand)
• the third column is the name field for res.country.state
• the fourth column is the code field for res.country.state