- 09 Dec 2024
- 2 Minutes to read
- Print
- DarkLight
Project SDK Extensions
- Updated on 09 Dec 2024
- 2 Minutes to read
- Print
- DarkLight
Overview
The Software Development Kit (SDK) allows developers to customize, configure, and extend the Decisions platform with custom code to support features according to the business needs. For more information, refer to the Software Development Kit (SDK) Overview.
What changed from v8 to v9?
Parameters | Version 8 | Version 9 |
---|---|---|
Adding/Removing SDK | Only users who had permission to access the file system were required to upload the .dll file to the "CoreServicesDlls" folder in the file system. Similarly, to remove the .dll, they had to move the .dll file from the “CoreServicesDlls” folder to the “Deleted” folder. | Users with Project permissions can now add or remove .dll files from the platform directly. |
Accessibility | Intended use is accessible globally within the platform. | Extensions added to a Project can only be used within that specific Project and cannot be used by another Project unless a dependency is created. |
Importing/Exporting | When exporting projects, the .dll file is not included and must be manually added to the appropriate location on the destination machine. | When exporting or importing a project, all uploaded .dll files are included. No manual intervention is required. |
Upgrading from v8 to v9?
On upgrades from v8 to v9, the Project that is dependent on the SDK will be functional if the .dll file is present at C:\Program Files\Decisions\Decisions Server\modules\Decisions.Local\CoreServicesDlls.
Steps to perform after the upgrade
After the upgrade, it is necessary to upload the .dll file to their respective Project to maintain the Project's integrity. Failing to do so might cause issues when performing import/export or repository actions. Refer to the next section on uploading the .dll to the Project.
Uploading an SDK Extension (.dll file)
Important Consideration
Uploading the same .dll file to multiple projects is not allowed. However, if you wish to use the same .dll file in multiple Projects, you can create a common Project and upload the .dll file to it. Then, you can add this common Project as a dependency to any other project where you need to use the SDK Extension.
Navigate to the Project you want to add the SDK.
From the Project folder tree, expand the Settings > Configurations > SDK Extensions. The SDK Extensions dashboard opens.
This dashboard contains the Extension count, Step count, file upload area to upload an SDK, and a Report that shows all the SDK uploaded to the Project.
Users can upload the .dll file under the "Upload SDK Files" file upload area.
Note that only files with the .dll extension are supported.
Click on Save to add the extension.
Once the .dll is saved, it becomes accessible within the platform according to the intended design.
Imported DLLs Report
The Report shows the names of all added extensions along with their respective file size and created on date.
Removing an SDK Extension
Caution
Deleting the custom .dll file will remove all its associated data and will impact all the dependent Projects.
From the Imported DLLs Report, right-click on the respective extension you want to remove from the Project.
Click on the "Delete".
Click on "Yes”. The .dll file will be removed from the Project.
Restart the application.
Troubleshooting .dll File
Ensure the .dll file is not blocked:
Right-click the .dll file and select Properties.
At the bottom of the Properties window, check for a security warning that reads:
This file came from another computer and might be blocked to help protect this computer
.Click Unblock next to this warning and click Apply.
If the warning is not present, the .dll is not blocked.