| title | Process Plugin Definition |
|---|---|
| icon | creative |
In order for the DSF BPE server to load a plugin properly, it needs to provide the following information in what is called the process plugin definition:
- A plugin version
- A release date
- A plugin name
- The BPMN model files
- The FHIR resources grouped by BPMN process ID. A plugin may have any number of BPMN models. Each has their own BPMN process ID and FHIR resources specific to that BPMN process (like Task resources needed for messages specific to that BPMN model)
- The Class holding a Spring Framework Configuration
To provide this information, one of the classes in the process plugin has to implement the dev.dsf.bpe.ProcessPluginDefinition interface. The DSF BPE server then searches for classes implementing this interface using the Java ServiceLoader mechanism. Therefore, the class also needs to be registered in the src/main/resources/META-INF/services/dev.dsf.bpe.v2.ProcessPluginDefinition file. An example of this can be found in the process plugin tutorial.
It is recommended to extend the AbstractProcessPluginDefinition class which already implements some of the methods required by the interface and forces a configuration of the plugin that wards against potential inconsistencies between the Java code and pom.xml, while also setting the foundation for reproducible builds.