Logo Help Center

Elvis 4 plug-ins introduction - configuration file

Elvis 4 plug-ins introduction - configuration file

A plug-in configuration file can be generally divided into 3 segments:

  1. General plug-in information (A)
  2. Generic schedule or action settings (B)
  3. plug-in specific settings (C).

This article describes the general plug-in information (A) and the structure of the plug-in specific settings (C). Generic plug-in settings (B) are discussed separately for schedule and action plug-ins.

Configuration file

<?xml version="1.0" encoding="UTF-8"?>
<plugin>
    <info>
        (A)
    </info>

    <schedule>
        (B)
    </schedule>

    OR

    <action>
        (B)
    </action>

    <config>
        (C)
    </config>
</plugin>

General plug-in information (A)

This section describes the basic information of a plug-in, like version and documentation info. The plug-in developer usually specifies this information.

<info>
    <version>
(1)     <pluginVersion>...</pluginVersion>
(2)     <requiresAtLeast>...</requiresAtLeast>
(3)     <testedUpTo>...</testedUpTo>
    </version>
(4) <description>...</description>
(5) <documentationUrl>...</documentationUrl>
(6) <basePluginPath>...</basePluginPath>
</info>
  • (1) pluginVersion - optional. Version of the plug-in, this can be any String value. The bundled plug-ins use a [major].[minor] format, starting with 1.0.
  • (2) requiresAtLeast - optional. Minimum server version required to run the plug-in. A warning will appear in the plug-in admin if the current version does not meet this requirement, the plug-in will not be disabled. The Elvis version number needs to be fully specified, [major].[minor].[revision].[build], for example: 2.6.1.550.
  • (3) testedUpTo - optional. Specifies up to which version the plug-in is tested. A warning will appear in the plug-in admin if the current version is greater than the value specified, the plug-in will not be disabled. The Elvis version number needs to be fully specified, [major].[minor].[revision].[build], for example: 2.6.1.550.
  • (4) description - optional. Brief and functional plug-in description.
  • (5) documentationUrl - optional. URL to the plug-in documentation.
  • (6) basePluginPath - optional. Path to the base plug-in, relative to <Config>/plugin_base. Several bundled plug-ins have most of their logic defined in the plug-in_base. This is convenient for upgrading bundled plug-ins and it prevents code duplication when you have multiple instances of the same plug-in running.

plug-in specific settings (C)

This section optionally contains plug-in specific configuration settings. A plug-in developer can specify the configuration settings, an administrator will be able to specify values.

One or more properties can be defined.

<config>
(1) <property name="...">
(2)     <description>...</description>
(3)     <value>...</value>
    </property>
</config>
  • (1) name - required. Name of the property, this name must be unique for the plug-in. A valid name may contain characters _, a-z, A-Z and 0-9 but may not begin with 0-9.
  • (2) description - optional. Short property description, try to keep it to a single sentence. The plug-in documentation is a good place for a longer description.
  • (3) value - required. Property value.
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.