Mandatory Module

A module that is marked as mandatory in OpenMRS is one that MUST be running at all times. If the module is not running data could be lost.

Using this flag means that the module is required and is not able to be stopped or removed using the admin screen. To unload a mandatory module, you must delete the module from the "modules" folder in the OpenMRS application data directory (usually docsandsettings/tomcatuser/application data/.OpenMRS/ or ~/.OpenMRS) and then restart tomcat.

How to Make Your Module Mandatory

Add "<mandatory>true</mandatory>" to the module's config.xml file after "updateURL".

Required OpenMRS Version

• OpenMRS 1.5.1 or greater than OpenMRS 1.6.0.8800
• The module config.xml file must be using at least config-1.3.dtd

See Also

• The sync module
• The mandatoryexample module
• The ticket TRUNK-1190 has all the technical details from when this feature was first written)