Skip to main content

Detailed Design

Flow of Custom masking:

  1. Applying Custom Masking option through Policy:

    1. Create a Policy and select Custom option to mask the detected column.

      1. Drop down in custom function screen will load all functions from back-end database with which connection is created in connection manager. User can type the name of the function to load or search the function.

      2. After selecting the function, the list of parameters will be displayed.

      3. Assign static value or column properties against the parameter.

      4. Apply detection through the created policy.

      5. Create masking task by selecting the above created policy.

      6. Execute the task to mask the data.

  2. Applying Custom Masking through Masking screen.

    1. Go to Masking > Tasks/Templates screen.

    2. Select masking type as - ‘custom’ Drop down in custom function screen will load all the functions from the back-end database with which connection is created in connection manager. User can search a function by its name.

    3. After selecting function, the parameters list is displayed.

    4. Assign column name, static value, or column properties against parameter. User can enter the value in single Column only.

    5. User can test the function. Results will be displayed on UI.


Impacts, if any, of the design on:

  1. High Availability in the PK Protect system: No

  2. Web Services with Other Components: Earlier there was only one web service which was able to create and test custom function. Now there are 2 web services:

    Yes – A new web service has been added to the masker IDP which can be called from DSM Administrator. This web service will return a list of all functions with which connection has been created from the Connection manager in PK Protect UI. Prefix of the function can be used to filter functions.

    Test Custom Function web service is required to test the function call by database. This web service will return the function result.

  3. Encryption in the Controller Repository, Results Database: No

  4. Audit Reports in PK Protect: No.

  5. PK Protect RBAC – Changes needed for RBAC with this feature: No.

  6. Controller Snapshots – Feature requires an addition to the fields saved in the Task Instance snapshot in the Controller: YES. (Following tables are required to increase the size of the column ‘param2’

    1. dg_masking_temp_columns

    2. dg_masking_columns

    3. dg_policy_details

    4. dg_policy_details_hist

    5. dg_masking_column_hist

    6. dg_mask_cols_snapshot

  7. DDL Changes – Captures DDL changes: Yes.
    Alter the table ‘dg_columns’ –
    Set the size of columns param2 and param3 to 2000. Save the json of parameters as param2 and save the function call as param3 column.

  8. Logging – especially overly verbose logging and leakage of sensitive data in logs:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.