OneAgent and ActiveGate version 1.299 are the last versions supporting OneAgent and ActiveGate Extensions 1.0 framework. You can continue using Extensions 1.0 if you stay at OneAgent or ActiveGate version 1.299. Note that this means you'll be using an unsupported Python version 3.8. We strongly recommend migrating your extensions to the latest Extensions 2.0 framework.
For more information, see General guidance and how to migrate.
The extension SDK provides you with all the resources and means necessary to develop your own extensions. To get started with the extension SDK, follow the steps below.
You'll use the same extension SDK for both, OneAgent and ActiveGate extensions.
Extract the downloaded ZIP file. It contains docs, examples, and the whl file that's required for installation (for example, plugin_sdk-1.156.0.20181003.61122-py3-none-any.whl).
You need the following to install the SDK:
To install your downloaded SDK use:
pip3 install plugin_sdk-version.whl
For example:
pip3 install plugin_sdk-1.156.0.20181003.61122-py3-none-any.whl
Once you've written your extension, you can use the SDK to build it and upload it to the server. If you want to simply validate your plugin.json file type:
plugin_sdk build_plugin --no_upload
If you want to upload your extension to the server, type:
plugin_sdk upload_plugin -t yourtoken
For your extension development, you can also use the extension simulator.
If after deploying your extension the results are different from your expectations, check troubleshooting to find out what went wrong.
Following successful deployment, you should see your extension ready for configuration.
The Extensions how-to topics will guide you through the key concepts of extension development with examples and working code snippets to facilitate your own extension development.