MarkLogic 12 Product Documentation

ordt.redactUsSsn

ordt.redactUsSsn(
   column as String,
   options as object?
) as columnBinding

Summary

This function redacts a column with a 9-digit US SSN (Social Security Number) string by generating random numbers or replacing numbers with a masking character. This function can be used with op.bind or op.select .

Usage Notes

The redacted column may have a US SSN value with any of the following formats:

• no punctuation as in 123456789
• blocks of 3, 2, and 4 numbers with the blocks separated by a hyphen, period, or space as in 123.45.6789

The options consist of the following properties:

• level: either full (the default), partial, or full-random; the full level replaces all digits with the masking character; the partial level retains the last 4 digits and replaces all other digits with the masking character; the full-random level replaces all digits with randomly generated digits.
• character: the character that replaces each digit (with # default) for the full or partial level; ignored for the full-random level.

Example

const op   = require('/MarkLogic/optic');
const ordt = require('/MarkLogic/optic/optic-redaction.sjs');

op.fromView('main', 'employees')
  .bind([
     ordt.redactUsSsn(op.schemaCol('main', 'employees', 'taxid'), {level:'partial', character:'x'})
     ])
  .result();

  

Example

const op   = require('/MarkLogic/optic');
const ordt = require('/MarkLogic/optic/optic-redaction.sjs');

op.fromView('main', 'employees')
  .select([
     ordt.redactUsSsn(op.schemaCol('main', 'employees', 'taxid'), {level:'partial', character:'x'})
     ])
  .result();