Skip to main content
Delphix

Rule Set Feature: Logical Key (KBA4451)

 

KBA

KBA# 4451

At a Glance 

Versions: Applicable Delphix Masking versions: 4.x, 5.0.x, 5.1.x, 5.2.x, 5.3.x
Description: In-Place masking needs a Unique Row Identifier (URI) and sometimes this needs to be manually defined. 
Location: UI: Rule Set > Edit Table Settings > Logical Key
API: [not available]
Configuration: The following parameter is used to configure this feature: 
  • Logical Key: Key or cluster key separated by a comma. 
RS Indicator: Table Indicator in the Rule Set: 'LK'.
Logical Keys: Oracle: Use ROWID
Other: Any unique URI (including cluster).  
Version Updates:  

In-Place and Unique Row Identifier (URI) 

In-Place masking requires a Unique Row Identifier (URI) in order to update the masked row. This URI is usually a Primary Key or an Index of some kind. At times it is though required to manually set this URI or to define a key other than the Primary Key.

Another use case is if the database has a URI for each row in the table - for example, Oracle's ROWID. DB2 has this too but it is configurable so please check with the DBA. In these cases, this URI is the fastest way to locate the row to update and hence the fastest way to mask the database. 

Use cases: 

  • Oracle: always specify ROWID.
  • DB2: check with DBA if there is a URI, if so specify this URI. 
  • Heap tables: if there is a URI specify this. 
  • Multiple Indexes: specify the URI needed.

UI Examples

In the examples below have the following names been used: 

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

Rule Set page

Please note the 'LK' indicator when the table has a Logical Key defined. 

UI RS - LK.png

Edit Table Settings popup

The example shows a single URI (MY_LK_ID). For Clustered Indexes, separate each key with a comma. 

UI RS - Popup - Logical Key.png

Errors

No valid input errors

Note that there is no verification if the Logical Key is valid or not. It is assumed that this key is valid and that it can be used in the Masking Job. 

Tables missing from ruleset view in UI

This can happen if you have a newline / carriage return in the field.  Newer versions strip out the newline/carriage return characters from the input to avoid this, but older versions are still susceptible.  This requires a support interaction to resolve.

Related Articles

The following product documentation may provide more information or related information to this article: