Skip to content

/AWS1/CL_GLUPIIDETECTION

Specifies a transform that identifies, removes or masks PII data.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/GLUNODENAME /AWS1/GLUNODENAME

The name of the transform node.

it_inputs TYPE /AWS1/CL_GLUONEINPUT_W=>TT_ONEINPUT TT_ONEINPUT

The node ID inputs to the transform.

iv_piitype TYPE /AWS1/GLUPIITYPE /AWS1/GLUPIITYPE

Indicates the type of PIIDetection transform.

it_entitytypestodetect TYPE /AWS1/CL_GLUENCLOSEDINSTRPRP00=>TT_ENCLOSEDINSTRINGPROPERTIES TT_ENCLOSEDINSTRINGPROPERTIES

Indicates the types of entities the PIIDetection transform will identify as PII data.

PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

Optional arguments:

iv_outputcolumnname TYPE /AWS1/GLUENCLOSEDINSTRINGPRP /AWS1/GLUENCLOSEDINSTRINGPRP

Indicates the output column name that will contain any entity type detected in that row.

iv_samplefraction TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

Indicates the fraction of the data to sample when scanning for PII entities.

iv_thresholdfraction TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

iv_maskvalue TYPE /AWS1/GLUMASKVALUE /AWS1/GLUMASKVALUE

Indicates the value that will replace the detected entity.

iv_redacttext TYPE /AWS1/GLUENCLOSEDINSTRINGPRP /AWS1/GLUENCLOSEDINSTRINGPRP

Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

iv_redactchar TYPE /AWS1/GLUENCLOSEDINSTRINGPRP /AWS1/GLUENCLOSEDINSTRINGPRP

The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

iv_matchpattern TYPE /AWS1/GLUENCLOSEDINSTRINGPRP /AWS1/GLUENCLOSEDINSTRINGPRP

A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

iv_numleftcharstoexclude TYPE /AWS1/GLUBOXEDPOSITIVEINT /AWS1/GLUBOXEDPOSITIVEINT

The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

iv_numrightcharstoexclude TYPE /AWS1/GLUBOXEDPOSITIVEINT /AWS1/GLUBOXEDPOSITIVEINT

The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

iv_detectionparameters TYPE /AWS1/GLUENCLOSEDINSTRINGPRP /AWS1/GLUENCLOSEDINSTRINGPRP

Additional parameters for configuring PII detection behavior and sensitivity settings.

iv_detectionsensitivity TYPE /AWS1/GLUENCLOSEDINSTRINGPRP /AWS1/GLUENCLOSEDINSTRINGPRP

The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.


Queryable Attributes

Name

The name of the transform node.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

Inputs

The node ID inputs to the transform.

Accessible with the following methods

Method Description
GET_INPUTS() Getter for INPUTS, with configurable default
ASK_INPUTS() Getter for INPUTS w/ exceptions if field has no value
HAS_INPUTS() Determine if INPUTS has a value

PiiType

Indicates the type of PIIDetection transform.

Accessible with the following methods

Method Description
GET_PIITYPE() Getter for PIITYPE, with configurable default
ASK_PIITYPE() Getter for PIITYPE w/ exceptions if field has no value
HAS_PIITYPE() Determine if PIITYPE has a value

EntityTypesToDetect

Indicates the types of entities the PIIDetection transform will identify as PII data.

PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

Accessible with the following methods

Method Description
GET_ENTITYTYPESTODETECT() Getter for ENTITYTYPESTODETECT, with configurable default
ASK_ENTITYTYPESTODETECT() Getter for ENTITYTYPESTODETECT w/ exceptions if field has no
HAS_ENTITYTYPESTODETECT() Determine if ENTITYTYPESTODETECT has a value

OutputColumnName

Indicates the output column name that will contain any entity type detected in that row.

Accessible with the following methods

Method Description
GET_OUTPUTCOLUMNNAME() Getter for OUTPUTCOLUMNNAME, with configurable default
ASK_OUTPUTCOLUMNNAME() Getter for OUTPUTCOLUMNNAME w/ exceptions if field has no va
HAS_OUTPUTCOLUMNNAME() Determine if OUTPUTCOLUMNNAME has a value

