Downloading/Installing Dependencies
Requirements
UIP Plugin
You may already have the UIP plugin installed if you went through the Extension Development tutorial. If not, open Visual Studio Code's extension marketplace and download the UIP plugin.
Sample Extension
In subsequent documents, the debugging functionality will be demonstrated using a sample extension. The extension is contrived, but it is sufficient to demonstrate the major capabilities.
Go ahead and download DebuggingDemo.zip attached below. Make sure to save it in a known location.
Universal Extension Bundle (v2.0.0)
As mentioned in the previous page, the debugging functionality makes use of the same Universal Extension Base Class Components that are used by the Agent/Controller.
To achieve this, the plugin requires a proprietary zip file containing the Universal Extension Base Class code for all the supported API levels (1.0.0, 1.1.0, 1.2.0, 1.3.0, and 1.4.0) mentioned in the previous page. The zip file is available for download from the Stonebranch Customer Portal. A customer username and password – provided by Stonebranch, Inc. – are required to access the Customer Portal.
Go ahead and download the universal_extension_bundle_2.0.0.zip file from the customer portal and save it in a known location. It will be used in subsequent pages.
If you have set up the plugin to use universal_extension_bundle_1.2.0.zip from the previous release, it will continue to work as long as the API level selected is less than 1.4.0. If you wish to debug extensions with API level 1.4.0, universal_extension_bundle_2.0.0.zip will be needed.
debugpy PIP module
The debugpy module is required for VSCode's Python debugger (client) to connect to the Extension Python process (server).
The plugin has built-in prompts and logic to install this pip module automatically. Nothing needs to be done right now.