Naming conventions for workflow scripts

Managed by | Updated .

Workflow scripts are used to run custom actions before and after each update phase (gather, index, archive, etc.)

Workflow scripts should be stored inside a sub-folder of the collection configuration folder named @workflow (To be consistent with the @groovy folder for filters).

They should be named after the phase they're supposed to run in (e.g. pre_gather.sh, post_index.groovy, etc. to make them easy to identify at a glance. Examples:

$SEARCH_HOME/conf/COLLECTION/@workflow/pre_gather.sh
$SEARCH_HOME/conf/COLLECTION/@workflow/post_index.groovy

Filenames should be only lowercase alphanumeric, hyphen and underscore permitted between words.

Additional resources

Was this artcle helpful?

Tags
Type:
Features:

Comments