Optim Data Privacy Providers  11.7.0
 All Data Structures Files Functions Variables Macros Groups Pages
Macros
ODPPCmnOprH.h File Reference

Go to the source code of this file.

Macros

#define ODPP_METHOD_DEFAULT   VALUEBASE + 8
 
#define NIDOPERANDBASE   0x1801
 
Base values used by Defines
#define OPERANDBASE   0x1000
 
#define VALUEBASE   0x1400
 
#define REQUESTBASE   0x0E01
 

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure. These operands are applicable to more than one Service Provider.

#define ODPP_OPR_SWITCH_LITERAL   OPERANDBASE + 1
 
#define ODPP_OPR_SWITCH_NA   OPERANDBASE + 5
 
#define ODPP_OPR_SOURCE_COLINDEX   OPERANDBASE + 7
 
#define ODPP_OPR_SOURCE_COLNAME   OPERANDBASE + 8
 
#define ODPP_OPR_FLAGS   OPERANDBASE + 10
 
#define ODPP_OPR_METHOD   OPERANDBASE + 11
 
#define ODPP_OPR_TRACEPATH   OPERANDBASE + 12
 
#define ODPP_OPR_DISCARD_LIMIT   OPERANDBASE + 19
 
#define ODPP_OPR_SOURCE_COLS   OPERANDBASE + 21
 
#define ODPP_OPR_ERRORFILE_PATH   OPERANDBASE + 22
 
#define ODPP_OPR_SOURCE_DATE_FORMAT   OPERANDBASE + 23
 
#define ODPP_OPR_DEST_DATE_FORMAT   OPERANDBASE + 24
 
#define ODPP_OPR_DEST_DATATYPE   OPERANDBASE + 25
 
#define ODPP_OPR_ERROR_MSG_LANGUAGE   OPERANDBASE + 26
 
#define ODPP_OPR_LIC_FILES_PATH   OPERANDBASE + 28
 
#define ODPP_OPR_LIB_PATH   OPERANDBASE + 30
 
#define ODPP_OPR_HASH_ALGORITHM   OPERANDBASE + 32
 
#define ODPP_OPR_HASH_SEED_HMAC   OPERANDBASE + 33
 
#define ODPP_OPR_USE_SUCCESS_WITH_INFO   OPERANDBASE + 34
 

Values for ODPP_OPR_METHOD

#define ODPP_METHOD_MASK   VALUEBASE + 6
 
#define ODPP_METHOD_RANDOM   VALUEBASE + 7
 
#define ODPP_ERR_MSG_LANG_EN   VALUEBASE + 10
 
#define ODPP_HASH_ALGORITHM_NATIVE   VALUEBASE + 30
 
#define ODPP_HASH_ALGORITHM_SHA256   VALUEBASE + 31
 

Values for ODPP_OPR_FLAGS

#define ODPP_FLAG_VALIDATE_INPUT   1
 
#define ODPP_FLAG_IGNORE_INVALID   2
 

These are common separators. If a Service Provider wants to use separators, it must declare a separator parameter such as ODPP_OPR_NID_FR_SEP

#define ODPP_NO_SEP   1
 
#define ODPP_SEP_USESOURCE   2
 
#define ODPP_SEP_DOT   4
 
#define ODPP_SEP_DASH   8
 
#define ODPP_SEP_SPACE   16
 
#define ODPP_SEP_UNDERSCORE   32
 

Service Provider Information Request codes.

#define ODPP_REQ_SRC_COL_INDEX   REQUESTBASE + 0
 
#define ODPP_REQ_DEST_COL_INDEX   REQUESTBASE + 1
 
#define ODPP_REQ_DEST_DATATYPE   REQUESTBASE + 2
 
France National ID Specific Parameters

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_NID_FR_PARTS   NIDOPERANDBASE + 0
 
#define ODPP_OPR_NID_FR_SEP   NIDOPERANDBASE + 6
 
Italy National ID Specific Parameters

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_NID_IT_PARTS   NIDOPERANDBASE + 2
 
#define ODPP_OPR_NID_IT_SEP   NIDOPERANDBASE + 8
 
