Appearance
Studio user guide
ERP Studio is where you design everything a tenant runs on: data, screens, forms, logic, workflows, security and the plugins that carry them between environments. This guide is for two readers:
- Designers build with visual designers and never need to write code.
- Developers add Java or Node code, run builds and tests, control backend services, and use the command line or an AI agent.
Every designer page follows one template: what it is, when to use it, concepts, a problem statement, a real example, all features, step by step, how to check it worked, common mistakes and related topics. Features that do not exist yet are marked Planned so you can see what is coming.
Start here
| I want to... | Read |
|---|---|
| Find my way around | A tour of Studio, Screen reference |
| Understand the words and the architecture | Concepts |
| Build my first plugin | Create a plugin, Check, build and publish |
| Build a whole application, step by step | Build a complete application, Capstone: Leave Management |
| Find the answer to a specific problem | Solutions: how do I...? |
| Follow a guided example | Tutorials |
The designers
| Area | Pages |
|---|---|
| Plugins | Plugin Designer, Create, Publish, Backend services, Customize |
| Screens | Pages, Forms, Blocks, Dashboards, Themes, Menus and navigation |
| Data | Entities, Providers, views, services, API Designer |
| Logic | Business logic, Workflows and rules, Events and automation, Jobs, Queues (planned) |
| Connect | Integrations, Reports and print |
| Secure | Security Designer, Security scanning (planned) |
| Code and AI | Code extensions, AI Designer, AI assistant |
| Quality and release | Testing, Versioning, Deployment, Monitoring, Marketplace |
| Reference | Reference, Command line and MCP, Documentation generator (planned), Troubleshooting |
Before you start
- You can sign in to Studio (the Open ERP Studio tile on the launcher). Studio opens for accounts with the Studio Staff role; a tenant's administrator gets it at registration.
- Building, compiling, testing and publishing plugins, and writing source code, need only the Studio Staff role. They depend on no application permission (not HCM). Because the builder can write and run code, treat Studio Staff as a developer-level role; a narrower dedicated role is planned.
- A modern browser, 1280 px or wider. The pages you build are mobile first and preview at phone width.
This guide is published at docs.sparkerp.globalsoftx.com/studio/.