...
In this document, we name the new plugin plugin_sampleSamplePlugin.
SDK
You can get the SDK from the OEM Portal. Alternatively, contact support@graebert.com.
...
The plugin licensing requires the following files to run in application as a plugin extension:
plugin_sampleSamplePlugin.xml configuration file
plugin_sample SamplePlugin folder which contains all dependent modules for this plugin.
...
X64 → c:\Program Files\Graebert GmbH\ARES Commander 20XX\Plugins
X86 → c:\Program Files (x86)\Graebert GmbH\ARES Commander 20XX\Plugins(x86 only supported until ARES Commander 2022 SP3.1)
...
SamplePlugin.xml
The configuration file plugin_sampleSamplePlugin.xml is responsible for loading the correct module(s) of your plugin.
...
Item | Description |
|---|---|
name | The name of the plugin. You can use any name. |
version | Any version of your plugin. |
id | The unique identifier of the plugin. You can get the plugin ID from Graebert GmbH. The licensing process requires the plugin ID. |
api-level | The API version of the core, which depends on the ARES Commander release version. For example, for ARES Commander 2019, api-level is 2019. |
module | You can specify one or more modules that you want to load. If you do not specify the modules, the loader assumes it is a TX module. You can also load FRX, LISP modules and .NET assemblies when you add the parameter type="managed". Additionally, it is possible to load customization files such as MNU, MNI, MNS, CUIX, CUI, or XML. |
supportpath | You can specify a support path ( which will be added to the ARES support paths ). Now the modules/files at this path can be accessed without specifying complete path again. |
plugin_sampleSamplePlugin.xml also supports Windows Environment Variables like %HOME%, %TEMP% , %APPDATA% etc, . and ARES specific Environment Variables like %FX_APPDATA_PATH% ,%FX_APPLICATION_PATH%, %FX_TEMP_PATH% etc., as can be seen in the plugin_sampleSamplePlugin.xml above.
Plugin Licensing API
...