This step validates birth numbers used in Ukraine. For now, the number is tested to comply with the following constraints:

• The number's date part must comply with the given date hint (only when the hint is present)
• The number's gender identification must comply with the gender hint (only when the hint is present)
• The number format must comply with the following rules:
  • The date part must contain at least one non-zero digit
  • The number after normalization must be at maximum 10 digits long. Normalization means that the number is converted to the 10-digit form by filling missing zeroes from the left or stripping redundant zeroes from the left

This step also generates a fake birth number when the output fake binding property is set and sufficient info to generate the number is present (the gender hint and date hint are both connected and filled with valid values). The generated fake number consists of the date part relevant to the given date hint, the gender part relevant to the given gender and the 'filling' character defined by the property fakeSubstituteCharacter.

The format of the generated fake number is the following:

00000XXXGX

where

• 0 - the date part related to the given date hint (the number of days since 1.1.1900)
• X - the value defined by the fakeSubstituteCharacter property
• G - the gender value: 1 for male, 2 for female - related to the given gender hint

Note that generated fake numbers are not valid, since it is not possible to calculate the valid control digit at present and therefore make the generated number valid (fulfilling the Ukrainian rule for the control digit). Also the 'filling' character may have a non-numerical value and therefore break the 'numerical-digits-only' constraint.

<step className="cz.adastra.cif.tasks.clean.ua.ValidateBirthNumberUA" id="algorithm_1">
  <properties trash="trash" 
                      gender="gender" 
                      genderOut="gender" 
                      birthNumber="INNNumber" 
                      fakeSubstituteCharacter="0" 
                      femaleDefinition="F" 
                      birthNumberOut="INNNumber" 
                      birthDateOut="date" 
                      maleDefinition="M" 
                      birthDate="date">
        <invalidDataDefinitions>
            <invalidDataDefinitionBirthDate 
                        outputType="ORIGINAL" 
                        defaultValue="1990-10-10" 
                        scoringFlags="BN_UA_DATE_MISMATCH, BN_UA_BN_NULL, BN_UA_FORMAT_INVALID"/>
            <invalidDataDefinitionBirthNumber 
                        outputType="CONSTANT" 
                        defaultValue="1990-1-1" 
                        scoringFlags="BN_UA_BN_NULL, BN_UA_FORMAT_INVALID"/>
            <invalidDataDefinitionGender 
                        outputType="CALCULATED" 
                        defaultValue="" 
                        scoringFlags="BN_UA_FORMAT_INVALID, BN_UA_GNDR_MISMATCH, BN_UA_BN_NULL"/>
        </invalidDataDefinitions>
    <scorer explanationColumn="expl">
      <scoringEntries>
        <scoringEntry key="BN_UA_BN_NULL" 
                                  explainAs="BN_UA_BN_NULL" score="0" explain="true"/>
        <scoringEntry key="BN_UA_DATE_HINT_NULL" 
                                  explainAs="BN_UA_DATE_HINT_NULL" score="0" explain="true"/>
        <scoringEntry key="BN_UA_DATE_MISMATCH" 
                                  explainAs="BN_UA_DATE_MISMATCH" score="0" explain="true"/>
        <scoringEntry key="BN_UA_FAKE_GENERATED" 
                                  explainAs="BN_UA_FAKE_GENERATED" score="0" explain="true"/>
        <scoringEntry key="BN_UA_FORMAT_INVALID" 
                                  explainAs="BN_UA_FORMAT_INVALID" score="0" explain="true"/>
        <scoringEntry key="BN_UA_GNDR_HINT_NULL" 
                                  explainAs="BN_UA_GNDR_HINT_NULL" score="0" explain="true"/>
        <scoringEntry key="BN_UA_GNDR_MISMATCH" 
                                  explainAs="BN_UA_GNDR_MISMATCH" score="0" explain="true"/>
        <scoringEntry key="BN_UA_FAKE_NOT_GENERATED" 
                                  explainAs="BN_UA_FAKE_NOT_GENERATED" score="0" explain="true"/>
        <scoringEntry key="BN_UA_GNDR_HINT_INVALID" 
                                  explainAs="BN_UA_GNDR_HINT_INVALID" score="0" explain="true"/>
      </scoringEntries>
    </scorer>
  </properties>
</step>