Extension Packs¶
An extension pack bundles ready-made setup into one file that another system can install. It holds data only.
What a pack can carry¶
| Key | What it is |
|---|---|
workflow_rules |
Workflow rules: name, trigger and its config. They arrive switched off and owned by whoever installs them. |
reports |
Report Builder reports: name, source and config. |
document_templates |
Document template settings by doc_key, such as Issue Invoice or stock:transfer. |
form_settings |
Input form settings: form_key, input_key, visible, placeholder, default_value, required. |
numbering |
B2B document numbering: kind, prefix, digits. |
dashboard |
The maker's dashboard widgets, by key. |
The file¶
{
"format": "nbs-pack",
"version": 1,
"pack": {
"name": "Collections starter",
"description": "Chase overdue invoices automatically.",
"pack_version": "1.0",
"notes": "First release."
},
"publisher": {
"kind": "company",
"name": "Example Sdn Bhd",
"email": "hello@example.com",
"website": "https://example.com"
},
"contents": {
"workflow_rules": [
{ "name": "Chase at 30 days", "trigger": "invoice_overdue", "config": { "days": 30 } }
]
}
}
publisher.kind is company or individual.
Making one¶
Building a pack by hand is error-prone. Make one in the system instead:
- Set up the rules, reports and templates in a working system.
- Go to Marketplace > Publish Module and choose + Make a pack.
- Fill in About, pick the Contents, check the Review, then choose Download file.
Installing one¶
Install a pack checks the file first and shows what it adds, what it needs (for example a module that isn't switched on) and what it leaves out. Nothing is installed until the user agrees. What the pack added or changed is remembered, so Remove puts things back as they were.