DevelopersPre-alpha

Creating an addon

How to use sumeru-bp, place an addon on addons_path, generate imports, install and update it.

Overview

Addons live under sumeru_custom_addons/addons/. Scaffold with make new MODULE=… (or sumeru-bp), declare models with sdk.Model tags, list XML in the manifest, run make generate, then install.

Workspace. Work from sumeru_custom_addons (Go 1.26.2+, PostgreSQL). Default HTTP port is 8080.

Scaffold with sumeru-bp

Use the workspace tab for client work. Name flag aliases: -name, -bp, -boilerplate, -blueprint.

workspace · preferred

$cd sumeru_custom_addons$make new MODULE=my_module$make install MODULES=my_module

$cd sumeru$make bp NAME=my_module$make generate

Workspace make new runs sumeru-bp then make generate (writes zmodels.go / zrefs.go; custom init.go is regenerated to models-only — put hooks in models/). Use Core make only when scaffolding inside the sumeru repo.

Generated module

Browse the scaffold for my_module. Click a file in the tree or sidebar. Same layout as sumeru_custom_addons/addons/my_module.

my_module scaffold

addons/my_module/ tree

addons/my_module/
├── 
├── 
├── models/
│   ├── 
│   └── zmodels.go
├── views/
│   ├── 
│   ├── 
│   ├── 
│   ├── 
│   └── 
└── security/
    ├── 
    └──

1{2  "name": "my_module",3  "display_name": "My Module",4  "version": "1.0.0",5  "author": "Your Company",6  "description": "Premium standard module for Sumeru ERP.",7  "depends": ["base"],8  "application": true,9  "data": [10    "security/security.xml",11    "security/sys.access.csv",12    "views/actions.xml",13    "views/form_view.xml",14    "views/list_view.xml",15    "views/kanban_view.xml",16    "views/menus.xml"17  ]18}

1// Package my_module provides business logic and module initialization.2package my_module3 4import (5	_ "sumeru_custom_addons/addons/my_module/models"6)

1package models2 3import (4	"sumeru/core/sdk"5)6 7// MyModule is the primary record for My Module.8type MyModule struct {9	sdk.Model `sumeru:"model=my.module"`10 11	Name        sdk.String  `sumeru:"required,index,string=Name"`12	Description sdk.Text    `sumeru:"string=Description"`13	Active      sdk.Boolean `sumeru:"default=true,string=Active"`14	Sequence    sdk.Integer `sumeru:"default=10,string=Sequence"`15}

1<?xml version="1.0" encoding="utf-8"?>2<sumeru>3    <data>4        <!-- Window Action -->5        <action id="action_my_module" type="window" model="my.module" name="My Module" view_mode="list,form,kanban">6            <help>7                <p class="sum-view-nocontent-smiling-face">8                    Create your first My Module!9                </p>10            </help>11        </action>12    </data>13</sumeru>

1<?xml version="1.0" encoding="utf-8"?>2<sumeru>3    <data>4        <view id="view_my_module_form" model="my.module" type="form">5            <header>6                <button name="action_confirm" string="Confirm" type="object" class="sum_highlight"/>7                <field name="active" widget="statusbar"/>8            </header>9            <sheet>10                <div class="sum_title">11                    <h1>12                        <field name="name" placeholder="Title..."/>13                    </h1>14                </div>15                <group>16                    <group>17                        <field name="sequence" string="Sequence"/>18                    </group>19                    <group>20                        <field name="active" string="Active"/>21                    </group>22                </group>23                <notebook>24                    <page string="Description" name="description">25                        <field name="description" placeholder="Internal notes..."/>26                    </page>27                </notebook>28            </sheet>29        </view>30    </data>31</sumeru>

1<?xml version="1.0" encoding="utf-8"?>2<sumeru>3    <data>4        <view id="view_my_module_list" model="my.module" type="list">5            <field name="sequence" widget="handle"/>6            <field name="name"/>7            <field name="active" widget="boolean_toggle"/>8        </view>9    </data>10</sumeru>

1<?xml version="1.0" encoding="utf-8"?>2<sumeru>3    <data>4        <view id="view_my_module_kanban" model="my.module" type="kanban">5            <field name="name"/>6            <templates>7                <t t-name="kanban-box">8                    <div class="sum-kanban-global-click">9                        <div class="sum-kanban-details">10                            <strong class="sum-kanban-record-title">11                                <field name="name"/>12                            </strong>13                            <div>14                                <field name="description"/>15                            </div>16                        </div>17                    </div>18                </t>19            </templates>20        </view>21    </data>22</sumeru>

1<?xml version="1.0" encoding="utf-8"?>2<sumeru>3    <data>4        <!-- sys.menu.name is globally unique; each label must differ from other addons (e.g. base "Configuration"). -->5        <menuitem id="menu_my_module_root" name="My Module" sequence="20" web_icon="shield" />6 7        <menuitem id="menu_my_module_category" name="My module organization" parent="menu_my_module_root"8            sequence="100" />9 10        <menuitem id="menu_my_module_action" name="My module records" parent="menu_my_module_category"11            action="action_my_module" sequence="10" />12    </data>13</sumeru>

1<?xml version="1.0" encoding="utf-8"?>2<sumeru>3    <data>4        <!-- Module Category -->5        <record id="module_category_my_module" model="sys.module.category">6            <field name="name">My Module</field>7            <field name="sequence">100</field>8        </record>9 10        <!-- User Group -->11        <record id="group_my_module_user" model="core.group">12            <field name="name">User</field>13            <field name="category_id" ref="module_category_my_module"/>14            <field name="implied_ids" eval="[(4, ref('base.group_user'))]"/>15        </record>16 17        <!-- Manager Group -->18        <record id="group_my_module_manager" model="core.group">19            <field name="name">Manager</field>20            <field name="category_id" ref="module_category_my_module"/>21            <field name="implied_ids" eval="[(4, ref('group_my_module_user'))]"/>22        </record>23    </data>24</sumeru>

1id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink2access_my_module_user,my_module.user,my.module,group_my_module_user,1,0,0,03access_my_module_manager,my_module.manager,my.module,group_my_module_manager,1,1,1,1

Compile and run

Ensure ./addons is on addons_path in sumeru.conf.
make generate refreshes addonimports/zimports.go.
Install with -i, then serve on http://localhost:8080.

Install & run

from sumeru_custom_addons

$make generate$go run . -- -c sumeru.conf -i my_module --stop-after-init$make run

What not to do

Do not put client modules inside sumeru/ or sumeru_addons/. Keep those pull-only.
Do not skip make generate after adding or removing an addon folder.
Do not call RegisterModel / implement ModelName() in model files — zmodels.go is generated.
Do not hand-edit zmodels.go or zrefs.go.
Do not ship scaffold groups/CSV without reviewing who can write and unlink.

Next step

Map the three repos in Project structure. Workspace Makefile detail: Custom addons workspace.