You can find the SDK Documentation here and also under the /Docs directory in your AppScan Installation directory.
To begin writing your own extension, you first have to add the following namespaces to your project's source code:
- Watchfire.AppScan;
- Watchfire.AppScan.Scan;
- Watchfire.AppScan.Events;
- Watchfire.AppScan.Extensions;
- Watchfire.AppScan.Scan.Events;
This is done by adding the following lines of code in the beginning of your source file:
using Watchfire.AppScan;
using Watchfire.AppScan.Scan;
using Watchfire.AppScan.Events;
using Watchfire.AppScan.Extensions;
using Watchfire.AppScan.Scan.Events;
In addition, you should add AppScan's Public SDK DLL (C:\Program Files\Watchfire\AppScan\AppScanSDK.dll) to your project's References.
Adding AppScan's Public SDK to your projects References
Adding AppScan's Public SDK to your projects References
In order to supply extension information, your project may include an XML file (should be named "info.xml"), containing information that will be presented in the Extension Manager (more information in next section and the sample code below).
Your new AppScan eXtension should implement the IExtensionLogic interface (see Figure 3: IExtensionLogic interface below).
There are 3 different ways for the extension to integrate into AppScan as defined by the interface:
- On initialization: when AppScan starts, it loads the extension, and calls its Load() method
- As part of Load() implementation: the extension may register to handle SDK events, so when the events are raised, extension code is executed
- User actions: the extension (optionally) defines menu entries to be displayed in AppScan's menus. When a user selects an entry, a designated extension code is executed.
IExtensionLogic interface UML (Large View)