Help Center

Menu

workflow.publish_hook

Name of the publish hook Perl script

Key: workflow.publish_hook
Type: String
Can be set in: collection.cfg

Table of Contents

Description

This options specifies the path to the Perl script to execute when a file is edited or deleted in the Admin UI or Admin API.

When a file is edited, the script will be called with the following arguments:

  • source: Absolute path to the source file that was edited

  • dummy argument for backwards compatibility: A dummy argument for backwards compatibility in the form: `REMOTE[OS_SPECIFIC_FILE_SEPARATOR][FILE_NAME]. This can be ignored.

  • message: Publication message containing the user id and host on which the publication occurs.

When a file is deleted the script will be called with:

  • --delete: To specify that it’s a delete operation

  • source: Absolute path to the file being deleted

  • message: Publication message containing the user id and host on which the deletion occurs.

Default Value

There’s no publish hook by default

Examples

Call a specific publish hook script:

workflow.publish_hook=$SEARCH_HOME/bin/my-hook.pl

Call the provided publish hook for multiple query processor setups:

workflow.publish_hook=$SEARCH_HOME/bin/publish_hook.pl