2.3 Why a Manifest?

A manifest is the key XML file in which your application declares:

  1. Basic information about itself (name, version, author, contact details, etc.).

  2. Mandatory interface methods for communication with the core – these include ping, enroll, remove, section, response, and alert.

  3. Public API endpoints (if any) that should be published via the Retailys API Gateway.

  4. Entity definitions for Datanest (in <datanest:section>), if your application needs to store or manage data.

  5. Dashboard configuration (in <dashboard:section>), if you want your application’s GUI to appear within the universal administration interface (the Retailys Dashboard).

Essentially, the manifest acts as a single source of truth for both the Retailys core and other modules (e.g., Datanest, Dashboard). Once your manifest is registered, the system automatically adapts to your application - creating database tables for you (if needed), wiring up public endpoints, and adding routes/menus to the Dashboard if configured.

Last updated