OS4X Enterprise plugin configuration
Jump to navigation
Jump to search
Plugins may need an online configuration of parameters. These parameters, which are defined in every plugin, may be exported in a XML. This XML must be printed to stdout if the parameter "-x
" is given to the plugin.
Example:
localhost:/opt/os4x/bin $ ./os4xplugin_copy -x <?xml version="1.0" encoding="UTF-8"?> <OS4X_plugin_config> <configuration_parameters> <configuration_parameter> <name>targetpath</name> <type>0</type> <defaultvalue></defaultvalue> <comment>Target path for copied file. Leave empty for OS4X's temporary directory.</comment> </configuration_parameter> <configuration_parameter> <name>overwrite</name> <type>2</type> <defaultvalue>1</defaultvalue> <comment>Overwrite existing target file?</comment> </configuration_parameter> <configuration_parameter> <name>create_path</name> <type>2</type> <defaultvalue>1</defaultvalue> <comment>Create target path if unavailable?</comment> </configuration_parameter> </configuration_parameters> </OS4X_plugin_config>
A single configuration parameter has four nodes:
- name: Key string for this configuration parameter. It will never be printed out to the user and should be as short as possible.
- type: Numeric type of configuration value. Valid types are:
- 0: simple strings
- 1: numeric
- 2: boolean
- 3: date
- 4: password
- 5: binary large object (aka BLOB)
- defaultvalue: Default value if no other value is configured.
- comment: Text which is displayed in the configuration GUI.