StarUML Odoo Addon Generator

This extension for StarUML support to generate Odoo code from UML model. Install this extension from Extension Manager of StarUML.

Get this extension as a .zip file after you purchase one.

Extract the zip file on the extensions path.

• for Mac OS: /Users/<user>/Library/Application Support/StarUML/extensions/user

• for Windows: C:\Users\<user>\AppData\Roaming\StarUML\extensions\user

• for Linux: ~/.config/StarUML/extensions/user
  

Check a folder in the extensions path and main.js file in the folder.

Restart StarUML.

Please check here for detailed instalation process of the extension:

• https://docs.staruml.io/user-guide/managing-extensions

1. Click the menu (Tools > Odoo > Generate Code...)

2. Select a base model (or package) that will be generated to Odoo

3. Select a folder where generated Odoo source files (.py, .xml, .csv) will be placed. This will be the addon folder name

Below are the rules to convert from UML model elements to Odoo source codes.

Configuration

• Click Tools > Odoo > Configure to set your addon setting

• Addon Name: is your addon folder name and act also as the namespace for your classes

• Dependecies: type your addon dependencies as comma separated string values, for example: "hr", "account", etc.

• Docstring: Yes or No to wether generate to documentation string on your class or not

• Installation Path: your python installation path (optional)

• Use Tab: whether you want to use Tab character instead of spaces on your python indentation

• Indent Spaces: number of indent spaces on your python code.
  

Odoo object name

• Odoo object name is the class field called _name on Odoo ORM

• Odoo object name is automatically generated based on "addonName" (namespace) and "className", eg "my_addon.my_object"

• you may force you Odoo object name different from your UML class name by creating an attributed called _name on the class and set the name on _defaultValue field, eg module.classname. This _name attribute is mandatory if you to inherit your Odoo object from another Object
  

Odoo inherit object

• If the object is inherted from other Odoo object, create a attribute called _inherit

• the parent object is set on defaultValue field, eg res.partner

Odoo fields

• Every attribute on UML class is converted into Odoo object field

• Set the Odoo field type on type field

• Example Char will be converted to fields.Char(), Integer to fields.Integer()

Odoo help attributes

• The Documentation field will be converted to help= attribute on Odoo field

UMLPackage

• converted to a python _Package_ (as a folder with `__init__.py`).

UMLClass, UMLInterface

• converted to a python Class definition as a separated module (`.py`).

•  documentation property to docstring

UMLEnumeration

• converted to a python class inherited from _Enum_ as a separated module (`.py`).

• literals converted to class variables

UMLAttribute, UMLAssociationEnd

• converted to an instance variable with Odoo relation type: Many2one, One2many, or Many2many

• name property to field name

• documentation property to field help attribute

• If `multiplicity` is one of `0..*`, `1..*`, `*`, then the variable will be initialized with:

• • `0..*` or `1..*` : fields.Many2one()

  • `1` : fields.One2many()

  • `*` : fields.Many2many()

UMLOperation

• converted to an instance method if `isStatic` property is true, or a class method (`@classmethod`) if `isStatic` property is false

• `name` property to identifier

• `documentation` property to docstring

• _UMLParameter_ to method parameter

• https://docs.staruml.io
  

• https://creately.com/blog/diagrams/class-diagram-relationships