Optim Data Privacy Providers  11.3.0
 All Data Structures Files Functions Variables Macros Groups Pages
ODPPCmnOprH.h
Go to the documentation of this file.
1 
13 /*----------------------------------------------------------------------------
14 File Name: ODPPCmnOprH.h
15 
16 Purpose: Provides the Parameters supported by all the Service Providers.
17 
18 Author:
19  IBM Optim
20 ----------------------------------------------------------------------------*/
21 
22 #ifndef __OODPPCMNOPRH__
23 #define __OODPPCMNOPRH__
24 
31 
54 #define OPERANDBASE 0x1000
55 
56 
61 /* Range for common framework provided operands 0x1000 to 0x1800 */
62 /* First 1024 values reserved for common Parameters, next 1024 reserved
63  for common operand values */
64 /* Range for operands 0x1000 to 0x13FF */
65 /* Common Parameters used by the Provider */
66 
98 #define ODPP_OPR_SWITCH_LITERAL OPERANDBASE + 1
99 /* [NOT IMPLEMENTED] */
100 /*
101 - Use: <BR>
102  [FOR FUTURE USE]
103 
104 - Description:<br>
105  [FOR FUTURE USE]
106 
107 - Optional: <BR>
108  [FOR FUTURE USE]
109 
110 
111 - Exclusive: <BR>
112  [FOR FUTURE USE]
113 
114 
115 - Inclusive: <BR>
116  [FOR FUTURE USE]
117 
118 
119 - Specification Protocol: <br>
120  [FOR FUTURE USE]
121 
122 
123 - Example: <br>
124  [FOR FUTURE USE]
125 
126 */
127 //#define ODPP_OPR_SWITCH_FUNCTION OPERANDBASE + 2
128 /* [NOT IMPLEMENTED] */
129 /*
130 - Use: <BR>
131  [FOR FUTURE USE]
132 
133 - Description:<br>
134  [FOR FUTURE USE]
135 
136 - Optional: <BR>
137  [FOR FUTURE USE]
138 
139 
140 - Exclusive: <BR>
141  [FOR FUTURE USE]
142 
143 
144 - Inclusive: <BR>
145  [FOR FUTURE USE]
146 
147 
148 - Specification Protocol: <br>
149  [FOR FUTURE USE]
150 
151 
152 - Example: <br>
153  [FOR FUTURE USE]
154 
155 */
156 //#define ODPP_OPR_SWITCH_COLINDEX OPERANDBASE + 3
157 /* [NOT IMPLEMENTED] */
158 /*
159 - Use: <BR>
160  [FOR FUTURE USE]
161 
162 - Description:<br>
163  [FOR FUTURE USE]
164 
165 - Optional: <BR>
166  [FOR FUTURE USE]
167 
168 
169 - Exclusive: <BR>
170  [FOR FUTURE USE]
171 
172 
173 - Inclusive: <BR>
174  [FOR FUTURE USE]
175 
176 
177 - Specification Protocol: <br>
178  [FOR FUTURE USE]
179 
180 
181 - Example: <br>
182  [FOR FUTURE USE]
183 
184 */
185 //#define ODPP_OPR_SWITCH_COLNAME OPERANDBASE + 4
186 
210 #define ODPP_OPR_SWITCH_NA OPERANDBASE + 5
211 
212 /*
213 - Use: <BR>
214  [FOR FUTURE USE]
215 
216 - Description:<br>
217  [FOR FUTURE USE]
218 
219 - Optional: <BR>
220  [FOR FUTURE USE]
221 
222 
223 - Exclusive: <BR>
224  [FOR FUTURE USE]
225 
226 
227 - Inclusive: <BR>
228  [FOR FUTURE USE]
229 
230 
231 - Specification Protocol: <br>
232  [FOR FUTURE USE]
233 
234 
235 - Example: <br>
236  [FOR FUTURE USE]
237 
238 */
239 //#define ODPP_OPR_PARTS OPERANDBASE + 6
240 
266 #define ODPP_OPR_SOURCE_COLINDEX OPERANDBASE + 7
267 
311 #define ODPP_OPR_SOURCE_COLNAME OPERANDBASE + 8
312 
313 /*
314 - Use: <BR>
315  [FOR FUTURE USE]
316 
317 - Description:<br>
318  [FOR FUTURE USE]
319 
320 - Optional: <BR>
321  [FOR FUTURE USE]
322 
323 
324 - Exclusive: <BR>
325  [FOR FUTURE USE]
326 
327 
328 - Inclusive: <BR>
329  [FOR FUTURE USE]
330 
331 
332 - Specification Protocol: <br>
333  [FOR FUTURE USE]
334 
335 
336 - Example: <br>
337  [FOR FUTURE USE]
338 
339 */
340 //#define ODPP_OPR_SEPARATOR OPERANDBASE + 9
341 
365 #define ODPP_OPR_FLAGS OPERANDBASE + 10
366 
394 #define ODPP_OPR_METHOD OPERANDBASE + 11
395 
432 #define ODPP_OPR_TRACEPATH OPERANDBASE + 12
433 
434 //#define ODPP_OPR_TRACELEVEL OPERANDBASE + 13
435 
436 /*
437 - Use: <BR>
438  [FOR FUTURE USE]
439 
440 - Description:<br>
441  [FOR FUTURE USE]
442 
443 - Optional: <BR>
444  [FOR FUTURE USE]
445 
446 
447 - Exclusive: <BR>
448  [FOR FUTURE USE]
449 
450 
451 - Inclusive: <BR>
452  [FOR FUTURE USE]
453 
454 
455 - Specification Protocol: <br>
456  [FOR FUTURE USE]
457 
458 
459 - Example: <br>
460  [FOR FUTURE USE]
461 
462 */
463 //#define ODPP_OPR_DATE OPERANDBASE + 14
464 
465 /*
466 - Use: <BR>
467  [FOR FUTURE USE]
468 
469 - Description:<br>
470  [FOR FUTURE USE]
471 
472 - Optional: <BR>
473  [FOR FUTURE USE]
474 
475 
476 - Exclusive: <BR>
477  [FOR FUTURE USE]
478 
479 
480 - Inclusive: <BR>
481  [FOR FUTURE USE]
482 
483 
484 - Specification Protocol: <br>
485  [FOR FUTURE USE]
486 
487 
488 - Example: <br>
489  [FOR FUTURE USE]
490 
491 */
492 //#define ODPP_OPR_TIME OPERANDBASE + 15
493 
494 /*
495 - Use: <BR>
496  [FOR FUTURE USE]
497 
498 - Description:<br>
499  [FOR FUTURE USE]
500 
501 - Optional: <BR>
502  [FOR FUTURE USE]
503 
504 
505 - Exclusive: <BR>
506  [FOR FUTURE USE]
507 
508 
509 - Inclusive: <BR>
510  [FOR FUTURE USE]
511 
512 
513 - Specification Protocol: <br>
514  [FOR FUTURE USE]
515 
516 
517 - Example: <br>
518  [FOR FUTURE USE]
519 
520 */
521 //#define ODPP_OPR_TIME_EX OPERANDBASE + 16
522 
523 /*
524 - Use: <BR>
525  [FOR FUTURE USE]
526 
527 - Description:<br>
528  [FOR FUTURE USE]
529 
530 - Optional: <BR>
531  [FOR FUTURE USE]
532 
533 
534 - Exclusive: <BR>
535  [FOR FUTURE USE]
536 
537 
538 - Inclusive: <BR>
539  [FOR FUTURE USE]
540 
541 
542 - Specification Protocol: <br>
543  [FOR FUTURE USE]
544 
545 
546 - Example: <br>
547  [FOR FUTURE USE]
548 
549 */
550 //#define ODPP_OPR_TIMESTAMP OPERANDBASE + 17
551 
552 /*
553 - Use: <BR>
554  [FOR FUTURE USE]
555 
556 - Description:<br>
557  [FOR FUTURE USE]
558 
559 - Optional: <BR>
560  [FOR FUTURE USE]
561 
562 
563 - Exclusive: <BR>
564  [FOR FUTURE USE]
565 
566 
567 - Inclusive: <BR>
568  [FOR FUTURE USE]
569 
570 
571 - Specification Protocol: <br>
572  [FOR FUTURE USE]
573 
574 
575 - Example: <br>
576  [FOR FUTURE USE]
577 
578 */
579 //#define ODPP_OPR_TIMESTAMP_EX OPERANDBASE + 18
580 
611 #define ODPP_OPR_DISCARD_LIMIT OPERANDBASE + 19
612 
613 
614 /*
615 - Use: <BR>
616  [FOR FUTURE USE]
617 
618 - Description:<br>
619  [FOR FUTURE USE]
620 
621 - Optional: <BR>
622  [FOR FUTURE USE]
623 
624 
625 - Exclusive: <BR>
626  [FOR FUTURE USE]
627 
628 
629 - Inclusive: <BR>
630  [FOR FUTURE USE]
631 
632 
633 - Specification Protocol: <br>
634  [FOR FUTURE USE]
635 
636 
637 - Example: <br>
638  [FOR FUTURE USE]
639 
640 */
641 //#define ODPP_OPR_RETRY_FAILED OPERANDBASE + 20
642 
686 #define ODPP_OPR_SOURCE_COLS OPERANDBASE + 21
687 
688 /* Parameter to specify user-supplied path for ErrorMessage_EN.csv */
714 #define ODPP_OPR_ERRORFILE_PATH OPERANDBASE + 22
715 
752 #define ODPP_OPR_SOURCE_DATE_FORMAT OPERANDBASE + 23
753 
791 #define ODPP_OPR_DEST_DATE_FORMAT OPERANDBASE + 24
792 
815 #define ODPP_OPR_DEST_DATATYPE OPERANDBASE + 25
816 
839 #define ODPP_OPR_ERROR_MSG_LANGUAGE OPERANDBASE + 26
840 
841 //#define ODPP_OPR_MAX_NUMBER_OF_TRACE_FILES OPERANDBASE + 27
842 
871 #define ODPP_OPR_LIC_FILES_PATH OPERANDBASE + 28
872 
900 #define ODPP_OPR_LIB_PATH OPERANDBASE + 30
901 
902 //#define ODPP_OPR_TRACE_NAME OPERANDBASE + 31
903 
934 #define ODPP_OPR_HASH_ALGORITHM OPERANDBASE + 32
935 
965 #define ODPP_OPR_HASH_SEED_HMAC OPERANDBASE + 33
966 
967 
1145 #define ODPP_OPR_USE_SUCCESS_WITH_INFO OPERANDBASE + 34 //1022:4130
1146 
1150 /* Range for common parameter flags/values 0x1400 to 0x1800 */
1173 #define VALUEBASE 0x1400
1174 
1175 
1176 /* Common Parameter Value/Flag Defines*/
1181 
1205 #define ODPP_METHOD_MASK VALUEBASE + 6
1206 
1230 #define ODPP_METHOD_RANDOM VALUEBASE + 7
1231 
1232  // end of common operands
1233 
1257 #define ODPP_METHOD_DEFAULT VALUEBASE + 8
1258 
1266 /*
1267 - Use: <BR>
1268  [FOR FUTURE USE]
1269 
1270 - Description:<br>
1271  [FOR FUTURE USE]
1272 
1273 - Optional: <BR>
1274  [FOR FUTURE USE]
1275 
1276 
1277 - Exclusive: <BR>
1278  [FOR FUTURE USE]
1279 
1280 
1281 - Inclusive: <BR>
1282  [FOR FUTURE USE]
1283 
1284 
1285 - Specification Protocol: <br>
1286  [FOR FUTURE USE]
1287 
1288 
1289 - Example: <br>
1290  [FOR FUTURE USE]
1291 
1292 */
1293 //#define ODPP_TRACE_PATH_DEFAULT VALUEBASE + 9
1295 
1296 
1297 /* Error message Language value defines. Reserve approx 20 values
1298  for the languages. Although reserving does not make any difference
1299  it is done just to keep language defines at one place */
1326 #define ODPP_ERR_MSG_LANG_EN VALUEBASE + 10
1327 
1328 /*#define ODPP_ERR_MSG_LANG_JP VALUEBASE + 11
1329 
1330 #define ODPP_ERR_MSG_LANG_<language> VALUEBASE + 29 */
1331 
1332 /* END: Error message Language value defines. */
1333 /*===========================================================================
1334  FLAGs values
1335  These values need to a shift value from 1. The max allowed are 15 flag
1336  values that can be supplied at a time
1337  ==========================================================================*/
1338 
1365 #define ODPP_HASH_ALGORITHM_NATIVE VALUEBASE + 30
1366 
1367 
1369 
1407 #define ODPP_HASH_ALGORITHM_SHA256 VALUEBASE + 31
1408 
1409 
1414 
1438 #define ODPP_FLAG_VALIDATE_INPUT 1
1439 
1463 #define ODPP_FLAG_IGNORE_INVALID 2
1464 
1465  // end of common operands
1466 
1467 
1468 /* these are common separators whichever service uses it
1469  these can be used operands such as ODPP_OPR_NID_FR_SEP
1470  if a service provider wants to use Separators then it
1471  should declare a Separator parameter */
1472 
1482 
1506 #define ODPP_NO_SEP 1
1507 
1531 #define ODPP_SEP_USESOURCE 2
1532 
1556 #define ODPP_SEP_DOT 4
1557 
1581 #define ODPP_SEP_DASH 8
1582 
1606 #define ODPP_SEP_SPACE 16
1607 
1631 #define ODPP_SEP_UNDERSCORE 32
1632 
1633 
1634 //#define ODPP_TRACE_ERROR 1
1635 //#define ODPP_TRACE_WARNING 2
1636 //#define ODPP_TRACE_INFO 4
1637 
1641 /* Request range Upto 0x0FFF. Approx 512 values */
1664 #define REQUESTBASE 0x0E01
1665 
1666 
1695 #define ODPP_REQ_SRC_COL_INDEX REQUESTBASE + 0
1696 
1721 #define ODPP_REQ_DEST_COL_INDEX REQUESTBASE + 1
1722 
1747 #define ODPP_REQ_DEST_DATATYPE REQUESTBASE + 2
1748 
1749  // end of common operands
1750 
1751 
1752 /*==========================================================
1753  Provider specific operands and their values
1754 ==========================================================*/
1758  /*
1759  NID
1760  Range for NID operands/flags/values from 0x1801 to 0x1964.
1761  Max 356 values. 256 for Parameters and 100 for values
1762  */
1763 
1764 /*==========================================================
1765  NID
1766  Range for NID operands/flags/values from 0x1801 to 0x1964.
1767  Max 356 values. 256 for Parameters and 100 for values
1768  ==========================================================*/
1769 /* Range for NID operands 0x1801 to 0x1900. Max 256 values */
1792 #define NIDOPERANDBASE 0x1801
1793 
1839 #define ODPP_OPR_NID_FR_PARTS NIDOPERANDBASE + 0
1840 
1841 
1850 
1851  /*
1852  - Use: <BR>
1853  [FOR FUTURE USE]
1854 
1855 - Description:<br>
1856  [FOR FUTURE USE]
1857 
1858 - Optional: <BR>
1859  [FOR FUTURE USE]
1860 
1861 
1862 - Exclusive: <BR>
1863  [FOR FUTURE USE]
1864 
1865 
1866 - Inclusive: <BR>
1867  [FOR FUTURE USE]
1868 
1869 
1870 - Specification Protocol: <br>
1871  [FOR FUTURE USE]
1872 
1873 
1874 - Example: <br>
1875  [FOR FUTURE USE]
1876 
1877 */
1878 //#define ODPP_OPR_NID_ES_PARTS NIDOPERANDBASE + 1
1880 
1889 
1924 #define ODPP_OPR_NID_IT_PARTS NIDOPERANDBASE + 2
1925 
1926 
1935 
1964 #define ODPP_OPR_NID_UK_PARTS NIDOPERANDBASE + 3
1965 
1966 
1976  /*
1977  - Use: <BR>
1978  [FOR FUTURE USE]
1979 
1980 - Description:<br>
1981  [FOR FUTURE USE]
1982 
1983 - Optional: <BR>
1984  [FOR FUTURE USE]
1985 
1986 
1987 - Exclusive: <BR>
1988  [FOR FUTURE USE]
1989 
1990 
1991 - Inclusive: <BR>
1992  [FOR FUTURE USE]
1993 
1994 
1995 - Specification Protocol: <br>
1996  [FOR FUTURE USE]
1997 
1998 
1999 - Example: <br>
2000  [FOR FUTURE USE]
2001 
2002 */
2003 //#define ODPP_OPR_NID_US_PARTS NIDOPERANDBASE + 4
2005 
2014 
2043 #define ODPP_OPR_NID_CA_PARTS NIDOPERANDBASE + 5
2044 
2045 
2094 #define ODPP_OPR_NID_FR_SEP NIDOPERANDBASE + 6
2095 
2096 
2105 
2152 #define ODPP_OPR_NID_ES_SEP NIDOPERANDBASE + 7
2153 
2154 
2204 #define ODPP_OPR_NID_IT_SEP NIDOPERANDBASE + 8
2205 
2206 
2215 
2251 #define ODPP_OPR_NID_UK_SEP NIDOPERANDBASE + 9
2252 
2253 
2262 
2297 #define ODPP_OPR_NID_US_SEP NIDOPERANDBASE + 10
2298 
2299 
2308 
2342 #define ODPP_OPR_NID_CA_SEP NIDOPERANDBASE + 11
2343 
2344 
2376 #define ODPP_OPR_NID_UK_FLAGS NIDOPERANDBASE + 12
2377 
2378 
2414 #define ODPP_OPR_NID_US_FLAGS NIDOPERANDBASE + 13
2415 
2416 
2425 /* these values are for FR parameter ODPP_OPR_NID_FR_PARTS only */
2426 
2449 #define ODPP_FR_PARTS_MASK_SEX 1
2450 
2473 #define ODPP_FR_PARTS_MASK_YEAR 2
2474 
2497 #define ODPP_FR_PARTS_MASK_MONTH 4
2498 
2521 #define ODPP_FR_PARTS_MASK_DEPT 8
2522 
2545 #define ODPP_FR_PARTS_MASK_COMMUNE 16
2546 
2547  // end of groupNID_FR
2548 
2556 /* these values are for IT parameter ODPP_OPR_NID_IT_PARTS only */
2557 
2580 #define ODPP_IT_PARTS_MASK_NAME 1
2581 
2605 #define ODPP_IT_PARTS_MASK_BIRTH_DATE 2
2606 
2630 #define ODPP_IT_PARTS_MASK_REGION 4
2631 
2632  // end of groupNidItOperands
2633 
2641 /* these values are for UK parameter ODPP_OPR_NID_UK_PARTS only */
2665 #define ODPP_UK_PARTS_MASK_PREFIX 1
2666 
2667 
2671 /* these values are for UK parameter ODPP_OPR_NID_UK_FLAGS only */
2672 
2708 #define ODPP_FLAG_UK_FORM_3_PART 1
2709 
2745 #define ODPP_FLAG_UK_FORM_5_PART 2
2746 
2747  // end of groupNidUkOperands
2748 
2756 /* these values are for CA parameter ODPP_OPR_NID_CA_PARTS only */
2757 
2780 #define ODPP_CA_PARTS_MASK_HEAD 1
2781 
2782  // end of groupNidCaOperands
2783 
2791 /* these values are for US parameter ODPP_OPR_NID_US_FLAGS only */
2792 
2822 #define ODPP_FLAG_US_RANDOM 1
2823 
2849 #define ODPP_FLAG_USE_DIST_TABLE 2
2850 
2876 #define ODPP_FLAG_USE_ZOS_TABLE 4
2877 
2878  // end of groupNidUsOperands
2879 
2880 /* Range for NID values 0x1901 to 0x1964 Max. 100 values */
2881 #define NIDVALUEBASE 0x1901
2882 
2886 /*==========================================================
2887  CCN
2888  Range for CCN operands/flags/values from 0x1965 to 0x1985.
2889  Max 32 values. 16 for Parameters and 16 for parameter values
2890  ==========================================================*/
2891 /* Range for ccn operands 0x1965 to 0x1975. Max 16 values */
2917 #define CCNOPERANDBASE 0x1965
2918 
2919 
2924 /* Parameter for CCN specific Flags */
2948 #define ODPP_OPR_CCN_FLAGS CCNOPERANDBASE + 0
2949 
2950 
2951 /* CCN Flags for CCN parameter ODPP_OPR_CCN_FLAGS. Max 15 Flags */
2956 
2982 #define ODPP_FLAG_CCN_RANDOM 1
2983 
3009 #define ODPP_FLAG_CCN_ISSUER6 2
3010 
3011 
3012 /* Range for ccn values 0x1976 to 0x1985. Max 16 values */
3013 #define CCNVALUEBASE 0x1976
3014  // end of groupCCN
3015 
3019  /*
3020  EMAIL
3021  Range for EML operands/flags/values from 0x1986 to 0x19E5.
3022  Max 96 values. 32 for Parameters and 64 for parameter values
3023  */
3024 /*==========================================================
3025  EMAIL
3026  Range for EML operands/flags/values from 0x1986 to 0x19E5.
3027  Max 96 values. 32 for Parameters and 64 for parameter values
3028  ==========================================================*/
3032 
3055 #define EMLOPERANDBASE 0x1986
3056 
3057 
3062 
3090 #define ODPP_OPR_EML_FLAGS EMLOPERANDBASE + 0
3091 
3117 #define ODPP_OPR_EML_DOMAIN EMLOPERANDBASE + 1
3118 
3157 #define ODPP_OPR_EML_NAME1COL_INDEX EMLOPERANDBASE + 2
3158 
3198 #define ODPP_OPR_EML_NAME2COL_INDEX EMLOPERANDBASE + 3
3199 
3231 #define ODPP_OPR_EML_USERPRFX EMLOPERANDBASE + 4
3232 
3269 #define ODPP_OPR_EML_SEPARATOR EMLOPERANDBASE + 5
3270 
3306 #define ODPP_OPR_EML_HASHSEED EMLOPERANDBASE + 6
3307 
3347 #define ODPP_OPR_EML_HASHDOMAIN EMLOPERANDBASE + 7
3348 
3386 #define ODPP_OPR_EML_NAME1COL_NAME EMLOPERANDBASE + 8
3387 
3425 #define ODPP_OPR_EML_NAME2COL_NAME EMLOPERANDBASE + 9
3426 
3427 
3428 /* These values are for EML parameter ODPP_OPR_EML_FLAGS only. Max 15 flags only */
3433 
3463 #define ODPP_EML_FLAG_INITIAL 1
3464 
3496 #define ODPP_EML_FLAG_LOWER 2
3497 
3529 #define ODPP_EML_FLAG_UPPER 4
3530 
3568 #define ODPP_EML_FLAG_HASH_ENABLED 8
3569 
3570 
3571 /* Range for EML flags/values from 0x19A6 to 0x19E5. Max 64 values*/
3575 
3598 #define EMLVALUEBASE 0x19A6
3599 
3600 
3601 /* These values are applicable for Parameter ODPP_OPR_EML_HASHDOMAIN only */
3606 
3640 #define ODPP_EML_DOMAIN_KEEP EMLVALUEBASE + 0
3641 
3675 #define ODPP_EML_DOMAIN_REGISTERED EMLVALUEBASE + 1
3676 
3710 #define ODPP_EML_DOMAIN_UNREGISTERED EMLVALUEBASE + 2
3711 
3712  // end of groupEML
3714 
3721 
3722  /*
3723  COL
3724  Range for COL operands/flags/values from 0x19E6 to 0x1A0F
3725  Max 41 values. 16 for Parameters and 25 for parameter values
3726  */
3727 /*==========================================================
3728  COL
3729  Range for COL operands/flags/values from 0x19E6 to 0x1A0F
3730  Max 41 values. 16 for Parameters and 25 for parameter values
3731  ==========================================================*/
3732 /* Range for COL operands from 0x19E6 to 0x19F5. Max 16 values */
3755 #define COLOPERANDBASE 0x19E6
3756 
3757 
3762 
3793 #define ODPP_OPR_COL_MASK COLOPERANDBASE + 0
3794 
3818 #define ODPP_OPR_COL_VARSEED COLOPERANDBASE + 1
3819 
3843 #define ODPP_OPR_COL_LITSEED COLOPERANDBASE + 2
3844 
3868 #define ODPP_OPR_COL_RNDSEED COLOPERANDBASE + 3
3869 
3897 #define ODPP_OPR_COL_COPY COLOPERANDBASE + 4
3898 
3922 #define ODPP_OPR_COL_LENGTH COLOPERANDBASE + 5
3923 
3953 #define ODPP_OPR_COL_NUM COLOPERANDBASE + 6
3954 
3984 #define ODPP_OPR_COL_TRIM COLOPERANDBASE + 7
3985 
4013 #define ODPP_OPR_COL_BINARY COLOPERANDBASE + 8
4014 
4045 #define ODPP_OPR_COL_ALGORITHM COLOPERANDBASE + 9
4046 
4072 #define ODPP_OPR_COL_ITERATIONS COLOPERANDBASE + 10
4073 
4097 #define ODPP_OPR_COL_KEY COLOPERANDBASE + 11
4098 
4132 #define ODPP_OPR_COL_TWEAKS COLOPERANDBASE + 12
4133 
4195 #define ODPP_OPR_COL_WHENMATCH COLOPERANDBASE + 13
4196 
4220 #define ODPP_OPR_COL_KEY_ENV COLOPERANDBASE + 14
4221 
4245 #define ODPP_OPR_COL_CLASS COLOPERANDBASE + 15
4246 
4367 #define ODPP_OPR_COL_LANGUAGE COLOPERANDBASE + 16
4368 
4370 
4371 /* Range for COL flags/values from 0x19F6 to 0x1A0F. Max 26 values */
4375 
4398 #define COLVALUEBASE 0x19F6
4399 
4400 
4427 #define ODPP_COL_MASK_UNIQUE COLVALUEBASE + 0
4428 
4451 #define ODPP_COL_MASK_HASH COLVALUEBASE + 1
4452 
4453 
4479 #define ODPP_COL_LENGTH_MAX COLVALUEBASE + 2
4480 
4481 
4508 #define ODPP_COL_BINARY_SCALED COLVALUEBASE + 3
4509 
4510 
4536 #define ODPP_COL_ALGORITHM_NATIVE COLVALUEBASE + 4
4537 
4563 #define ODPP_COL_ALGORITHM_FPE COLVALUEBASE + 5 //6651
4564 
4565 
4592 #define ODPP_COL_TWEAKS_YES COLVALUEBASE + 6
4593 
4616 #define ODPP_COL_TWEAKS_NO COLVALUEBASE + 7
4617 
4618  // end of groupCOL
4619 
4623 /*==========================================================
4624  LOOKUP
4625  Range for LOOKUP operands/flags/values from 0x1A10(-0x1A20-) to 1A39
4626  17 Values for Operands and 25 for operand values
4627  ==========================================================*/
4628 /* Range for LOOKUP operands from 0x1A10 to 0x1A2A. Max 27 values */
4632 
4655 #define LOOKUPOPERANDBASE 0x1A10 /* 6672 */
4656 
4657 
4658 //#define ODPP_OPR_LOOKUP_SOURCE_COLS LOOKUPOPERANDBASE + 0
4659 
4685 #define LOOKUPOPERANDBASE_EXT 0x1A8E //6798
4686 
4687 
4692 
4693 // #define ODPP_OPR_LOOKUP_SEARCH_COLS ODPP_OPR_SOURCE_COLS
4694 
4725 #define ODPP_OPR_SRC_COL_OPERATOR LOOKUPOPERANDBASE + 0
4726 
4751 #define ODPP_OPR_LDS_ID LOOKUPOPERANDBASE + 1
4752 
4789 #define ODPP_OPR_LDS_LIB LOOKUPOPERANDBASE + 2
4790 
4823 #define ODPP_OPR_LOOKUP_REPLACE_COLS LOOKUPOPERANDBASE + 3
4824 
4850 #define ODPP_OPR_LOOKUP_TRIM_CHARS LOOKUPOPERANDBASE + 4
4851 
4878 #define ODPP_OPR_LOOKUP_SEED LOOKUPOPERANDBASE + 5
4879 
4907 #define ODPP_OPR_LOOKUP_LIMIT LOOKUPOPERANDBASE + 6
4908 
4942 #define ODPP_OPR_LOOKUP_FLAGS LOOKUPOPERANDBASE + 7
4943 
4987 #define ODPP_OPR_LOOKUP_HASH_SEQ_COL_NAME LOOKUPOPERANDBASE + 8
4988 
5025 #define ODPP_OPR_LKP_CACHE_TEMP_PATH LOOKUPOPERANDBASE + 9
5026 
5062 #define ODPP_OPR_RND_LKP_TEMP_PATH ODPP_OPR_LKP_CACHE_TEMP_PATH
5063 
5090 #define ODPP_OPR_LKP_PRESERVE_NULL LOOKUPOPERANDBASE + 11
5091 
5119 #define ODPP_OPR_LKP_PRESERVE_BLANK LOOKUPOPERANDBASE + 12
5120 
5144 #define ODPP_OPR_LDS_USERNAME LOOKUPOPERANDBASE + 13
5145 
5170 #define ODPP_OPR_LDS_PASSWORD LOOKUPOPERANDBASE + 14
5171 
5196 #define ODPP_OPR_LDS_CONN_STRING LOOKUPOPERANDBASE + 15
5197 
5224 #define ODPP_OPR_LDS_SCHEMA LOOKUPOPERANDBASE + 16
5225 
5226 
5254 #define ODPP_OPR_LKP_PRESERVE_ZEROLEN LOOKUPOPERANDBASE + 18
5255 
5283 #define ODPP_OPR_LKP_PRESERVE_NOTFOUND LOOKUPOPERANDBASE + 19
5284 
5311 #define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_NULL LOOKUPOPERANDBASE + 20
5312 
5339 #define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_BLANK LOOKUPOPERANDBASE + 21
5340 
5368 #define ODPP_OPR_LKP_SPL_HASH_VAL_SINGLE_COL_ZEROLEN LOOKUPOPERANDBASE + 22
5369 
5397 #define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_NULL LOOKUPOPERANDBASE + 23
5398 
5426 #define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_BLANK LOOKUPOPERANDBASE + 24
5427 
5455 #define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_ZEROLEN LOOKUPOPERANDBASE + 25
5456 
5483 #define ODPP_OPR_LKP_SPL_HASH_VAL_MULTI_COL_MIXED LOOKUPOPERANDBASE + 26
5484 
5485 
5515 #define ODPP_OPR_LKP_NOT_FOUND_REPLACEMENT_ROW LOOKUPOPERANDBASE_EXT + 0
5516 
5549 #define ODPP_OPR_LOOKUP_DESTINATION_COLS LOOKUPOPERANDBASE_EXT + 1
5550 
5584 #define ODPP_OPR_LOOKUP_SEARCH_COLS LOOKUPOPERANDBASE_EXT + 2
5585 
5587 
5588  /*
5589 This parameter supplies the maximum RAM in KILO BYTE to use for storing the cached records if Cache option is enabled. (Note Cache is enabled by default). Any records cached beyond this limit will be written to a temporary disk file in the folder specified by the parameter ODPP_OPR_LKP_CACHE_TEMP_PATH
5590 
5591 
5592 Description:
5593 This Parameter allows the caller to control how much of memory is utilized for storing cached records. It accepts the amount of RAM to use in KILO BYTE.
5594 
5595 
5596 Default:
5597 By default 32 KILO BYTE of RAM will be used. Beyond that cache records will be written to temporary disk file.
5598 
5599 
5600 How to send:
5601 This Parameter will accept the value in the uiVal member of DP_INIT_OP_DEF structure during Provider_Init.
5602 
5603 Examples:
5604 ODPP_OPR_LKP_CACHE_MEM_THRESHHOLD = 64
5605 */
5606 
5607 #define ODPP_OPR_LKP_CACHE_MEM_THRESHHOLD LOOKUPOPERANDBASE + 10
5608 
5609 /*
5610 FOR FUTURE USE.
5611 */
5612 //#define ODPP_OPR_LDS_CODEPAGE LOOKUPOPERANDBASE + 17
5613 
5614 /*
5615 Description:
5616 This Flag causes the Lookup service provider to use RAM only for storing cached records. There will be no limit on the amount of RAM used.
5617 
5618 Default:
5619 To limit the RAM used for cached records. For more details see parameter
5620 
5621 How to send:
5622 This Flag is supplied as a ORed value for parameter ODPP_OPR_LOOKUP_FLAGS
5623 
5624 Examples:
5625 ODPP_OPR_LOOKUP_FLAGS|= ODPP_FLAG_LOOKUP_USE_MEM_CACHE_ONLY
5626 
5627 */
5628 #define ODPP_FLAG_LOOKUP_USE_MEM_CACHE_ONLY 32
5629 
5630 
5631 
5632 /* Range for LOOKUP flags/values from 0x1A2B to 0x1A39. Max 15 values */
5658 #define LOOKVALUEBASE 0x1A2B
5659 
5660 
5661 
5667 
5695 #define ODPP_LDS_OPERATOR_AND LOOKVALUEBASE + 0
5696 
5723 #define ODPP_LDS_OPERATOR_OR LOOKVALUEBASE + 1
5724 
5725 
5726 /*
5727 - Use: <BR>
5728  [FOR FUTURE USE]
5729 
5730 - Description:<br>
5731  [FOR FUTURE USE]
5732 
5733 - Optional: <BR>
5734  [FOR FUTURE USE]
5735 
5736 
5737 - Exclusive: <BR>
5738  [FOR FUTURE USE]
5739 
5740 
5741 - Inclusive: <BR>
5742  [FOR FUTURE USE]
5743 
5744 
5745 - Specification Protocol: <br>
5746  [FOR FUTURE USE]
5747 
5748 
5749 - Example: <br>
5750  [FOR FUTURE USE]
5751 
5752 */
5753 //#define ODPP_LDS_OPERATOR_YES LOOKVALUEBASE + 2
5754 
5755 
5756 /*
5757 - Use: <BR>
5758  [FOR FUTURE USE]
5759 
5760 - Description:<br>
5761  [FOR FUTURE USE]
5762 
5763 - Optional: <BR>
5764  [FOR FUTURE USE]
5765 
5766 
5767 - Exclusive: <BR>
5768  [FOR FUTURE USE]
5769 
5770 
5771 - Inclusive: <BR>
5772  [FOR FUTURE USE]
5773 
5774 
5775 - Specification Protocol: <br>
5776  [FOR FUTURE USE]
5777 
5778 
5779 - Example: <br>
5780  [FOR FUTURE USE]
5781 
5782 */
5783 //#define ODPP_LDS_OPERATOR_NO LOOKVALUEBASE + 3
5784 
5785 
5816 #define ODPP_LDS_DB2_LUW LOOKVALUEBASE + 4
5817 
5844 #define ODPP_LDS_DB2_ZOS LOOKVALUEBASE + 5
5845 
5872 #define ODPP_LDS_ORACLE LOOKVALUEBASE + 6
5873 
5875 
5876 
5881 
5882 /* These values are for operand ODPP_OPR_LOOKUP_FLAGS only. Max 31 flags only */
5910 #define ODPP_FLAG_LOOKUP_CACHE 1
5911 
5939 #define ODPP_FLAG_LOOKUP_NOCACHE 2
5940 
5971 #define ODPP_FLAG_LOOKUP_SRC_UPR 4
5972 
5997 #define ODPP_FLAG_LOOKUP_HASH 8
5998 
6023 #define ODPP_FLAG_LOOKUP 16
6024 
6025 
6026 
6028  //End of groupLookupOperands
6029 
6030 
6037  /*
6038  HASH
6039  Range for HASH operands/flags/values from 0x1A3A (-0x1A4A-0x1A4B-) to 1A63
6040  17 Values for Parameters and 25 for parameter values
6041  */
6042 /*==========================================================
6043  HASH
6044  Range for HASH operands/flags/values from 0x1A3A (-0x1A4A-0x1A4B-) to 1A63
6045  17 Values for Parameters and 25 for parameter values
6046  ========================================================*/
6047 /* Range for HASH operands from 0x1A3A to 0x1A4A. Max 17 values */
6070 #define HASHOPERANDBASE 0x1A3A
6071 
6072 //#define ODPP_OPR_HASH_SOURCE_COLS HASHOPERANDBASE + 0
6073 
6078 
6114 #define ODPP_OPR_HASH_MAXVALUE HASHOPERANDBASE + 2
6115 
6144 #define ODPP_OPR_HASH_SEED_LIT HASHOPERANDBASE + 3
6145 
6177 #define ODPP_OPR_HASH_SEED_ENV HASHOPERANDBASE + 4
6178 
6204 #define ODPP_OPR_HASH_SEED_RANDOM HASHOPERANDBASE + 5
6205 
6245 #define ODPP_OPR_HASH_SEED_COL HASHOPERANDBASE + 6
6246 
6291 #define ODPP_OPR_HASH_DEST_COL HASHOPERANDBASE + 7
6292 
6329 #define ODPP_OPR_HASH_TRIM_CHARS HASHOPERANDBASE + 8
6330 
6365 #define ODPP_OPR_SRC_COL_SEP HASHOPERANDBASE + 9
6366 
6391 #define ODPP_OPR_HASH_FLAGS HASHOPERANDBASE + 10
6392 
6417 #define ODPP_OPR_HASH_ALGO HASHOPERANDBASE + 11
6418 
6445 #define ODPP_OPR_HASH_SPL_HASH_VAL_SINGLE_COL_NULL HASHOPERANDBASE + 12
6446 
6473 #define ODPP_OPR_HASH_SPL_HASH_VAL_SINGLE_COL_BLANK HASHOPERANDBASE + 13
6474 
6501 #define ODPP_OPR_HASH_SPL_HASH_VAL_SINGLE_COL_ZEROLEN HASHOPERANDBASE + 14
6502 
6529 #define ODPP_OPR_HASH_SPL_HASH_VAL_MULTI_COL_NULL HASHOPERANDBASE + 15
6530 
6557 #define ODPP_OPR_HASH_SPL_HASH_VAL_MULTI_COL_BLANK HASHOPERANDBASE + 16 /*1A4A:6730*/
6558 
6585 #define ODPP_OPR_HASH_SPL_HASH_VAL_MULTI_COL_ZEROLEN HASHOPERANDBASE + 17
6586 
6613 #define ODPP_OPR_HASH_SPL_HASH_VAL_MULTI_COL_MIXED HASHOPERANDBASE + 18 /*1A4C:6732*/
6614 
6615 
6619 /* Range for HASH values from 0x1A4B to 0x1A63. Max 25 values */
6642 #define HASHVALUEBASE 0x1A55
6643 
6644 
6649 
6672 #define ODPP_METHOD_HASH ODPP_METHOD_MASK
6673 
6674 
6679 
6702 #define ODPP_HASH_ALGO_1 HASHVALUEBASE + 0
6703 
6704  // end of groupHashOperands
6705 
6706 /* @addtogroup groupCommonOperands
6707  * @{
6708  */
6709 /* @name
6710  Values for #ODPP_OPR_RETRY_FAILED
6711 */
6713 /* Service Provider does not retry the failed records and only processes the unprocessed records.
6714  <BR>default is to NOT retry.
6715 */
6716 /*
6717 - Use: <BR>
6718  [FOR FUTURE USE]
6719 
6720 - Description:<br>
6721  [FOR FUTURE USE]
6722 
6723 - Optional: <BR>
6724  [FOR FUTURE USE]
6725 
6726 
6727 - Exclusive: <BR>
6728  [FOR FUTURE USE]
6729 
6730 
6731 - Inclusive: <BR>
6732  [FOR FUTURE USE]
6733 
6734 
6735 - Specification Protocol: <br>
6736  [FOR FUTURE USE]
6737 
6738 
6739 - Example: <br>
6740  [FOR FUTURE USE]
6741 
6742 */
6743 //#define ODPP_NO_RETRY_FAILED HASHVALUEBASE + 1
6744 /*
6745 The Service Provider will retry the failed rows.
6746 */
6747 /*
6748 - Use: <BR>
6749  [FOR FUTURE USE]
6750 
6751 - Description:<br>
6752  [FOR FUTURE USE]
6753 
6754 - Optional: <BR>
6755  [FOR FUTURE USE]
6756 
6757 
6758 - Exclusive: <BR>
6759  [FOR FUTURE USE]
6760 
6761 
6762 - Inclusive: <BR>
6763  [FOR FUTURE USE]
6764 
6765 
6766 - Specification Protocol: <br>
6767  [FOR FUTURE USE]
6768 
6769 
6770 - Example: <br>
6771  [FOR FUTURE USE]
6772 
6773 */
6774 //#define ODPP_RETRY_FAILED HASHVALUEBASE + 2
6776  // end of groupCommonOperands
6777 
6781 /* Hash Provider Specific Info Requests Codes
6782  Specify in reverse order. Max being 24 i.e. the limit
6783  for parameter values */
6788 //#define ODPP_HASH_REQ_XXXXXXXXXXXXXX HASHVALUEBASE + 23
6814 #define ODPP_HASH_REQ_MAX_HASH_VALUE HASHVALUEBASE + 24
6815 
6841 #define ODPP_HASH_REQ_SEED_COL_INDEX HASHVALUEBASE + 25
6842 
6843 
6844 /* These values are for parameter ODPP_OPR_HASH_FLAGS only. Max 31 flags only */
6871 #define HASH_FLAG_SRC_TO_UPPER 1
6872 
6873  // end of groupHashOperands
6875 
6879  /*
6880  AGE
6881  Range for AGE operands/flags/values from 0x1A64 (-0x1A74-0x1A75-) to 1A8D
6882  17 Values for Parameters and 25 for parameter values
6883  */
6884 /*==========================================================
6885  AGE
6886  Range for AGE operands/flags/values from 0x1A64 (-0x1A74-0x1A75-) to 1A8D
6887  17 Values for Parameters and 25 for parameter values
6888  ========================================================*/
6889 /* Range for AGE operands from 0x1A64 to 0x1A74. Max 17 values */
6893 
6916 #define AGEOPERANDBASE 0x1A64 /* 6756 */
6917 
6918 
6923 
6957 #define ODPP_OPR_AGE_YEAR AGEOPERANDBASE + 0 /* 6756 */
6958 
6992 #define ODPP_OPR_AGE_MONTH AGEOPERANDBASE + 1 /* 6757 */
6993 
7027 #define ODPP_OPR_AGE_WEEK AGEOPERANDBASE + 2 /* 6758 */
7028 
7062 #define ODPP_OPR_AGE_DAY AGEOPERANDBASE + 3 /* 6759 */
7063 
7093 #define ODPP_OPR_AGE_SPECIFIC_YEAR AGEOPERANDBASE + 4 /* 6760 */
7094 
7126 #define ODPP_OPR_AGE_CENTURY_PIVOT AGEOPERANDBASE + 5 /* 6761 */
7127 
7129 
7130 /* Range for AGE values from 0x1A75 to 0x1A8D. Max 25 values */
7131 #define AGEVALUEBASE 0x1A75
7132  // end of groupAGE
7133 
7141 
7165 #define SWAPOPERANDBASE 0x1AA7 /* 6823 */
7166 
7167 
7172 
7198 #define ODPP_OPR_SWAP_FIELD_INDICES SWAPOPERANDBASE + 0 /* 6823 */
7199 
7227 #define ODPP_OPR_SWAP_FIELD_NAMES SWAPOPERANDBASE + 1 /* 6824 */
7228 
7255 #define ODPP_OPR_SWAP_SEED SWAPOPERANDBASE + 2 /* 6825 */
7256 
7289 #define ODPP_OPR_SWAP_LOCKED SWAPOPERANDBASE + 3 /* 6826 */
7290 
7319 #define ODPP_OPR_SWAP_RATE SWAPOPERANDBASE + 4 /* 6827 */
7320 
7350 #define ODPP_OPR_SWAP_CONTROL_ATTR SWAPOPERANDBASE + 5 /* 6828 */
7351 
7382 #define ODPP_OPR_SWAP_CLASSIFIER SWAPOPERANDBASE + 6 /* 6829 */
7383 //#define ODPP_OPR_SWAP_CLASSIFIER_PARAMS SWAPOPERANDBASE + 7 /* 6830 */
7411 #define ODPP_OPR_SWAP_BLOCK_SIZE SWAPOPERANDBASE + 8 /* 6831 */
7412 
7414  // end of groupDataSwap
7416 
7417 #endif //__OODPPCMNOPRH__
7418 
7419