Flectra 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.
The main way to define data in Flectra is via XML data files: The broad structure of an XML data file is the following:
- Any number of operation elements within the root element
<!-- the root elements of the data file --> <?xml version="1.0" encoding="UTF-8"?> <flectra> <operation/> ... </flectra>
Data files are executed sequentially, operations can only refer to the result of operations defined previously
If the content of the data file is expected to be applied only once, you
can specify the flectra flag
noupdate set to 1. If part of
the data in the file is expected to be applied once, you can place this part
of the file in a <data noupdate=”1”> domain.
<flectra> <data noupdate="1"> <!-- Only loaded when installing the module (flectra-bin -i module) --> <operation/> </data> <!-- (Re)Loaded at install and update (flectra-bin -i/-u) --> <operation/> </flectra>
record appropriately defines or updates a database record, it has the
- name of the model to create (or update)
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 to use when creating the record
in update mode whether the record should be created if it doesn’t exist
Requires an external id, defaults to
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).
field has a mandatory
name attribute, the name of the field to set,
and various methods to define the value itself:
- if no value is provided for the field, an implicit
Falsewill be set on the field. Can be used to clear a field, or avoid using a default value for the field.
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
refattribute is provided, its value must be a valid external id, which will be looked up and set as the field’s value.
typeattribute 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
fileattribute, or through the node’s body.
Available types are:
- extracts the
field’s children as a single document, evaluates any external id specified with the form
%%can be used to output actual % signs.
- ensures that the field content is a valid file path in the current
model, saves the pair
module,pathas the field value
- sets the field content directly as the field’s value without alterations
- base64-encodes the field’s content, useful combined with the
fileattribute to load e.g. image data into attachments
- converts the field’s content to an integer and sets it as the field’s value
- converts the field’s content to a float and sets it as the field’s value
- should contain any number of
valueelements 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
for cases where the previous methods are unsuitable, the
evalattributes simply evaluates whatever Python expression it is provided and sets the result as the field’s value.
The evaluation context contains various modules (
relativedelta), a function to resolve external identifiers (
ref) and the model object for the current field if applicable (
delete tag can remove any number of records previously defined. It
has the following attributes:
- the model in which a specified record should be deleted
- the external id of a record to remove
- a domain to find records of the model to remove
search are exclusive
function tag calls a method on a model, with provided parameters.
It has two mandatory parameters
name specifying 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
<flectra> <data noupdate="1"> <record name="partner_1" model="res.partner"> <field name="name">Odude</field> </record> <function model="res.partner" name="send_inscription_notice" eval="[[ref('partner_1'), ref('partner_2')]]"/> <function model="res.users" name="send_vip_inscription_notice"> <function eval="[[('vip','=',True)]]" model="res.partner" name="search"/> </function> </data> <record id="model_form_view" model="ir.ui.view"> </record> </flectra>
Because some important structural models of Flectra are complex and involved, data files provide shorter alternatives to defining them using record tags:
Creates a QWeb view requiring only the
section of the view, and allowing a few optional attributes:
- the view’s external identifier
- same as the corresponding field on
inherit_idshould be an external identifier)
- if set to
Trueand combined with a
inherit_id, defines the view as a primary
- comma-separated list of group external identifiers
- if set to
"True", the template is a website page (linkable to, deletable)
disabled, whether the view can be disabled (in the website interface) and its default status. If unset, the view is always enabled.
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.
- the file name is
- the first row lists the fields to write, with the special field
idfor 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
"id","country_id:id","name","code" state_au_1,au,"Australian Capital Territory","ACT" state_au_2,au,"New South Wales","NSW" state_au_3,au,"Northern Territory","NT" state_au_4,au,"Queensland","QLD" state_au_5,au,"South Australia","SA" state_au_6,au,"Tasmania","TAS" state_au_7,au,"Victoria","VIC" state_au_8,au,"Western Australia","WA" 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"
rendered in a more readable format:
|state_au_1||au||Australian Capital Territory||ACT|
|state_au_2||au||New South Wales||NSW|
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
- the fourth column is the