United Kingdom National ID Specific Parameters

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_NID_UK_PARTS   NIDOPERANDBASE + 3
 
#define ODPP_OPR_NID_UK_SEP   NIDOPERANDBASE + 9
 
#define ODPP_OPR_NID_UK_FLAGS   NIDOPERANDBASE + 12
 
Canada National ID Specific Parameters

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure

#define ODPP_OPR_NID_CA_PARTS   NIDOPERANDBASE + 5
 
#define ODPP_OPR_NID_CA_SEP   NIDOPERANDBASE + 11
 
Spain National ID Specific Parameters

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_NID_ES_SEP   NIDOPERANDBASE + 7
 
United States National ID Specific Parameters

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure

#define ODPP_OPR_NID_US_SEP   NIDOPERANDBASE + 10
 
#define ODPP_OPR_NID_US_FLAGS   NIDOPERANDBASE + 13
 

Values for parameter ODPP_OPR_NID_FR_PARTS

#define ODPP_FR_PARTS_MASK_SEX   1
 
#define ODPP_FR_PARTS_MASK_YEAR   2
 
#define ODPP_FR_PARTS_MASK_MONTH   4
 
#define ODPP_FR_PARTS_MASK_DEPT   8
 
#define ODPP_FR_PARTS_MASK_COMMUNE   16
 

Values for parameter ODPP_OPR_NID_IT_PARTS

#define ODPP_IT_PARTS_MASK_NAME   1
 
#define ODPP_IT_PARTS_MASK_BIRTH_DATE   2
 
#define ODPP_IT_PARTS_MASK_REGION   4
 

Values for parameter ODPP_OPR_NID_UK_PARTS

#define ODPP_UK_PARTS_MASK_PREFIX   1
 

Values for parameter ODPP_OPR_NID_UK_FLAGS

#define ODPP_FLAG_UK_FORM_3_PART   1
 
#define ODPP_FLAG_UK_FORM_5_PART   2
 

Values for parameter ODPP_OPR_NID_CA_PARTS

#define ODPP_CA_PARTS_MASK_HEAD   1
 

Values for parameter ODPP_OPR_NID_US_FLAGS

#define ODPP_FLAG_US_RANDOM   1
 
#define ODPP_FLAG_USE_DIST_TABLE   2
 
#define ODPP_FLAG_USE_ZOS_TABLE   4
 
Base values used by CCN Defines
#define CCNOPERANDBASE   0x1965
 

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_CCN_FLAGS   CCNOPERANDBASE + 0
 

Values for ODPP_OPR_CCN_FLAGS

#define ODPP_FLAG_CCN_RANDOM   1
 
#define ODPP_FLAG_CCN_ISSUER6   2
 
Base values used by Email Defines
#define EMLOPERANDBASE   0x1986
 
#define EMLVALUEBASE   0x19A6
 

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_EML_FLAGS   EMLOPERANDBASE + 0
 
#define ODPP_OPR_EML_DOMAIN   EMLOPERANDBASE + 1
 
#define ODPP_OPR_EML_NAME1COL_INDEX   EMLOPERANDBASE + 2
 
#define ODPP_OPR_EML_NAME2COL_INDEX   EMLOPERANDBASE + 3
 
#define ODPP_OPR_EML_USERPRFX   EMLOPERANDBASE + 4
 
#define ODPP_OPR_EML_SEPARATOR   EMLOPERANDBASE + 5
 
#define ODPP_OPR_EML_HASHSEED   EMLOPERANDBASE + 6
 
#define ODPP_OPR_EML_HASHDOMAIN   EMLOPERANDBASE + 7
 
#define ODPP_OPR_EML_NAME1COL_NAME   EMLOPERANDBASE + 8
 
#define ODPP_OPR_EML_NAME2COL_NAME   EMLOPERANDBASE + 9
 

Values for ODPP_OPR_EML_FLAGS

#define ODPP_EML_FLAG_INITIAL   1
 
#define ODPP_EML_FLAG_LOWER   2
 
#define ODPP_EML_FLAG_UPPER   4
 
