Optim Data Privacy Providers  11.7.0
 All Data Structures Files Functions Variables Macros Groups Pages
Specific Parameters
Collaboration diagram for Specific Parameters:

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
 

Values for ODPP_OPR_SRC_COL_OPERATOR

#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
 

Values for ODPP_OPR_LOOKUP_FLAGS

#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
 

Detailed Description

Macro Definition Documentation

#define LOOKUPOPERANDBASE   0x1A10 /* 6672 */
  • Use:
    This is the Base value which is used by Lookup Parameter Defines.
  • Description:
    N/A
  • Optional:
    N/A
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    N/A
  • Example:
    N/A
#define LOOKUPOPERANDBASE_EXT   0x1A8E
  • Use:
    This is the Base value which is used by Lookup Parameter Value Defines.
  • Description:
    N/A
  • Optional:
    N/A
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    N/A
  • Example:
    N/A
#define ODPP_OPR_SRC_COL_OPERATOR   LOOKUPOPERANDBASE + 0
  • Use:
    This parameter is used to specify the operator for an OR or an AND operation on source columns.
  • Description:
    This parameter will AND or OR the value match results of all source columns. This applies to multicolumn search only.

    This parameter can be specified with the following values:
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_SRC_COL_OPERATOR = ODPP_LDS_OPERATOR_AND
      This will AND the value match results of all source columns.
#define ODPP_OPR_LDS_ID   LOOKUPOPERANDBASE + 1
  • Use:
    This parameter is used to specify the Lookup Data Source(LDS) name.
  • Description:
    This parameter supplies the LDS identifier string. The string will be LDS implementation specific. For the reference DB2 implementation this is used to supply the Lookup Table Name.
  • Optional:
    No
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LDS_ID = "Lookup Table"
#define ODPP_OPR_LDS_LIB   LOOKUPOPERANDBASE + 2
  • Use:
    This parameter is used to specify the name of the Lookup Data Source(LDS) library.
  • Description:
    This parameter supplies the name of the LDS library that will be loaded on initialization of the Lookup service provider. Each initialization of the Lookup service provider will require the LDS library to fetch the data.

    This parameter can be specified with the following values:
    • ODPP_LDS_DB2_LUW
      This parameter value indicates that Lookup Service provider will load standard DB2 LDS library and this parameter is supplied in uiVal member of DP_INIT_OP_DEF
    • ODPP_LDS_ORACLE
      This parameter value indicates that Lookup Service provider will load standard ORACLE LDS library and this parameter is supplied in uiVal member of DP_INIT_OP_DEF
    • ODPP_LDS_DB2_ZOS
      This parameter value indicates that Lookup Service provider will load standard LDS library for zOS platform and this parameter is supplied in uiVal member of DP_INIT_OP_DEF
    • User Supplied LDS library
      pParamVal member of DP_INIT_OP_DEF is used to provide user supplied library name.
  • Optional:
    No
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified either in the uiVal member or pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LDS_LIB = ODPP_LDS_DB2_LUW
    • ODPP_OPR_LDS_LIB = ODPP_LDS_DB2_ZOS
    • ODPP_OPR_LDS_LIB = ODPP_LDS_ORACLE
    • ODPP_OPR_LDS_LIB = "libODPPLDSDB2Lib.so" – user supplied library name
