System extensions are compiled developer code (using the DatStat Software Developers Kit – SDK) that implement hook interfaces to perform custom tasks when various events occur, or display custom data in the “Custom Reports” section of Discovery. A hook developer will create a DLL that implements one or more interfaces exposed through the DatStat SDK. That DLL can then be registered in the system through the “System Extensions” section of the Enterprise Manager. When a user wants to upload a DatStat SDK DLL, they must choose a unique name to identify the System Extension, check whether the System Extension is enabled, and choose the projects to which the System Extension will be made available. When editing a System Extension, the User can choose to overwrite the existing DLL by choosing a new DLL to upload. This is not required when editing an existing System Extension and if none is selected, the existing DLL will not be changed.
Once registered in the system, various items within Studys can subscribe to hooks contained in that System Extension. When a User edits a Study, for example, that Study can make use of any hook in any System Extension that is made available to that Study’s project. These hooks will show up in two places: on the “System Extensions” tab when editing a Study, and when adding new actions to an event.
NOTE: System Extensions will only be available if the SDK and Discovery are included in the customer license.
Registering a System Extension
- Login into DatStat Gateway and navigate to the Enterprise Manager
- Click the System Extensions link
- Under Take Action select Add Custom Extension
- Name the Extension
- Browse to the appropriate DLL
- Select the Appropriate Projects for this Extension
- Click Save and OK
The Extension will appear in the System Extensions Data Grid
Edit Custom Extension
Clicking on the Edit Custom Extension icon in the Data Grid will allow the User to Edit the information about the Extension and provide information about that Extension.
Enabling a System Extension in a Study
Once the System Extension has been registered within the Enterprise Manager and made available to the required Projects, it needs to be enabled within that Study.
NOTE: If an SDK User has not been created for this Extension, one must be created prior to enabling the extension.
Steps:
- Within the Enterprise Manager
- Expand the appropriate Project
- Select Studies
- Select the Edit Study Icon for the appropriate Study
- Click on the System Extensions Tab
- Enter the SDK Username and Password
- Check the box for the extension
- Enter any Hook Data if applicable
- Click Save and OK
- This Extension will now show up in the System Extensions in the Study Details
NOTE: The System Extension can be disabled by unchecking the Custom Hook check box, see graphic below
System Extensions within the Study Details