#define ODPP_EML_FLAG_HASH_ENABLED   8
 
#define ODPP_EML_DOMAIN_KEEP   EMLVALUEBASE + 0
 
#define ODPP_EML_DOMAIN_REGISTERED   EMLVALUEBASE + 1
 
#define ODPP_EML_DOMAIN_UNREGISTERED   EMLVALUEBASE + 2
 
Base values used by Column Transformation Defines
#define COLOPERANDBASE   0x19E6
 
#define COLVALUEBASE   0x19F6
 

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_COL_MASK   COLOPERANDBASE + 0
 
#define ODPP_OPR_COL_VARSEED   COLOPERANDBASE + 1
 
#define ODPP_OPR_COL_LITSEED   COLOPERANDBASE + 2
 
#define ODPP_OPR_COL_RNDSEED   COLOPERANDBASE + 3
 
#define ODPP_OPR_COL_COPY   COLOPERANDBASE + 4
 
#define ODPP_OPR_COL_LENGTH   COLOPERANDBASE + 5
 
#define ODPP_OPR_COL_NUM   COLOPERANDBASE + 6
 
#define ODPP_OPR_COL_TRIM   COLOPERANDBASE + 7
 
#define ODPP_OPR_COL_BINARY   COLOPERANDBASE + 8
 
#define ODPP_OPR_COL_ALGORITHM   COLOPERANDBASE + 9
 
#define ODPP_OPR_COL_ITERATIONS   COLOPERANDBASE + 10
 
#define ODPP_OPR_COL_KEY   COLOPERANDBASE + 11
 
#define ODPP_OPR_COL_TWEAKS   COLOPERANDBASE + 12
 
#define ODPP_OPR_COL_WHENMATCH   COLOPERANDBASE + 13
 
#define ODPP_OPR_COL_KEY_ENV   COLOPERANDBASE + 14
 
#define ODPP_OPR_COL_CLASS   COLOPERANDBASE + 15
 
#define ODPP_OPR_COL_LANGUAGE   COLOPERANDBASE + 16
 

Values for ODPP_OPR_COL_MASK

#define ODPP_COL_MASK_UNIQUE   COLVALUEBASE + 0
 
#define ODPP_COL_MASK_HASH   COLVALUEBASE + 1
 
#define ODPP_COL_LENGTH_MAX   COLVALUEBASE + 2
 
#define ODPP_COL_BINARY_SCALED   COLVALUEBASE + 3
 
#define ODPP_COL_ALGORITHM_NATIVE   COLVALUEBASE + 4
 
#define ODPP_COL_ALGORITHM_FPE   COLVALUEBASE + 5
 
#define ODPP_COL_TWEAKS_YES   COLVALUEBASE + 6
 
#define ODPP_COL_TWEAKS_NO   COLVALUEBASE + 7
 
Base values used by Lookup Defines
#define LOOKUPOPERANDBASE   0x1A10 /* 6672 */
 
#define LOOKUPOPERANDBASE_EXT   0x1A8E
 
#define LOOKVALUEBASE   0x1A2B
 

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_SRC_COL_OPERATOR   LOOKUPOPERANDBASE + 0
 
#define ODPP_OPR_LDS_ID   LOOKUPOPERANDBASE + 1
 
#define ODPP_OPR_LDS_LIB   LOOKUPOPERANDBASE + 2
 
#define ODPP_OPR_LOOKUP_REPLACE_COLS   LOOKUPOPERANDBASE + 3
 
#define ODPP_OPR_LOOKUP_TRIM_CHARS   LOOKUPOPERANDBASE + 4
 
#define ODPP_OPR_LOOKUP_SEED   LOOKUPOPERANDBASE + 5
 
#define ODPP_OPR_LOOKUP_LIMIT   LOOKUPOPERANDBASE + 6
 
#define ODPP_OPR_LOOKUP_FLAGS   LOOKUPOPERANDBASE + 7
 
#define ODPP_OPR_LOOKUP_HASH_SEQ_COL_NAME   LOOKUPOPERANDBASE + 8
 
