Overview
This page documents the use of Workflow tools.
Prerequisites
- MySQL database must already exist (e.g. "mappingservicedb") and be loaded with terminologies, map projects, and map records.
- MySQL database connection parameters must be defined in the properties file specified by "run.config".
Details
These tools are used to clear and compute worfklow states. The "compute workflow" operation starts by clearing the workflow for that project so the other tools rarely needed.
Workflow should be recomputed any time the scope concepts may have changed, or external processes may have modified workflow in some way.
Following are some details about these tools:
Mojo: ComputeWorkflowLoaderMojo.java (in admin/mojo/src/main/resources/java/org/ihtsdo/otf/mapping/mojo)
Project: admin/loader
Configuration Parameters
- A profile of "ComputeWorfklow" must be passed
- run.config - the standard configuration file specified as a -D parameter
refset.id - the map project refset id to compute workflow for, specified as a -D parameter.
- send.notification - a flag indicating whether to send email upon completion specified as a -D parameter
- The recipient list is specified as the "send.notification.recipients" in the config file specified by run.config.
Mojo: ClearWorkflowRemoverMojo.java (in admin/mojo/src/main/resources/java/org/ihtsdo/otf/mapping/mojo)
Project: admin/remove
Configuration Parameters
- A profile of "ClearWorkflow" must be passed
- run.config - the standard configuration file specified as a -D parameter
refset.id - the map project refset id to clear workflow for, specified as a -D parameter.
Samples
Sample command line call to compute workflow for refset id 447563008 (and send notification):
% cd ~/code/admin/loader % mvn install -Drun.config=/home/ihtsdo/config/config.properties -PComputeWorkflow -Drefset.id=447563008 -Dsend.notification=true
Sample command line call to clear workflow for refset id 447563008:
% cd ~/code/admin/remover % mvn install -Drun.config=/home/ihtsdo/config/config.properties -PClearWorkflow -Drefset.id=447563008
Sample Eclipse run configuration to compute workflow for refset id 447563008:
Sample Eclipse run configuration to clear workflow for refset id 447563008:
Troubleshooting
These tools are safe to re-run. If anything goes wrong computing workflow states, simply clear them and compute it again.
References/Links
- n/a