Algorithm Syncability¶
Overview¶
This article shows tables that specify which algorithms are syncable between Masking engines (in addition to the Masking engine key).
Note
Users must have admin privileges on the Masking engine to export and import algorithms.
User-defined Algorithms¶
| Type | Syncable | Notes |
|---|---|---|
| Lookup | Yes | NA |
| Binary Lookup | Yes | NA |
| Segmented Mapping | Yes | NA |
| Mapping | Configuration Specific | See Masking Algorithm Sync |
| Tokenization | Yes | NA |
| Minmax | Yes | NA |
| Cleansing | Yes | NA |
| Free Text Redaction | Yes | NA |
| Custom Algorithm/Mapplet | Yes | See Custom Algorithm |
| Component | Yes | NA |
Built-In Algorithms¶
While some of the built-in algorithms are not synchronizable, mainly due to them being non-deterministic, we still can support the export of inventories that contain any built-in algorithm. We just do not guarantee consistent masking of those non-synchronizable built-in algorithms between engines.
Note
Syncing built-in algorithms does not actually import the files associated with them, rather, it updates their individual keys if they have them.
Note
Synchronizing the global Engine key has no impact on SDK based algorithms. SDK algorithms must be synchronized as separate individual objects due to the embedded key per-algorithm object. Many out-of-the-box algorithms are transitioning to implementations based on SDK-derived plugin implementations. A user must sync the individual algorithms listed under "GET /syncable-objects" object_type == "USER_ALGORITHM".
| Algorithm API Name | Algorithm UI Name | Type | Syncable | Workaround |
|---|---|---|---|---|
| AccNoLookup | ACCOUNT SL | lookup | Yes | NA |
| AccountTK | ACCOUNT_TK | tokenization | Yes | NA |
| AddrLine2Lookup | ADDRESS LINE 2 SL | lookup | Yes | NA |
| AddrLookup | ADDRESS LINE SL | lookup | Yes | NA |
| BusinessLegalEntityLookup | BUSINESS LEGAL ENTITY SL | lookup | Yes | NA |
| CommentLookup | COMMENT SL | lookup | Yes | NA |
| CreditCard | CREDIT CARD | calculated | No | None |
| DateShiftDiscrete | DATE SHIFT(DISCRETE) | calculated | Yes | NA |
| DateShiftFixed | DATE SHIFT(FIXED) | calculated | No | Already synchronized |
| DateShiftVariable | DATE SHIFT(VARIABLE) | calculated | No | None |
| DrivingLicenseNoLookup | DR LICENSE SL | lookup | Yes | NA |
| DummyHospitalNameLookup | DUMMY_HOSPITAL_NAME_SL | lookup | Yes | NA |
| EmailLookup | EMAIL SL | lookup | Yes | NA |
| FirstNameLookup | FIRST NAME SL | lookup | Yes | NA |
| FullNMLookup | FULL_NM_SL | lookup | Yes | NA |
| LastNameLookup | LAST NAME SL | lookup | Yes | NA |
| LastCommaFirstLookup | LAST_COMMA_FIRST_SL | lookup | Yes | NA |
| NameTK | NAME_TK | tokenization | Yes | NA |
| NullValueLookup | NULL SL | lookup | Yes | NA |
| TelephoneNoLookup | PHONE SL | lookup | Yes | NA |
| RandomValueLookup | RANDOM_VALUE_SL | lookup | Yes | NA |
| SchoolNameLookup | SCHOOL NAME SL | lookup | Yes | NA |
| SecureShuffle | SECURE SHUFFLE | calculated | No | None |
| SsnTK | SSN_TK | tokenization | Yes | NA |
| USCountiesLookup | US_COUNTIES_SL | lookup | Yes | NA |
| USCitiesLookup | USCITIES_SL | lookup | Yes | NA |
| USstatecodesLookup | USSTATE_CODES_SL | lookup | Yes | NA |
| USstatesLookup | USSTATES_SL | lookup | Yes | NA |
| WebURLsLookup | WEB_URLS_SL | lookup | Yes | NA |
| RepeatFirstDigit | ZIP+4 | calculated | No | Already synchronized |
Custom Algorithms¶
Custom algorithms (mapplets) are syncable between Masking engines if they are self-contained in the mapplet implementation file. Any other dependencies outside the implementation file, including the Masking encryption key, will not be exported from one Masking engine and imported into another unless you explicitly manage them. Dependencies can be managed on the Masking engine encryption key by explicitly requesting the export of the encryption key along with the custom algorithm. Other dependencies, such as data on local file systems or databases (including MDS), must be manually copied from one Delphix Masking engine to another.
Extensible Algorithms¶
Extensible Algorithms are fully syncable between Masking Engines. There are two types of Extensible Algorithms:
A) Built-in to the Algorithm Plugin: These are synced through synchronization of the corresponding plugin.
B) Configurable Extensible Algorithms: These may be synced alone. All the dependencies for Extensible Algorithms (like other Extensible Algorithms, files, external file URLs, mount points for NFS mounted files, or algorithm plugins) are automatically synced along with it. For example: if an Extensible Algorithm is configured for use by another Extensible Algorithm, the dependent one (or containing the plugin) is automatically synced during the sync of the main one.