SampleFraction

Indicates the fraction of the data to sample when scanning for PII entities.

Accessible with the following methods

Method Description
GET_SAMPLEFRACTION() Getter for SAMPLEFRACTION, with configurable default
ASK_SAMPLEFRACTION() Getter for SAMPLEFRACTION w/ exceptions if field has no valu
STR_SAMPLEFRACTION() String format for SAMPLEFRACTION, with configurable default
HAS_SAMPLEFRACTION() Determine if SAMPLEFRACTION has a value

ThresholdFraction

Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

Accessible with the following methods

Method Description
GET_THRESHOLDFRACTION() Getter for THRESHOLDFRACTION, with configurable default
ASK_THRESHOLDFRACTION() Getter for THRESHOLDFRACTION w/ exceptions if field has no v
STR_THRESHOLDFRACTION() String format for THRESHOLDFRACTION, with configurable defau
HAS_THRESHOLDFRACTION() Determine if THRESHOLDFRACTION has a value

MaskValue

Indicates the value that will replace the detected entity.

Accessible with the following methods

Method Description
GET_MASKVALUE() Getter for MASKVALUE, with configurable default
ASK_MASKVALUE() Getter for MASKVALUE w/ exceptions if field has no value
HAS_MASKVALUE() Determine if MASKVALUE has a value

RedactText

Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

Accessible with the following methods

Method Description
GET_REDACTTEXT() Getter for REDACTTEXT, with configurable default
ASK_REDACTTEXT() Getter for REDACTTEXT w/ exceptions if field has no value
HAS_REDACTTEXT() Determine if REDACTTEXT has a value

RedactChar

The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

Accessible with the following methods

Method Description
GET_REDACTCHAR() Getter for REDACTCHAR, with configurable default
ASK_REDACTCHAR() Getter for REDACTCHAR w/ exceptions if field has no value
HAS_REDACTCHAR() Determine if REDACTCHAR has a value

MatchPattern

A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

Accessible with the following methods

Method Description
GET_MATCHPATTERN() Getter for MATCHPATTERN, with configurable default
ASK_MATCHPATTERN() Getter for MATCHPATTERN w/ exceptions if field has no value
HAS_MATCHPATTERN() Determine if MATCHPATTERN has a value

NumLeftCharsToExclude

The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

Accessible with the following methods

Method Description
GET_NUMLEFTCHARSTOEXCLUDE() Getter for NUMLEFTCHARSTOEXCLUDE, with configurable default
ASK_NUMLEFTCHARSTOEXCLUDE() Getter for NUMLEFTCHARSTOEXCLUDE w/ exceptions if field has
HAS_NUMLEFTCHARSTOEXCLUDE() Determine if NUMLEFTCHARSTOEXCLUDE has a value

NumRightCharsToExclude

The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

Accessible with the following methods

Method Description
GET_NUMRIGHTCHARSTOEXCLUDE() Getter for NUMRIGHTCHARSTOEXCLUDE, with configurable default
ASK_NUMRIGHTCHARSTOEXCLUDE() Getter for NUMRIGHTCHARSTOEXCLUDE w/ exceptions if field has
HAS_NUMRIGHTCHARSTOEXCLUDE() Determine if NUMRIGHTCHARSTOEXCLUDE has a value

DetectionParameters

Additional parameters for configuring PII detection behavior and sensitivity settings.

Accessible with the following methods

Method Description
GET_DETECTIONPARAMETERS() Getter for DETECTIONPARAMETERS, with configurable default
ASK_DETECTIONPARAMETERS() Getter for DETECTIONPARAMETERS w/ exceptions if field has no
HAS_DETECTIONPARAMETERS() Determine if DETECTIONPARAMETERS has a value

DetectionSensitivity

The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.

Accessible with the following methods

Method Description
GET_DETECTIONSENSITIVITY() Getter for DETECTIONSENSITIVITY, with configurable default
ASK_DETECTIONSENSITIVITY() Getter for DETECTIONSENSITIVITY w/ exceptions if field has n
HAS_DETECTIONSENSITIVITY() Determine if DETECTIONSENSITIVITY has a value