Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. The Developer Center continues to support Commerce 6.13.0 through 7.4.1.Visit new site

Introduction to Helix

Introduction to Helix

The Helix programming model for the Cortex API is a new, faster way of developing resources for the Cortex API.

Helix resources fundamentally work in the same way as legacy Cortex resources, with a few key differences designed to improve the development experience:
  • The concept of resource prototypes streamlines the development process: simply define the API using the API definition language, generate the prototype, and implement it.
  • Resource operation implementation is simplified by the introduction of operation interfaces. The only part you have to implement is the CRUD operation itself, with all other wiring handled by the prototype's generation process.
  • One prototype class per resource operation allows for a clearer definition of a class' responsibilities. Code is easier to understand and more lightweight to implement.
  • Hot deployment of bundles into the Cortex webapp allows for rapid prototype development and testing.
To understand the basics of Helix development, see the following documentation:
  • Cortex Call Stack - Shows the differences between how Helix resources and legacy resources interact with the Commerce Engine call stack.
  • Creating your First Helix Resource- Describes the end-to-end process of developing a Helix resource, as well as how to debug and address errors when developing.
  • Working with Mixed Models - An overview of some issues you might encounter while working with Helix resources, and how to navigate them.
  • Tutorials - Step-by-step tutorials for common development tasks, with working example code and exercises.
  • Helix Pattern Library - Working implementations of common Helix resource types and associated documentation.