As of release 18.104.22.168, the Delphix Masking Engine supports the installation of plugins, written in Java, that provide new masking algorithms. This feature is referred to as Extensible Algorithms. This section of the documentation details all aspects of masking algorithm plugin usage and development. The Guided Tour portion of the workflows section walks the user through the basic process of building a simple plugin and installing it onto the Delphix Masking Engine. Other sections explore in-depth topics such as making algorithms configurable, consuming input files, etc.
This documentation assumes the reader has some familiarity with Java development as well as operation of the Delphix Masking Engine via both the UI and Web API Client. The reader should also understand the security requirements associated with any new algorithms being developed.
The Extensible Algorithms framework is designed to replace the custom algorithm (aka. mapplets) feature by providing richer functionality, greatly simplifying algorithm development, and ensuring long-term maintainability of plugins. The end-of-support of custom algorithms will occur in release 22.214.171.124 of the Delphix Masking Engine.
The Masking Algorithm SDK provides a number of useful functions that aid development of new algorithms for the Delphix Masking Engine. It is available on the Delphix software download site.
- Creation of empty "skeleton" projects, with build files - the maskScript init sub-command
- Creation of empty class files for algorithms - the maskScript generate sub-command
- Testing of masking algorithms without a masking engine
- The maskApp CLI
- The maskScript mask sub-command
- Uploading of plugins to the masking engine - the maskScript install sub-command
- Sample algorithms that illustrate the usage of key features of the Masking Plugin API
Getting More Information¶
Several other sources of information are available to aid in plugin development:
- The README.md file under docs in the Algorithm SDK download archive
- The Masking Plugin API Javadoc
- Invoke maskScript (located under sdkTools/bin in the SDK download) with the -h option for usage help
- Type help at the maskApp (also under sdkTools/bin in the SDK download) command prompt