wiki:MolgenisLanguageReference

Version 1 (modified by Morris Swertz, 15 years ago) (diff)

--

MOLGENIS Database definition language ('*_db.xml' files)

<molgenis> application defintion element

The <molgenis> element is the root of each MOLGENIS application definition file and can contain data definition and/or user interface definition elements. The model can be split, i.e. there can be multiple MOLGENIS XML files for one application (see section on molgenis.properties file). Example usage of the <molgenis> element:

<molgenis name="myfirstdb" label="My First Database">
  <menu name="mainmenu"> ...
  <entity name="firstentity"/>
  <module name="mymodule"/>
  ...
</molgenis>

Required attributes of the <molgenis> element

  • name="name": name of your MOLGENIS blueprint. This will be used by the generator to name the java packages that are generated..

Optional attributes of the <molgenis> element

  • label="your label": Label of your MOLGENIS system. This will be shown on the screen as well as heading in the generated documentation.
  • Version=”1.2.3”: Version of your MOLGENIS system. It is recommended to use this to manage the versions of your application.

The <molgenis> element can contain other elements:

  • Exactly one <menu> or one <form> as main screen.
  • Zero or one <description> elements describing the application
  • Many <entity> elements describing the data structure.
  • Many <module> elements describing the data structure. These are containers to group <entity>.