#define ODPP_OPR_LKP_CACHE_TEMP_PATH   LOOKUPOPERANDBASE + 9
 
#define ODPP_OPR_RND_LKP_TEMP_PATH   ODPP_OPR_LKP_CACHE_TEMP_PATH
 
#define ODPP_OPR_LKP_PRESERVE_NULL   LOOKUPOPERANDBASE + 11
 
#define ODPP_OPR_LKP_PRESERVE_BLANK   LOOKUPOPERANDBASE + 12
 
#define ODPP_OPR_LDS_USERNAME   LOOKUPOPERANDBASE + 13
 
#define ODPP_OPR_LDS_PASSWORD   LOOKUPOPERANDBASE + 14
 
#define ODPP_OPR_LDS_CONN_STRING   LOOKUPOPERANDBASE + 15
 
#define ODPP_OPR_LDS_SCHEMA   LOOKUPOPERANDBASE + 16
 
#define ODPP_OPR_LKP_PRESERVE_ZEROLEN   LOOKUPOPERANDBASE + 18
 
#define ODPP_OPR_LKP_PRESERVE_NOTFOUND   LOOKUPOPERANDBASE + 19
 
#define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_NULL   LOOKUPOPERANDBASE + 20
 
#define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_BLANK   LOOKUPOPERANDBASE + 21
 
#define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_ZEROLEN   LOOKUPOPERANDBASE + 22
 
#define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_NULL   LOOKUPOPERANDBASE + 23
 
#define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_BLANK   LOOKUPOPERANDBASE + 24
 
#define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_ZEROLEN   LOOKUPOPERANDBASE + 25
 
#define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_MIXED   LOOKUPOPERANDBASE + 26
 
#define ODPP_OPR_LKP_NOT_FOUND_REPLACEMENT_ROW   LOOKUPOPERANDBASE_EXT + 0
 
#define ODPP_OPR_LOOKUP_DESTINATION_COLS   LOOKUPOPERANDBASE_EXT + 1
 
#define ODPP_OPR_LOOKUP_SEARCH_COLS   LOOKUPOPERANDBASE_EXT + 2
 
#define ODPP_LDS_OPERATOR_AND   LOOKVALUEBASE + 0
 
#define ODPP_LDS_OPERATOR_OR   LOOKVALUEBASE + 1
 

Values for ODPP_OPR_LDS_LIB

#define ODPP_LDS_DB2_LUW   LOOKVALUEBASE + 4
 
#define ODPP_LDS_DB2_ZOS   LOOKVALUEBASE + 5
 
#define ODPP_LDS_ORACLE   LOOKVALUEBASE + 6
 
#define ODPP_FLAG_LOOKUP_CACHE   1
 
#define ODPP_FLAG_LOOKUP_NOCACHE   2
 
#define ODPP_FLAG_LOOKUP_SRC_UPR   4
 
#define ODPP_FLAG_LOOKUP_HASH   8
 
#define ODPP_FLAG_LOOKUP   16
 
Base values used by Hash Defines
#define HASHOPERANDBASE   0x1A3A
 
#define HASHVALUEBASE   0x1A55
 

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_HASH_MAXVALUE   HASHOPERANDBASE + 2
 
#define ODPP_OPR_HASH_SEED_LIT   HASHOPERANDBASE + 3
 
#define ODPP_OPR_HASH_SEED_ENV   HASHOPERANDBASE + 4
 
#define ODPP_OPR_HASH_SEED_RANDOM   HASHOPERANDBASE + 5
 
#define ODPP_OPR_HASH_SEED_COL   HASHOPERANDBASE + 6
 
#define ODPP_OPR_HASH_DEST_COL   HASHOPERANDBASE + 7
 
#define ODPP_OPR_HASH_TRIM_CHARS   HASHOPERANDBASE + 8
 
#define ODPP_OPR_SRC_COL_SEP   HASHOPERANDBASE + 9
 
#define ODPP_OPR_HASH_FLAGS   HASHOPERANDBASE + 10
 
#define ODPP_OPR_HASH_ALGO   HASHOPERANDBASE + 11
 
