Plugin: Fetch external metadata from URL

Purpose

This plugin enables you to fetch an external metadata configuration file from a publicly accessible URL at index time.

The external metadata must be in external-metadata.cfg format.

Usage

Enabling the plugin

Enable the external-metadata-fetcher plugin on your data source from the Extensions screen in the administration dashboard or add the following data source configuration to enable the plugin.

plugin.external-metadata-fetcher.enabled=true
plugin.external-metadata-fetcher.version=1.0
This plugin will take effect when the data source is updated.

Plugin configuration settings

The following options can be set in the data source configuration to configure the plugin:

  • plugin.external-metadata-fetcher.config.url_source: Defines the source URL for the external metadata configuration file.

  • plugin.external-metadata-fetcher.config.fail-on-error: Defines if the data source update should fail with an error if the plugin does not successfully download the external metadata from the URL source. If set to false, the update will continue ignoring the error and just log a warning. Default is true.

Example

To fetch external metadata from https://example.com/extmet.txt, configure the plugin with:

plugin.external-metadata-fetcher.config.url_source=https://example.com/extmet.txt

© 2015- Squiz Pty Ltd