Guide - EDL Modeling Style Guide


This guide describes the conventions for working with EDL models.

Related Documents


Model Files

  • Define every complex type (e.g. orm class, capi interface, ...) in its own *.edl file.
  • Store the *.edl files in a separate folder in the cartridge, e.g., in the edl folder.
  • Create a folder structure according to the namespace of the EDL types, like:

Formatting Conventions

  • Use 4 spaces instead of tabs.
  • Do not use special characters in comments (use plain english).
  • Use a coding style similar to the Java programming conventions, see Guide - Java Source Code Style Guide.

Naming Conventions

  • Use the suffix PO for ORM classes (stands for persistent object).

Order of Elements

Arrange the members of a class in the following order, from top to bottom:

  1. Contraints: primary key, alternate key, semantic key, index declarations
  2. Attributes: all attributes
  3. Relations: all relations
  4. Operations: all operations


The order of attributes and relations matters. This is important for the generated code in several places, like the order of mandatory parameters in the create-methods of ORM factories.

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to if you experience login issues,
or if you want to register as customer.