All quality software must be shipped with documentation to understand how it works and be able to use all features.

MRules development team considers this as essential. Our documentation is therefore intended for all stakeholders in the projects integrating our software. For this, different levels of detail and different user perspectives are addressed.

You will find in this page a summary of all online documentation, grouped by product.

Global Documentation

• The Our Products section provides an overview of our products and their interactions.
• You may also discover all extensions and demonstrations which are shipped with MRules. The provided source code will allow you to learn by example and to easily start you first projects.
  • Specifically, the details of the configuration grammar offered by the DSL extension for the business rule engine is available here.
• Finally, the Javadoc section opens the standard Java documentation for developers. The Javadoc for older releases can be found here.

Framework Documentation

• The Architecture section provides an overview of the library, its components and interactions with other software components.
• The Logging and Data Access and Conversions sections allow to give more details on the technical frameworks on which the operation and performances of the library are based.

Business Rule Engine Documentation

• These two articles provide generic informations on which business cases are adapted to the usage of MRules and on our position compared to other types of rule engines.
• The Architecture section provides an overview of the library, its components and interactions with other software components.
• The Integration section provides details on the configuration and how to create or use a rule engine instance.
  • The Life Cycle section presents the differents phases in the life of a ruleset.
  • In the following section, you will see how to Build the Ruleset Instance.
  • Here, you will learn how to store the configuration of your ruleset.
  • After building it, you will need to Access the Instance.
  • And finally, a Tutorial to summarize all the integration steps and to illustrate the usage of MRules in an application.
• The Addons section describes the different components integrated natively in the library.
  • The Accessors.
  • The Conditions.
  • The Operators.
  • The Executables.
  • The Callables.
  • The Context Factories.
  • For all the addons, a detailed index of their Properties.
  • And finally, an example of how to develop your own Addons to cover specific needs.
• The Variables section details variables usage, wether they are global or local.

Grammar Engine Documentation

• The Architecture section provides an overview of the library, its components and interactions with other software components.
• The documentation on how to create your own grammar is in preparation and will come soon.

Extensions and Demonstrations

• This page presents all our products extensions.
  • You can also read the details of our extension “Business Rule Engine DSL“.
  • And see the generated DSL grammar documentation.
• This page presents all our products demonstrations.