Plan before you build

Decision guides for the choices that are cheap to make before you write code and expensive to change after — which platform surface a job belongs on, and why.

These guides help with choices you make once, early, and live with for the rest of the project. Two of them, Choose an event surface and Choose where the logic goes, compare the options the platform offers for one job, say what each is for and what it is not, and end in a decision you can write into a design document. Choose a system of record is a short procedure that ends in an ownership matrix. None of them has you build a feature; the guides in the other paths do that, and each guide below points at the one that acts on its decision.

The guides

They are independent, so start with the question you have. Guides 1 and 2 often belong together: placing logic usually raises the question of how it hears about a change.

  1. Choose an event surface — reacting to something that happened on a tenant: a webhook to your own server, an Integration Studio workflow, an App handler, or no event at all.
  2. Choose where the logic goes — an App, a Theme, an Integration Studio workflow, your own service or an override: four questions that pick one, and eight typical requirements with where each lands.
  3. Choose a system of record — connecting an ERP, PIM or CRM: which system is the master of products, prices, stock, companies, contacts and orders, which key joins the two sides, and which import mode is safe.

Where to go next

  • Events — the platform event stream every event surface reads from.
  • Import and export — the bulk route and its import modes.
  • Apps and sites — the first split: business logic in an App, the front end in a Theme.
  • Size a launch — once you have decided, size the request budget, batch calls and warmup against the platform's limits before launch.
  • Operate & go live — once the plan is built, settle what has to be true before launch.
Was this page helpful?