#define ODPP_OPR_LOOKUP_REPLACE_COLS   LOOKUPOPERANDBASE + 3
  • Use:
    This parameter is used to specify the list of columns in the lookup table that will provide the replacement values.
  • Description:
    This parameter supplies the list of columns in the lookup table that will provide the replacement values. The column names must match columns that exist in the lookup table. There is a 1-1 mapping between the columns specified by parameters ODPP_OPR_LOOKUP_DESTINATION_COLS and ODPP_OPR_LOOKUP_REPLACE_COLS.

    The columns must be specified as a comma-separated list that is passed as a NULL terminating string without any quotes.

    For column names containing special characters the following rules apply:
    • A column name may start and end with matching delimiting double quote character (").
    • A column name must be enclosed in starting and ending double quotes when it contains a special character.
    • The special characters are the COMMA and the DOUBLE QUOTE.
    • A double quote character, when contained in a column name, must be preceded by a BACKSLASH (i.e. \ ) when the column name is enclosed in the required double quote character delimiters.
  • Optional:
    No
  • Exclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LOOKUP_REPLACE_COLS = "L_FNAME,L_LNAME"
#define ODPP_OPR_LOOKUP_TRIM_CHARS   LOOKUPOPERANDBASE + 4
  • Use:
    This parameter is used to specify the characters that will be trimmed from the source value before source value is provided for hashing.
  • Description:
    This parameter provides the characters to be trimmed from the source value before it is hashed. All the characters needs to be supplied in the form of a NULL terminated string without any separator or quotes. To specify a backslash "\" you must precede the character with a backslash escape character. This applies to Hash lookup only.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LOOKUP_TRIM_CHARS = . ,
      This will give 3 character for trimming i.e a DOT, SPACE and a COMMA.
#define ODPP_OPR_LOOKUP_SEED   LOOKUPOPERANDBASE + 5
  • Use:
    This parameter is used to specify a literal seed value when a higher degree of Hash uniqueness is required.
  • Description:
    This parameter provides the seed value that will be used by hash algorithm to generate hash value. The valid values for this parameter are 1 to 2,000,000,000. If you use a value of 0, the ODPP_OPR_LOOKUP_SEED parameter is ignored. This applies to Hash Lookup only.

    If parameter ODPP_OPR_HASH_ALGORITHM is specified with value ODPP_HASH_ALGORITHM_SHA256, if an exit is present, the HMAC key provided by the exit is used and the numeric seed value is ignored. In the absence of an exit, the numeric seed value is used as the HMAC key.
  • Optional:
    Yes.
  • Example:
    • ODPP_OPR_LOOKUP_SEED = 1000
#define ODPP_OPR_LOOKUP_LIMIT   LOOKUPOPERANDBASE + 6
  • Use:
    This parameter is used to specify the maximum number of rows that random lookup will use to select column value.
  • Description:
    This parameter is used to supply the maximum number of rows that random lookup will use to select column value. The valid values for this parameter is an integer upto a maximum value of 2,000,000,000. This parameter applies to Random Lookup only.
  • Optional:
    Yes.
    If no limit is specified, all rows are used by default.
  • Exclusive:
    N/A
  • Example:
    • ODPP_OPR_LOOKUP_LIMIT = 100000
#define ODPP_OPR_LOOKUP_FLAGS   LOOKUPOPERANDBASE + 7
  • Use:
    This parameter is used to specify general flags to the masking algorithm.
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the uiVal member of the DP_INIT_OP_DEF structure.

    Multiple flags can be specified by ORing them together as shown below:
    • uiVal = ODPP_FLAG_SRC_TO_UPPER | <flag 1> | <flag 2> | ... ;
  • Example:
    • ODPP_OPR_LOOKUP_FLAGS = ODPP_FLAG_LOOKUP | ODPP_FLAG_LOOKUP_NOCACHE
#define ODPP_OPR_LOOKUP_HASH_SEQ_COL_NAME   LOOKUPOPERANDBASE + 8
  • Use:
    This parameter is used to specify the column name of the replacement table that will be used to look for the Hash value generated in Hash Lookup.
  • Description:
    This parameter accepts column name as a NULL terminated string. This should be a valid column name in the replacement table, Lookup Service Provider will use this column to search Hash Value generated during Hash Lookup.

    The below column name rules apply to this column name.

    For column names containing special characters the following rules apply:
    • A column name may start and end with matching delimiting double quote character (").
    • A column name must be enclosed in starting and ending double quotes when it contains a special character.
    • The special characters are the COMMA and the DOUBLE QUOTE.
    • A double quote character, when contained in a column name, must be preceded by a BACKSLASH (i.e. \ ) when the column name is enclosed in the required double quote character delimiters.

    For column names containing spaces the following rules apply:
    • Spaces before and after a column name will be skipped.
    • Any spaces in between the column name or enclosed by the double quotes with column name will be taken as part of column name.
    • In case a column name consists of only spaces the column name will be skipped.

    The following rules apply when using case sensitive column names:
    • All column names (i.e. the #ColName member of structure DP_FIELD_DEF and column names supplied using parameters) not enclosed in DOUBLE QUOTES will be upper-cased. This ensures case insensitive search of the columns.
    • To preserve case sensitivity and ensure case sensitive search use DOUBLE QUOTES around the column names.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LOOKUP_HASH_SEQ_COL_NAME = "Col1"
#define ODPP_OPR_LKP_CACHE_TEMP_PATH   LOOKUPOPERANDBASE + 9
  • Use:
    This parameter is used to specify the location where the cache file will be created if Cache option is enabled. (Note Cache is enabled by default).
  • Description:
    This Parameter accepts a folder path as a NULL terminated string. Application need to take care of any special characters in the path like a "\" and prefix such special characters with a escape character. The application should have write access to the path folder specified.

    Alternatively you can set "ODPPCACHEL" environment variable to the path of the directory where the cache file will be created if Cache option is enabled. For detail description of "ODPPCACHEL" environment variable please see ODPP Environment Variable
  • Optional:
    Yes.

    Default:
    • For Windows :
      it will be the TEMP folder as returned by the Windows API GetTempPath.
    • For Unix :
      it will be /tmp folder. If this folder is not available then operation using this parameter will fail.
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • Unix :
      ODPP_OPR_LKP_CACHE_TEMP_PATH = /usr/myuser/cachefolder
    • Windows :
      ODPP_OPR_LKP_CACHE_TEMP_PATH = c:\temp
#define ODPP_OPR_RND_LKP_TEMP_PATH   ODPP_OPR_LKP_CACHE_TEMP_PATH
  • Use:
    This parameter supplies the location where the temporary file will be created. This file is required for Random Lookup to function and could be huge depending on the columns used in Random Lookup and number of rows in replacement table.
  • Description:
    This Parameter accepts a folder path as a NULL terminated string. Application need to take care of any special characters in the path like a "\" and prefix such special characters with a escape character. The application should have write access to the path folder specified.
  • Optional:
    Yes.

    Default:
    • For Windows :
      it will be the TEMP folder as returned by the Windows API GetTempPath.
    • For Unix :
      it will be /tmp folder. If this folder is not available then operation using this parameter will fail.
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • Unix :
      ODPP_OPR_RND_LKP_TEMP_PATH = /usr/myuser/cachefolder
    • Windows :
      ODPP_OPR_RND_LKP_TEMP_PATH = c:\temp
#define ODPP_OPR_LKP_PRESERVE_NULL   LOOKUPOPERANDBASE + 11
  • Use:
    This parameter is used to specify the destination columns for which NULL values must be preserved.
  • Description:
    This parameter allows the caller to preserve NULL values in destination columns (specified by parameter ODPP_OPR_LOOKUP_DESTINATION_COLS). The destination column value is checked and gets a replacement value only if the value is not NULL.
  • Optional:
    Yes.

    Default:
    NULL values are not preserved.
  • Exclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LKP_PRESERVE_NULL = "FNAME,LNAME"
#define ODPP_OPR_LKP_PRESERVE_BLANK   LOOKUPOPERANDBASE + 12
  • Use:
    This parameter is used to specify the destination columns for which blank values (all spaces) must be preserved.
  • Description:
    This parameter allows the caller to preserve blank values (all spaces) in destination columns (specified by parameter ODPP_OPR_LOOKUP_DESTINATION_COLS). The destination column value is checked and gets a replacement value only if the value is not blank.
  • Optional:
    Yes.

    Default:
    Blank values (all spaces) are not preserved.
  • Exclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LKP_PRESERVE_BLANK = "FNAME,LNAME"
#define ODPP_OPR_LDS_USERNAME   LOOKUPOPERANDBASE + 13
  • Use:
    This parameter is used to specify the username to connect to the Lookup Data Source database.
  • Description:
    This parameter provides the username to connect to the database identified by the parameter ODPP_OPR_LDS_CONN_STRING as a null terminated string.
  • Optional:
    No
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example: N/A
#define ODPP_OPR_LDS_PASSWORD   LOOKUPOPERANDBASE + 14
  • Use:
    This parameter is used to specify the password to connect to the Lookup Data Source database.
  • Description:
    This parameter provides the password to connect to the database identified by the parameter ODPP_OPR_LDS_CONN_STRING as a null terminated string.
  • Optional:
    No
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example: N/A
#define ODPP_OPR_LDS_CONN_STRING   LOOKUPOPERANDBASE + 15
  • Use:
    This parameter is used to specify connection string to connect to the Lookup Data Source database.
  • Description:
    This parameter provides the name of the database or the DSN to connect to the database as a null terminated string.
  • Optional:
    No
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example: N/A
#define ODPP_OPR_LDS_SCHEMA   LOOKUPOPERANDBASE + 16
  • Use:
    This parameter is used to specify Lookup Data Source schema.
  • Description:
    This parameter provides the name of the table schema as a null terminated string.

    Default will as per the database which is current connection username
  • Optional:
    No
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate the memory for pParamVal.
  • Example: N/A
#define ODPP_OPR_LKP_PRESERVE_ZEROLEN   LOOKUPOPERANDBASE + 18
  • Use:
    This parameter is used to specify the destination columns for which zero-length values must be preserved.
  • Description:
    This parameter allows the caller to preserve zero-length values in destination columns (specified by parameter ODPP_OPR_LOOKUP_DESTINATION_COLS). The destination column value is checked and gets a replacement value only if the value is not zero-length.
  • Optional:
    Yes.

    Default:
    Zero-length values are not preserved.
  • Exclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LKP_PRESERVE_ZEROLEN = "FNAME,LNAME"
#define ODPP_OPR_LKP_PRESERVE_NOTFOUND   LOOKUPOPERANDBASE + 19
  • Use:
    This parameter allows the Lookup service provider to preserve the destination column values (specified by parameter ODPP_OPR_LOOKUP_DESTINATION_COLS) when the search key is NOT FOUND in the lookup table.
  • Description:
    During Lookup and Hash Lookup, a row error occurs if the search key is NOT FOUND in the lookup table. If this parameter is specified the destination column values are preserved. Parameter ODPP_OPR_LKP_NOT_FOUND_REPLACEMENT_ROW may also be specified to provide the replacement values when the search key is NOT FOUND in the lookup table.
  • Optional:
    Yes.

    Default:
    Values are not preserved and an error is reported when the search key is NOT FOUND.
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    This parameter does not accept any value. Simply sending this parameter enables this option.
  • Example:
    • ODPP_OPR_LKP_PRESERVE_NOTFOUND
#define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_NULL   LOOKUPOPERANDBASE + 20
  • Use:
    This parameter supplies the special value to use as "Hash Value" in "Single Hash Column" Lookup when the column is NULL.
  • Description:
    It supplies the special value which is used to lookup the sequence column in hash replacement table for replacement data. The value for this operand will be a user supplied numeric value in the range of integer. It can be both a positive value as well a negative value. Whatever value is supplied, there should be a matching entry in the hash lookup table.
  • Optional:
    Yes.

    DEFAULT :
    Default value is -1
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_NULL = -1
#define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_BLANK   LOOKUPOPERANDBASE + 21
  • Use:
    This parameter supplies the special value to use as "Hash Value" in "Single Hash Column" Lookup when the column is Blank (i.e. only spaces).
  • Description:
    It Supplies the special value which is used to lookup the sequence column in hash replacement table for replacement data. The value for this operand will be a user supplied numeric value in the range of integer. It can be both a positive value as well a negative value. Whatever value is supplied there should be a matching entry in the hash lookup table.
  • Optional:
    Yes.

    DEFAULT :
    Default value is -2
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_BLANK = -2
#define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_ZEROLEN   LOOKUPOPERANDBASE + 22
  • Use:
    This parameter supplies the special value to use as "Hash Value" in "Single Hash Column" Lookup when the column is Zero length.
  • Description:
    It supplies the special value which is used to lookup the sequence column in hash replacement table for replacement data. The value for this operand will be a user supplied numeric value in the range of integer. It can be both a positive value as well a negative value. Whatever value is supplied, there should be a matching entry in the hash lookup table
  • Optional:
    Yes.

    DEFAULT :
    Default value is -3
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_ZEROLEN = -3
#define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_NULL   LOOKUPOPERANDBASE + 23
  • Use:
    This parameter supplies the special value to use as "Hash Value" in "Multiple Hash Column" Lookup when all the columns are NULL.
  • Description:
    It supplies the special value which is used to lookup the sequence column in hash replacement table for replacement data. The value for this operand will be a user supplied numeric value in the range of integer. It can be both a positive value as well a negative value. Whatever value is supplied, there should be a matching entry in the hash lookup table.
  • Optional:
    Yes.

    DEFAULT :
    Default value is -1
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_NULL = -1
#define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_BLANK   LOOKUPOPERANDBASE + 24
  • Use:
    This parameter supplies the special value to use as "Hash Value" in "Multiple Hash Column" Lookup when all the columns are Blank (i.e. only spaces).
  • Description:
    It supplies the special value which is used to lookup the sequence column in hash replacement table for replacement data. The value for this operand will be a user supplied numeric value in the range of integer. It can be both a positive value as well a negative value. Whatever value is supplied, there should be a matching entry in the hash lookup table.
  • Optional:
    Yes.

    DEFAULT :
    Default value is -2
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_BLANK = -2
#define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_ZEROLEN   LOOKUPOPERANDBASE + 25
  • Use:
    This parameter supplies the special value to use as "Hash Value" in "Multiple Hash Column" Lookup when all the columns are Zero length.
  • Description:
    It supplies the special value which is used to lookup the sequence column in hash replacement table for replacement data. The value for this operand will be a user supplied numeric value in the range of integer. It can be both a positive value as well a negative value. Whatever value is supplied, there should be a matching entry in the hash lookup table.
  • Optional:
    Yes.

    DEFAULT :
    Default value is -3
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_ZEROLEN = -3
#define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_MIXED   LOOKUPOPERANDBASE + 26
  • Use:
    This parameter supplies the special value to use as "Hash Value" in "Multiple Hash Column" Lookup when the columns are a combination of NULL/Blank/Zero Length values.
  • Description:
    It supplies the special value which is used to lookup the sequence column in hash replacement table for replacement data. The value for this operand will be a user supplied numeric value in the range of integer. It can be both a positive value as well a negative value. Whatever value is supplied, there should be a matching entry in the hash lookup table
  • Optional:
    Yes.

    DEFAULT :
    Default value is -4
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_MIXED = -4
#define ODPP_OPR_LKP_NOT_FOUND_REPLACEMENT_ROW   LOOKUPOPERANDBASE_EXT + 0
  • Use:
    This parameter allows the Lookup service provider to replace user supplied replacement values in the destination columns (specified by parameter ODPP_OPR_LOOKUP_DESTINATION_COLS) when the search key is NOT FOUND in the lookup table.
  • Description:
    If this parameter is specified, the user supplied values are used as replacement values in the destination columns when the search key is not found.

    The caller must provide replacement values in the form of a row using DP_ROW_DEF structure and pass the pointer via the pUserVal member of DP_INIT_OP_DEF structure.
    Use the chain of DP_FIELD_DATA_DEF structure to supply multiple replacement columns values. pSrcBufLen member of DP_FIELD_DATA_DEF is mandatory to set the size of pSrcBuf buffer in bytes.
  • Optional:
    Yes.

    Default:
    Values are not preserved and an error is reported if the search key is NOT FOUND.
  • Exclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pUserVal member of the DP_INIT_OP_DEF structure.
#define ODPP_OPR_LOOKUP_DESTINATION_COLS   LOOKUPOPERANDBASE_EXT + 1
  • Use:
    This parameter is used to specify the names of the destination columns that receive values from the replacement columns.
  • Description:
    This parameter is used to specify a list of destination columns that receive replacement values from the lookup table. There is a 1-1 mapping between the columns specified by parameters ODPP_OPR_LOOKUP_DESTINATION_COLS and ODPP_OPR_LOOKUP_REPLACE_COLS.

    The columns must be specified as a comma-separated list that is passed as a NULL terminating string without any quotes.

    For column names containing special characters the following rules apply:
    • A column name may start and end with matching delimiting double quote character (").
    • A column name must be enclosed in starting and ending double quotes when it contains a special character.
    • The special characters are the COMMA and the DOUBLE QUOTE.
    • A double quote character, when contained in a column name, must be preceded by a BACKSLASH (i.e. \ ) when the column name is enclosed in the required double quote character delimiters.
  • Optional:
    No
  • Exclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LOOKUP_DESTINATION_COLS = "FNAME,LNAME"
#define ODPP_OPR_LOOKUP_SEARCH_COLS   LOOKUPOPERANDBASE_EXT + 2
  • Use:
    This parameter is used to specify the names of the lookup search columns.
  • Description:
    This parameter is used to specify a list of columns in the lookup table that are used as search columns. The search column contains a value to match against the value from the source column. The column names must match columns that exist in the lookup table. There is a 1-1 mapping between the columns specified by parameters ODPP_OPR_SOURCE_COLS and ODPP_OPR_LOOKUP_SEARCH_COLS.

    The columns must be specified as a comma-separated list that is passed as a NULL terminating string without any quotes.

    For column names containing special characters the following rules apply:
    • A column name may start and end with matching delimiting double quote character (").
    • A column name must be enclosed in starting and ending double quotes when it contains a special character.
    • The special characters are the COMMA and the DOUBLE QUOTE.
    • A double quote character, when contained in a column name, must be preceded by a BACKSLASH (i.e. \ ) when the column name is enclosed in the required double quote character delimiters.
  • Optional:
    No
  • Exclusive:
    N/A
  • Specification Protocol:
    The parameter is specified in the usParameterID member of the DP_INIT_OP_DEF structure during Provider_Init(). Its value is specified in the pParamVal member of the DP_INIT_OP_DEF structure. Caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_LOOKUP_SEARCH_COLS = "L_CUSTID"
#define LOOKVALUEBASE   0x1A2B
  • Use:
    This is the Base value which is used by Lookup Parameter Value Defines.
  • Description:
    N/A
  • Optional:
    N/A
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    N/A
  • Example:
    N/A
#define ODPP_LDS_OPERATOR_AND   LOOKVALUEBASE + 0
  • Use:
    This parameter value is used to AND the value match results of all source column.
  • Description:
    When this parameter value is specified the Lookup service provider will AND the value match results of all the source columns. This is one of the values for parameter ODPP_OPR_SRC_COL_OPERATOR.

    This applies to multi column search only.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_SRC_COL_OPERATOR = ODPP_LDS_OPERATOR_AND
#define ODPP_LDS_OPERATOR_OR   LOOKVALUEBASE + 1
  • Use:
    This parameter value is used to OR the value match results of all source column. This is one of the values for parameter ODPP_OPR_SRC_COL_OPERATOR.
  • Description:
    When this parameter value is specified the Lookup service provider will OR the value match results of all the source columns.

    This applies to multi column search only.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_SRC_COL_OPERATOR = ODPP_LDS_OPERATOR_OR
#define ODPP_LDS_DB2_LUW   LOOKVALUEBASE + 4
  • Use:
    This parameter value is used to indicate that Lookup Service Provider will use ODPP standard DB2 LDS library name
  • Description:
    When this value is supplied Lookup Service Provider will use ODPP standard DB2 LDS library. If user supplied library needs to be used then library name can be supplied using pParamVal member of DP_INIT_OP_DEF. If you supply both LDS library name and ODPP_LDS_DB2_LUW value to the parameter ODPP_OPR_LDS_LIB then Lookup Service provider will give preference to ODPP_LDS_DB2_LUW and it will ignore user supplied LDS library name.
  • Optional:
    No
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LDS_LIB = ODPP_LDS_DB2_LUW
#define ODPP_LDS_DB2_ZOS   LOOKVALUEBASE + 5
  • Use:
    This parameter value is used to indicate that Lookup Service Provider will use ODPP standard DB2 LDS library name for zOS platform.
  • Description:
    When this value is supplied Lookup Service Provider will use ODPP standard DB2 LDS library for zOS platform. If user supplied library needs to be used then library name can be supplied using pParamVal member of DP_INIT_OP_DEF. If you supply both LDS library name and ODPP_LDS_DB2_ZOS value to the parameter ODPP_OPR_LDS_LIB then Lookup Service provider will give preference to ODPP_LDS_DB2_ZOS and it will ignore user supplied LDS library name.
  • Optional:
    No
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LDS_LIB = ODPP_LDS_DB2_ZOS
#define ODPP_LDS_ORACLE   LOOKVALUEBASE + 6
  • Use:
    This parameter value is used to indicate that Lookup Service Provider will use ODPP standard Oracle LDS library name
  • Description:
    When this value is supplied Lookup Service Provider will use ODPP standard LDS library. If user supplied library needs to be used then library name can be supplied using pParamVal member of DP_INIT_OP_DEF. If you supply both LDS library name and ODPP_LDS_ORACLE value to the parameter ODPP_OPR_LDS_LIB then Lookup Service provider will give preference to ODPP_LDS_ORACLE and it will ignore user supplied LDS library name.
  • Optional:
    No
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LDS_LIB = ODPP_LDS_ORACLE
#define ODPP_FLAG_LOOKUP_CACHE   1
  • Use:
    This parameter value is used to enable CACHE.
  • Description:
    This parameter value is used to specify CACHE to maintain a table of found lookup values in memory. Using cache is faster when retrieving a value many times but requires extra memory. This is one of the values for parameter ODPP_OPR_LOOKUP_FLAGS.
  • Optional:
    Yes
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LOOKUP_FLAGS = ODPP_FLAG_LOOKUP_CACHE
#define ODPP_FLAG_LOOKUP_NOCACHE   2
  • Use:
    This parameter value is used to disable CACHE.
  • Description:
    This parameter value is used to specify NOCACHE to discard found lookup values in memory. Using cache is faster when retrieving a value many times but requires extra memory. This is one of the value for parameter ODPP_OPR_LOOKUP_FLAGS.
  • Optional:
    Yes
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LOOKUP_FLAGS = ODPP_FLAG_LOOKUP_NOCACHE
#define ODPP_FLAG_LOOKUP_SRC_UPR   4
  • Use:
    This parameter value is used to indicate that the source value is to be converted to upper case before it is hashed.
  • Description:
    This parameter value is used to indicate that the source value is to be converted to upper case before it is hashed. This is one of the values for parameter ODPP_OPR_LOOKUP_FLAGS.

    This applies to HASH lookup only.

    If this flag value supplied along with ODPP_OPR_LOOKUP_TRIM_CHARS it will take precedence over ODPP_OPR_LOOKUP_TRIM_CHARS i.e first the source data will be converted to upper case and then trimmed.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Example:
    • ODPP_OPR_LOOKUP_FLAGS = ODPP_FLAG_LOOKUP_SRC_UPR
#define ODPP_FLAG_LOOKUP_HASH   8
  • Use:
    This parameter value is used to specify HASH lookup.
  • Description:
    This will invoke Hash lookup, by hashing the source value before seeding it for lookup. This is one of the values for parameter ODPP_OPR_LOOKUP_FLAGS.
  • Optional:
    Yes
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LOOKUP_FLAGS = ODPP_FLAG_LOOKUP_HASH
#define ODPP_FLAG_LOOKUP   16
  • Use:
    This parameter value is used to specify PLAIN lookup.
  • Description:
    This will invoke the plain lookup by mapping the source column values with replacement column values. This is one of the value for parameter ODPP_OPR_LOOKUP_FLAGS.
  • Optional:
    Yes
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_LOOKUP_FLAGS = ODPP_FLAG_LOOKUP