Skip to main content

Using the List Rule Set Feature (KBA4461)




KBA# 4461

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies
Major Release All Sub Releases





At a Glance

Deprecated:  This feature is deprecated in release
Description: Use this feature to select a list of values (stored in a file) to use for filtering data in a table column. 
The filter used is IN (a,b,c...x,y,z).
New method: Use Custom SQL instead with WHERE [column] IN (a,b,c...). 
Location: UI: Rule Set > Edit Table Settings > List
API: [not available]
Configuration: The following parameters are configured in this feature: 
  • Column: Column to filter.
  • File: File with filter values. 
RS Indicator: Table Indicator in the Rule Set: 'LST'.

List Usage (old deprecated method)

This feature was used to filter and select data to be masked from a file. The file can, for example, contain IDs that should be masked. The values should be one value per row.


  1. Create a file with values to use in the filter (values to be selected).
  2. Crete the Rule Set and define:
    • Column to filter against (the values selected should be in this column).
    • Select the file. 
  3. Save

The SQL statement generated in the background is:

SELECT [id_col], [mask_col1], ... FROM [table] WHERE [filter_col] IN ([values in the file]);

UI Examples

In the examples below have the following names been used: 

  • Rule Set: 'Rule Set Features RS'
  • Original Table Name: 'Main_Table'

Rule Set page

Please note the 'LST' indicator when the table has a List defined. 

UI RS - LST.png

Edit Table Settings popup

This shows an example of creating a filter using column 'Mask' with filter values from the file 'in_list_file.txt'. 

UI - Rule Set - List.png

Missing input error

There are two different errors:

  • "Please select a column name."
  • "Please browse a file."

The missing file is shown below. 

UI - Rule Set - List Error.png

New Method - Custom SQL

The new method is to use Custom SQL. This is exactly the same procedure using the List where the List would generate this in the background.

The benefit with Custom SQL is also that it can be set using the API - this means that the filter can be dynamic.

The SQL to use is: 

SELECT [id_col], [mask_col1], ... FROM [table] WHERE [filter_col] IN (a,b,c,...);

For more details about Custom SQL, please see the docs below.

Related Articles