Field definition parameter

The field definition (FLDDEFn) parameter describes fields to use for processing and is required for each provider function.

The field definition (FLDDEFn) parameter uses the following syntax:

FLDDEFn = ( NAME = colname,    
		DATATYPE = datatype-value, 
		[ PRECISION = field-precision-value ], 
		[ SCALE = field-scale-value ],    
		[ LENGTH = field-length-value ],
		[ CODEPAGE = codepage-value ],
		[ CPTYPE = { DB2ZOS | ODBC |ANY |NONE } ] ) ,
FLDDEFn
Required. Describes a field to use for processing, where n is a numeric value to distinguish multiple fields. Each field that is referenced in the masking function must have a corresponding FLDDEFn parameter. For example, the parameters FLDDEF1 and FLDDEF2 describe separate fields.
NAME
Required. The source column name.
DATATYPE (or DT)
Required. The data type of the source column.

Enter one of the following values:

Note: All data types are not valid for all data privacy providers. Refer to the section for the data privacy provider you plan to use. Information for each provider includes data types supported.
CHAR
Fixed size character data that is left-justified and space padded.
DATE
Date in ISO format: %YYYY-%MM-%DD
DATETIME_CHAR
Fixed size character data that contains a date-time value that is left-justified and space padded.
DATETIME_VARCHAR
Variable size character data that starts with a short integer value that indicates the length, in bytes, of the character date-time value that follows.
DECIMAL_370
Each byte of a packed decimal field represents two decimal numbers. The rightmost/last byte contains a single decimal number ending with the sign. The typical sign bits (last 4 bits or nibble of last byte) are 0xOC for positive signed number, 0x0F for unsigned (considered positive) number, and 0x0D would define the number as negative.
DOUBLE (use for FLOAT if number is in the range 1.7E +/- 308 (15 digits))
A double-precision floating point number. Range of values: 1.7E +/-308 (15 digits).
FLOAT
A floating point number. Range of values: 3.4E +/- 38 (7 digits).
INTEGER
A 4-byte signed integer. Range of values: -2,147,483,648 to 2,147,483,647.
LONG_LONG
An 8-byte signed numeric value. Range of values: -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807.
SMALLINT
A 2-byte signed integer value. Range of values: -32,768 to 32,767.
TIME
The time in ISO format: %HH:%MM:%SS
TIMESTAMP
The timestamp in ISO format: %YYYY-%MM-%DD-%HH.%MI.%SS.%FFFFFF
U_LONG_LONG
An 8-byte unsigned numeric value. Range of values: 0 - 18,446,744,073,709,551,615.
VARCHAR
Character data that starts with a short integer value that indicates the length, in bytes, of the character data to follow.
LENGTH (or LEN)
An integer value that specifies the length of the field. This parameter is used only with character data types.
PRECISION (or PRE)
An integer value that specifies the precision of a numeric field.
SCALE (or SCA)
A short integer value that specifies the scale of a numeric field.
CODEPAGE (or CP)
An integer value that specifies the codepage or character-set identifier of the field. This parameter can override the CP value that is specified as part of the provider syntax when fields in the same syntax expression use different codepages.

This parameter is required when the following data types are used: CHAR, DATETIME_CHAR, VARCHAR, DATETIME_VARCHAR, and one of the following situations occur:

  • The codepage information is not available within the data privacy application environment.
  • The CP parameter was not specified as part of the provider syntax.
  • The codepage for a field that is described by the FLDDEFn parameter is different than the codepage specified as part of the provider syntax.
CPTYPE (or CPT)
The codepage type. This parameter can override the CPT value that is specified as part of the provider syntax when fields in the same syntax expression use different codepage types.

When the origin of the data is DBMS-specific but not tied to any one DBMS, specify the value as ANY. When the origin of the data is from a non-DBMS source, specify the value as NONE.

This parameter is required when the following data types are used: CHAR, VARCHAR, DATETIME_CHAR, DATETIME_VARCHAR, and one of the following situations occur:

  • The CP parameter was specified as part of the FLDDEFn syntax.
  • The CPT parameter was not specified as part of the provider syntax.
  • The codepage type for a field that is described by the FLDDEFn parameter is different from the codepage type specified as part of the provider syntax.

Enter one of the following values:

DB2ZOS (or DBZ)
DB2® z/OS®
ODBC
ODBC
ANY
Any DBMS
NONE
No DBMS
Parent topic: Data privacy providers