Groovy Scripts

Context

Groovy Scripts are used as extension scripts that can be executed when a particular event is triggered.

Some of the events can be

For any groovy script the following are configurable

Different types of groovy scripts that can be configured are

The standard extension file names cannot be changed. The reason for referring them standard is that they need not be explicitly configured. Names are standard. Only implementation of the script can be customised.
If the file is present, by default it will be executed when the respective event is triggered.
Some of those extensions are
- BahmniObsValueCalcuator
- TreatmentRegimenExtension

File Name	Location and Example File	Note
BahmniObsValueCalculator.groovy	Location of the file is /var/www/bahmni_config/openmrs/obscalculator/ Sample BahmniObsValueCalculator.groovy file	This groovy script is executed on click of consultation save button. This file should implement ObsValueCalculator. Override the run() method according to the requirement.
TreatmentRegimenExtension.groovy	Location of the file is /var/www/bahmni_config/openmrs/treatmentRegimenExtension/ Sample TreatmentRegimenExtension.groovy file	This groovy script is executed before displaying the "Chronic Treatment" Control. This file should extend BaseTableExtension<TreatmentRegimen>. Override the update() method according to the requirement.

Groovy extensions that can have custom files along with custom implementation.
Display controls such as Obs To Obs Flowsheet have flexibility to have custom extensions.
These scripts are triggered when displaying the display control under which the extension is configured.

Example

If One Configures, DstExtension.groovy under ObsToObsFlowSheet Control (Refer Sample Config), then the groovy is executed while the control (ObsToObsFlowSheet Control) is displayed.

Configuration	Location and Example	Note
Add the groovy extension name as value of key "type" under the configuration section of Display Controls#ObsToObsFlowShee	All these custom groovy files should be under /var/www/bahmni_config/openmrs/flowSheetExtension/ Please refer example for https://github.com/Bahmni/endtb-config/blob/master/openmrs/flowsheetExtension/DstExtension.groovy	This file should extend BaseTableExtension<PivotTable>. Override the update() method according to the requirement.

On this Page