Skip to content

Cetmix Tower YAML

Cetmix Tower YAML module is the core module that implements YAML interface for Cetmix Tower.
It allows to export and import Cetmix Tower records to/from YAML files and serves as an engine for other modules, such as Cetmix Tower Git.

Video Tutorial

Here is a short video showing how to export and import data from/to Cetmix Tower using YAML files.

Installation

To use these functionalities, you must have the Cetmix Tower YAML cetmix_tower_yaml module installed. For further details, please refer to the Installing the Modules section of the documentation.

Access Rights

Special access rights are required to use YAML export/import. Please refer to the Access Rights section of the documentation for more details.

Data Export to YAML

1. Open the record you want to export, switch to the YAML tab and click the Export Yaml button.

Export Yaml

Warning

If there is no YAML tab in the record form, that mean that the record does not support YAML export.
Also please ensure that you have refreshed the page after enabling "Import YAML" in the user settings.

2. A wizard will open where you can configure the export options.

Export Yaml Wizard

Field Description
Comment Optional text that will be added in the top of the YAML file as a comment.
Explode Child Records If enabled, the child records will be exported completely, including all their fields and sub-records.
If disabled, only record references will be exported.
Remove Empty Values If enabled, the empty values of Many2many, One2many and Many2one fields will be removed from the YAML file. This allows to reduce the size of the YAML file and to avoid errors when importing the data.

3. Click the Generate YAML file button. Download the file from the pop up form that opens next.

Export Yaml Result

Data Import from YAML

1. Go to Cetmix Tower > Tools > Import YAML.

Import Yaml

2. Upload the YAML file and click the Process button.

Import Yaml Import Yaml

3. A wizard will open where you can configure the import options.

Import Yaml Wizard

Field Description
Model The model to which this record belongs. Detected automatically.
Update Existing Record If there is a record with the same reference in the database, this option allows to update the existing record with the data from the YAML file.
If disabled, a new record will be created instead.

4. Click the Create New Record or Update Existing Record button. Created or updated record will form view be opened.

Import Yaml Result