#define ODPP_OPR_HASH_SPL_HASH_VAL_SINGLE_COL_NULL   HASHOPERANDBASE + 12
 
#define ODPP_OPR_HASH_SPL_HASH_VAL_SINGLE_COL_BLANK   HASHOPERANDBASE + 13
 
#define ODPP_OPR_HASH_SPL_HASH_VAL_SINGLE_COL_ZEROLEN   HASHOPERANDBASE + 14
 
#define ODPP_OPR_HASH_SPL_HASH_VAL_MULTI_COL_NULL   HASHOPERANDBASE + 15
 
#define ODPP_OPR_HASH_SPL_HASH_VAL_MULTI_COL_BLANK   HASHOPERANDBASE + 16 /*1A4A:6730*/
 
#define ODPP_OPR_HASH_SPL_HASH_VAL_MULTI_COL_ZEROLEN   HASHOPERANDBASE + 17
 
#define ODPP_OPR_HASH_SPL_HASH_VAL_MULTI_COL_MIXED   HASHOPERANDBASE + 18 /*1A4C:6732*/
 

Values for ODPP_OPR_METHOD

#define ODPP_METHOD_HASH   ODPP_METHOD_MASK
 

Values for ODPP_OPR_HASH_ALGO

#define ODPP_HASH_ALGO_1   HASHVALUEBASE + 0
 

Hash Service Provider Information Requests

#define ODPP_HASH_REQ_MAX_HASH_VALUE   HASHVALUEBASE + 24
 
#define ODPP_HASH_REQ_SEED_COL_INDEX   HASHVALUEBASE + 25
 
#define HASH_FLAG_SRC_TO_UPPER   1
 
Base values used by Age Defines
#define AGEOPERANDBASE   0x1A64 /* 6756 */
 

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_AGE_YEAR   AGEOPERANDBASE + 0 /* 6756 */
 
#define ODPP_OPR_AGE_MONTH   AGEOPERANDBASE + 1 /* 6757 */
 
#define ODPP_OPR_AGE_WEEK   AGEOPERANDBASE + 2 /* 6758 */
 
#define ODPP_OPR_AGE_DAY   AGEOPERANDBASE + 3 /* 6759 */
 
#define ODPP_OPR_AGE_SPECIFIC_YEAR   AGEOPERANDBASE + 4 /* 6760 */
 
#define ODPP_OPR_AGE_CENTURY_PIVOT   AGEOPERANDBASE + 5 /* 6761 */
 
Base values used by Data Swapping Defines
#define SWAPOPERANDBASE   0x1AA7 /* 6823 */
 

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_SWAP_FIELD_INDICES   SWAPOPERANDBASE + 0 /* 6823 */
 
#define ODPP_OPR_SWAP_FIELD_NAMES   SWAPOPERANDBASE + 1 /* 6824 */
 
#define ODPP_OPR_SWAP_SEED   SWAPOPERANDBASE + 2 /* 6825 */
 
#define ODPP_OPR_SWAP_LOCKED   SWAPOPERANDBASE + 3 /* 6826 */
 
#define ODPP_OPR_SWAP_RATE   SWAPOPERANDBASE + 4 /* 6827 */
 
#define ODPP_OPR_SWAP_CONTROL_ATTR   SWAPOPERANDBASE + 5 /* 6828 */
 
#define ODPP_OPR_SWAP_CLASSIFIER   SWAPOPERANDBASE + 6 /* 6829 */
 
#define ODPP_OPR_SWAP_BLOCK_SIZE   SWAPOPERANDBASE + 8 /* 6831 */
 

Detailed Description

----------------------------------------------------------------------------
File Name:  ODPPCmnOprH.h

Purpose:    Provides the Parameters supported by all the Service Providers.

Author:
   IBM Optim
----------------------------------------------------------------------------

Macro Definition Documentation

#define ODPP_METHOD_DEFAULT   VALUEBASE + 8
  • Use:
    This value is used to override the "Method" parameter supplied during Provider_Init().
  • Optional:
    N/A
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    N/A
  • Example:
    N/A