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

Modules

 Specific Parameters
 

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_US_FLAGS

#define ODPP_FLAG_US_RANDOM   1
 
#define ODPP_FLAG_USE_DIST_TABLE   2
 
#define ODPP_FLAG_USE_ZOS_TABLE   4
 

Detailed Description

Macro Definition Documentation

#define ODPP_OPR_NID_US_SEP   NIDOPERANDBASE + 10
  • Use:
    This parameter is used to specify the separator to be used for the resultant United States National ID.
  • Description:
    This parameter specifies the separator to be used for the resultant United States National ID. When a separator such as dash (-) is specified the output value will include a dash between the three SSN subfields.

    Valid separator values are:
    For the Mask method, the default is to use the same separator as the source for the resultant values. For the Random method, the default is to generate the resultant values without a separator. The separator values are mutually exclusive with each other.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_NID_US_SEP = ODPP_SEP_DASH
#define ODPP_OPR_NID_US_FLAGS   NIDOPERANDBASE + 13
  • Use:
    This parameter is used to specify flags for the United States National ID algorithm.
  • Description:
    There are different flags that can be specified using this parameter which will control the behaviour of the masking algorithm.
  • 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.

    Multiple flags can be specified by ORing them together as shown below:
    uiVal = <flag 1> | <flag 2> | ... ;
  • Example:
    • ODPP_OPR_NID_US_FLAGS = ODPP_FLAG_US_RANDOM
#define ODPP_FLAG_US_RANDOM   1
  • Use:
    This flag value is used generate a random area number corresponding to the same state as the input United States National ID.
  • Description:
    When this flag is specified,
    1. A random area number corresponding to the same state as the input United States National ID is assigned.
    2. An appropriate group number is generated along with a serial number.
    3. The group number assigned will be the most recent group used by the Social Security Administration for the area.
    4. Serial numbers begin with 0001 and are incremented by 1 for each additional SSN generated for the area number.
    5. When the serial number exceeds 9999, the serial number will be reset to 0001 and the group number preceding the number most recently issued for the area number will be used.

  • Optional:
    Yes
  • Example:
    • ODPP_OPR_NID_US_FLAGS = ODPP_FLAG_US_RANDOM
#define ODPP_FLAG_USE_DIST_TABLE   2
  • Use:
    To allow the ODPP NID Service Provider to generate output which is consistent with Optim Distributed.
  • Description:
    When this flag is specified, the Area table corresponding to Optim Distributed is used by the NID Service Provider algorithm. This Area table is dated 11/01/06.
  • Optional:
    Yes.
    By default the SSN algorithm uses the MAX GROUP Area Table which is dated 10/10/10.
  • Exclusive:
    If this value is specified for the flag ODPP_OPR_NID_US_FLAGS, you CANNOT specify the flag with value ODPP_FLAG_USE_ZOS_TABLE.
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_NID_US_FLAGS = ODPP_FLAG_USE_DIST_TABLE
    • ODPP_OPR_NID_US_FLAGS = ODPP_FLAG_USE_DIST_TABLE | ODPP_FLAG_US_RANDOM
#define ODPP_FLAG_USE_ZOS_TABLE   4
  • Use:
    To allow the ODPP NID Service Provider to generate output which is consistent with Optim z/OS.
  • Description:
    When this flag is specified, the Area table corresponding to Optim z/OS is used by the NID Service Provider. This Area table is dated 01/02/08.
  • Optional:
    Yes.
    By default the SSN algorithm uses the MAX GROUP Area Table which is dated 10/10/10.
  • Exclusive:
    If this value is specified for the flag ODPP_OPR_NID_US_FLAGS, you CANNOT specify the flag with value ODPP_FLAG_USE_DIST_TABLE.
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_NID_US_FLAGS = ODPP_FLAG_USE_ZOS_TABLE
    • ODPP_OPR_NID_US_FLAGS = ODPP_FLAG_USE_ZOS_TABLE | ODPP_FLAG_US_RANDOM