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 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

Macro Definition Documentation

#define SWAPOPERANDBASE   0x1AA7 /* 6823 */
  • Use:
    This is the Base value which is used by Data Swapping Parameter Defines.
  • Description:
    N/A
  • Optional:
    N/A
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Specification Protocol:
    N/A
  • Example:
    N/A
#define ODPP_OPR_SWAP_FIELD_INDICES   SWAPOPERANDBASE + 0 /* 6823 */
  • Use:
    This parameter supplies the swap field indices.
  • Description:
    This parameter accepts a NULL terminated string of comma separated swap field indices. The input string need not be enclosed in quotes.

    The swap field index in the index of a field in the DP_FIELD_DEF list. The index value starts with 1, for example, the first field in the DP_FIELD_DEF list will have an index value of 1.
  • Optional:
    No
  • 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. The caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_SWAP_FIELD_INDICES = "1,2"
#define ODPP_OPR_SWAP_FIELD_NAMES   SWAPOPERANDBASE + 1 /* 6824 */
  • Use:
    This parameter supplies the swap field name(s).
  • Description:
    This parameter accepts a NULL terminated string of comma separated swap field names. The input string need not be enclosed in quotes.

    Each DP_FIELD_DEF object has a ColName member. The Service Provider will do a case sensitive search for source field(s) in the DP_FIELD_DEF list by comparing the field names to ColName member of DP_FIELD_DEF. Hence it is important that each field name mentioned here must have a matching DP_FIELD_DEF object for successful initialization.

    If a field name has spaces or commas it must be enclosed in double quotes. If a field name has a double quote character then the double quote character must be escaped with a backslash.
  • Optional:
    No
  • 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. The caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_SWAP_FIELD_NAMES = "Age,Income"
#define ODPP_OPR_SWAP_SEED   SWAPOPERANDBASE + 2 /* 6825 */
  • Use:
    This parameter is used to specify a seed value for data swapping.
  • Description:
    This parameter specifies an integer seed value to be used for determining the initial random value for the construction of the swap order. This parameter is mandatory if random masking is used, otherwise it is ignored.
  • 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 uiVal member of the DP_INIT_OP_DEF structure.

    The value may also be specified as a numeric string in the pParamVal member of the DP_INIT_OP_DEF structure. The caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_SWAP_SEED = 123456789
#define ODPP_OPR_SWAP_LOCKED   SWAPOPERANDBASE + 3 /* 6826 */
  • Use:
    This parameter is used to enable locked data swapping.
  • Description:
    This parameter determines whether in case of multiple swap fields all swap fields of the source row shall be copied into the destination row and vice versa. If this parameter is omitted, unlocked masking is performed (LOCKED=FALSE). The only valid values for this parameter are "0" or "1".

    LOCKED=1
    In case of multiple swap fields all selected fields in the source row of the swap pair are copied together into the destination row and vice versa. All swap field elements within a row are swapped together.

    LOCKED=0
    In case of multiple swap fields the fields of the source row are copied into different destination rows and vice versa. The elements of swap fields are swapped one after the other. This is the default.
  • 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 in the #uiVal member of the DP_INIT_OP_DEF structure. The caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_SWAP_LOCKED = 0
#define ODPP_OPR_SWAP_RATE   SWAPOPERANDBASE + 4 /* 6827 */
  • Use:
    This parameter is used to specify the number of rows that are to be swapped.
  • Description:
    This parameter specifies how many rows are swapped. For example, swap 3 percent of the rows. If omitted all rows will be swapped (i.e. a rate-value = 100). rate-value is an integer between 1 and 100 indicating the percentage of the swapped rows.

    This parameter is NOT applicable for Class-based Data Swapping and Distance-based Data Swapping.
  • 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 uiVal member of the DP_INIT_OP_DEF structure.

    The value may also be specified as a numeric string in the pParamVal member of the DP_INIT_OP_DEF structure. The caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_SWAP_RATE = 30
#define ODPP_OPR_SWAP_CONTROL_ATTR   SWAPOPERANDBASE + 5 /* 6828 */
  • Use:
    This parameter is used to specify the control field name.
  • Description:
    This parameter defines the control field used to determine the feasibility of the swap of values between the swap pairs.

    The control field name must match the ColName member of a DP_FIELD_DEF object in the DP_FIELD_DEF list.

    If the field name has spaces or commas it must be enclosed in double quotes. If the field name has a double quote character then the double quote character must be escaped with a backslash.

    This parameter is applicable only for Class-based Data Swapping.
  • 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. The caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_SWAP_CONTROL_ATTR = "City"
#define ODPP_OPR_SWAP_CLASSIFIER   SWAPOPERANDBASE + 6 /* 6829 */
  • Use:
    This parameter is used to specify the classifier.
  • Description:
    This parameter specifies the function to be used on the control field to determine the category / class the row belongs to.

    IDENTITY
    This classifier creates a category for each distinct value in the control field. Each category consists only of rows, which have the same value in the control field.

    Currently, IDENTITY is the only supported classifier. It is also the default.

    This parameter is applicable only for Class-based Data Swapping.
  • 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. The caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_SWAP_CLASSIFIER = "IDENTITY"
#define ODPP_OPR_SWAP_BLOCK_SIZE   SWAPOPERANDBASE + 8 /* 6831 */
  • Use:
    This parameter is used to specify the block size.
  • Description:
    This parameter defines the block size that partitions the rowset into blocks. The block size shall be such that the number of rows in the rowset is a multiple of the block size.

    This parameter is applicable only for Distance-based Data Swapping.
  • 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 uiVal member of the DP_INIT_OP_DEF structure.

    The value may also be specified as a numeric string in the pParamVal member of the DP_INIT_OP_DEF structure. The caller must allocate memory for pParamVal.
  • Example:
    • ODPP_OPR_SWAP_BLOCK_SIZE = 3