With the new Extensions Beta Program, you can now opt-in to have access to your own custom code allowing you to make your own modifications in-house.
All existing functionality should continue to be in place and function as expected; however, you won’t be able to directly edit existing hook implementations in the old client.dll. You will be able to implement new hooks and override existing hook implementations using the Extensions module.
Important: The Extensions Beta Program currently runs in tandem with the existing client.dll.
In addition to the Extensions Beta Program, work is being done to convert all existing hooks from the client.dll format into the Extensions format. This work will be done iteratively across all clients on the platform (i.e., no client queue necessary).
Over time, more and more existing hook implementations will be converted into Extensions and will be editable by you. Eventually, the old client.dll will be retired, as any and all existing hook implementations will have been converted over to the Extensions module.
To gain access to the extension program, you’ll need to:
Create a GitHub GIT repository. Currently, GitHub is the only supported platform.
In GitHub account, authorize access to the DirectScale GitHub user “DS-Partners”.
If you have an organization GitHub account, then you have more control over what permissions you grant DirectScale.
The deployment pipeline is setup.
A “default” copy of the extension template is deployed to your repository. This template is an empty C# project that contains some example extension code.
Using the Extension
With this repository available to you, you can extend the Corporate Office commissions engine functionality and features by implementing Hooks and creating new custom APIs endpoints.
Visit our Developer section for helpful resources on:
Currently, you aren’t able to create any custom views (i.e., UI elements or custom pages).
Once you’ve created your custom code and committed it to GitHub, it can now be built and deployed.
In Corporate Office, navigate to Administration > Advanced Settings > Pipelines.
In the Pipelines page, you’ll see all your previous builds from GitHub.
Click the Queue New Build button, to add a new build artifact.
The build is queued across all environments (Stage/Live).
Click the Deploy button.
The build is only deployed on the current environment. You’ll need to login to each environment and deploy manually.
Warning: The deploy process can break vital site functionality, if you attempt to deploy erroneous code. Always deploy in your Stage environment first, if your plan gives you access to a Stage environment.
This queues the pipeline and your new version is deployed and ready to use.