ACME Corporation Customer ID

This example is based on ACME Corporation's customer ID number. See Getting To Know ACME Corporation for more information.

Data Type Requirements

Customer ID Number Format

• Regional: <ccTLD><9-digit serial number><check digit>

  

• Worldwide: WW<YYMMDD><5-digit serial number><check digit>

  

Breakdown of Components in Customer ID Number

Boundary Rules

ACME Corporation expects a customer ID number to only be bounded by non-alphanumeric characters on either side to be valid.

Contextual Keywords

ACME Corporation identified a set of words (in various supported languages) that can commonly be found within a certain range before a customer ID number. These are known as contextual keywords.

• In English: cust id, custid, customer
• In English and French: client
• In French: cliente
• In German: kunde
• In Korean: 고객

Customer ID Number Samples

Some valid samples of customer ID numbers:

Some invalid samples of customer ID numbers:

Part 1 - ccTLD in Regional Customer ID

In Part 1, we start by creating a namespace (MAP NOCASE 'ACME_CUST_ID_CCTLD') containing all valid ccTLD values and reference it using the GROUP operator.

MAP NOCASE 'ACME_CUST_ID_CCTLD' 'AU', 'IE', 'KR', 'SG', 'UK', 'US'

GROUP 'ACME_CUST_ID_CCTLD'

See MAP and GROUP for more information.

Part 2 - 9-digit Serial Number in Regional Customer ID

In Part 2, we define the expression that will match the 9-digit serial number in a regional customer ID.

RANGE DIGIT TIMES 9

Since DIGIT represents all integers between 0 to 9, the GLASS pattern above will match any 9-digit string from 000000000 to 999999999.

As 000000000 is not a valid serial number, it is added to a namespace ((MAP 'INVALID_SERIAL_NUM') and referenced by the EXCLUDE pattern rule so that 000000000 is excluded as a match.

MAP 'INVALID_SERIAL_NUM' 0

RANGE DIGIT TIMES 9 EXCLUDE 'INVALID_SERIAL_NUM'

See MAP, RANGE, Preset Keywords, EXCLUDE and GLASS Grammar - Integers for more information.

Part 3 - Single Check Digit in Regional Customer ID

In Part 3, we define the expression that will match the check digit in a regional customer ID.

RANGE DIGIT

Part 4 - Putting the Regional Customer ID Together

In Part 4, we join the expressions (THEN) from Part 1 to Part 3 to form the complete base pattern for ACME Corporation's regional customer ID.

MAP 'INVALID_SERIAL_NUM' 0
MAP NOCASE 'ACME_CUST_ID_CCTLD' 'AU', 'IE', 'KR', 'SG', 'UK', 'US'

GROUP 'ACME_CUST_ID_CCTLD' THEN \
(RANGE DIGIT TIMES 9 EXCLUDE 'INVALID_SERIAL_NUM') THEN \
RANGE DIGIT

See THEN and OR for more information.

Part 5 - Boundary Rule and Checksum Validation for Regional Customer ID

In Part 5, we define the pattern boundaries (BOUND NONALNUM) and include the checksum validation (CHECK 'PASSPORTMOD10') for the regional customer ID.

MAP 'INVALID_SERIAL_NUM' 0
MAP NOCASE 'ACME_CUST_ID_CCTLD' 'AU', 'IE', 'KR', 'SG', 'UK', 'US'

( \
  GROUP 'ACME_CUST_ID_CCTLD' THEN \
  (RANGE DIGIT TIMES 9 EXCLUDE 'INVALID_SERIAL_NUM') THEN \
  RANGE DIGIT \
) CHECK 'PASSPORTMOD10' BOUND NONALNUM

The custom GLASS expression in Part 5 addresses all the requirements to search for ACME Corporation's regional customer ID.

See CHECK, Supported Check Modules and BOUND for more information.

Part 6 - Prefix in Worldwide Customer ID

In Part 6, we search (case-insensitively) for the WW prefix in the worldwide customer ID (WORD NOCASE 'ww').

WORD NOCASE 'ww'

See WORD for more information.

Part 7 - Short Date in Worldwide Customer ID

In Part 7, we define the expression to match the short date component (YYMMDD) in a worldwide customer ID.

1. YY is any two digits between 00 to 99.

   RANGE DIGIT TIMES 2
   

2. MM is any valid month between 01 to 12. For this, we use the RANGE operator to search for 2 consecutive ASCII digits but limit the matches to specific values in a REQUIRE namespace.

   MAP 'MONTH_OF_YEAR_LOOKUP' 1-12
   
   RANGE DIGIT TIMES 2 REQUIRE 'MONTH_OF_YEAR_LOOKUP'
   

3. DD is any valid month between 01 to 31. For this, we use the RANGE operator to search for 2 consecutive ASCII digits but limit the matches to specific values in a REQUIRE namespace.

   MAP 'DAY_OF_MONTH_LOOKUP' 1-31
   
   RANGE DIGIT TIMES 2 REQUIRE 'DAY_OF_MONTH_LOOKUP'
   

The three parts are joined together using the THEN connector, and the VALID_DATE_YYMMDD checksum module is applied to verify that the 6-digit pattern is a valid date between 1901-01-01 to 2099-12-31.

MAP 'MONTH_OF_YEAR_LOOKUP' 1-12
MAP 'DAY_OF_MONTH_LOOKUP' 1-31

( \
  RANGE DIGIT TIMES 2 THEN \
  (RANGE DIGIT TIMES 2 REQUIRE 'MONTH_OF_YEAR_LOOKUP') THEN \
  (RANGE DIGIT TIMES 2 REQUIRE 'DAY_OF_MONTH_LOOKUP') \
) CHECK 'VALID_DATE_YYMMDD'

See MAP, RANGE, REQUIRE, THEN and OR, CHECK, and Supported Check Modules for more information.

Part 8 - 5-digit Serial Number in Worldwide Customer ID

In Part 8, we take the same approach as Part 2 where we use the RANGE operator to search for five consecutive digits but EXCLUDE 00000 as a match.

MAP 'INVALID_SERIAL_NUM' 0

RANGE DIGIT TIMES 5 EXCLUDE 'INVALID_SERIAL_NUM'

Part 9 - Single Check Digit in Worldwide Customer ID

In Part 9, we define the expression that will match the check digit in a regional customer ID.

RANGE DIGIT

Part 10 - Putting the Worldwide Customer ID Together

In Part 10, we take the same approach as Part 4 and join the expressions (THEN) from Part 6 to Part 9 to form the complete base pattern for ACME Corporation's worldwide customer ID.

MAP 'MONTH_OF_YEAR_LOOKUP' 1-12
MAP 'DAY_OF_MONTH_LOOKUP' 1-31
MAP 'INVALID_SERIAL_NUM' 0

WORD NOCASE 'ww' THEN \
( \
  RANGE DIGIT TIMES 2 THEN \
  (RANGE DIGIT TIMES 2 REQUIRE 'MONTH_OF_YEAR_LOOKUP') THEN \
  (RANGE DIGIT TIMES 2 REQUIRE 'DAY_OF_MONTH_LOOKUP') \
) CHECK 'VALID_DATE_YYMMDD' THEN \
(RANGE DIGIT TIMES 5 EXCLUDE 'INVALID_SERIAL_NUM') THEN \
RANGE DIGIT

Part 11 - Boundary Rule and Checksum Validation for Worldwide Customer ID

In Part 11, we define the pattern boundaries (BOUND NONALNUM) and include the checksum validation (CHECK 'PASSPORTMOD10') for the worldwide customer ID.

MAP 'MONTH_OF_YEAR_LOOKUP' 1-12
MAP 'DAY_OF_MONTH_LOOKUP' 1-31
MAP 'INVALID_SERIAL_NUM' 0

( \
  WORD NOCASE 'ww' THEN \
  ( \
    RANGE DIGIT TIMES 2 THEN \
    (RANGE DIGIT TIMES 2 REQUIRE 'MONTH_OF_YEAR_LOOKUP') THEN \
    (RANGE DIGIT TIMES 2 REQUIRE 'DAY_OF_MONTH_LOOKUP') \
  ) CHECK 'VALID_DATE_YYMMDD' THEN \
  (RANGE DIGIT TIMES 5 EXCLUDE 'INVALID_SERIAL_NUM') THEN \
  RANGE DIGIT \
) CHECK 'PASSPORTMOD10' BOUND NONALNUM

The custom GLASS expression in Part 11 addresses all the requirements to search for ACME Corporation's worldwide customer ID.

Part 12 - Combining the Expressions for the Regional and Worldwide Customer ID

As ACME Corporation does not require the matches for the regional or worldwide customer ID to be differentiated as a different data type, the expressions from Part 5 and Part 11 can be joined using the OR operator.

The parentheses () on line 6 and line 27 are added to

1. Group the expressions for the (i) regional customer ID and (ii) worldwide customer ID into a single logical statement, and
2. To enable the BOUND rule to be applied to the whole expression within the parentheses.

See THEN and OR for more information.

Part 13 - Context Space for Customer ID

To improve the pattern matching accuracy of the customer ID data type in Part 12, we can declare a set of contextual keywords (CONTEXT and APPLY) and require (REQUIRE) these keywords to be present before (BEFORE) a potential customer ID number for it to be reported as a match.

MAP 'INVALID_SERIAL_NUM' 0
MAP 'MONTH_OF_YEAR_LOOKUP' 1-12
MAP 'DAY_OF_MONTH_LOOKUP' 1-31
MAP NOCASE 'ACME_CUST_ID_CCTLD' 'AU', 'IE', 'KR', 'SG', 'UK', 'US'
MAP NOCASE 'ACME_CUST_ID_CONTEXTS' 'cust id', 'custid', 'customer', 'client', 'cliente', 'kunde', '고객'

CONTEXT 'ACME_CUST_ID_CONTEXT' BEFORE REQUIRE 'ACME_CUST_ID_CONTEXTS'

( \
  ( \
    ( \ # Expression for regional customer ID
      ( \
        GROUP 'ACME_CUST_ID_CCTLD' THEN \
        (RANGE DIGIT TIMES 9 EXCLUDE 'INVALID_SERIAL_NUM') THEN \
        RANGE DIGIT \
      ) CHECK 'PASSPORTMOD10' \
    ) \
    OR \
    ( \ # Expression for worldwide customer ID
      ( \
        WORD NOCASE 'ww' THEN \
        ( \
          RANGE DIGIT TIMES 2 THEN \
          (RANGE DIGIT TIMES 2 REQUIRE 'MONTH_OF_YEAR_LOOKUP') THEN \
          (RANGE DIGIT TIMES 2 REQUIRE 'DAY_OF_MONTH_LOOKUP') \
        ) CHECK 'VALID_DATE_YYMMDD' THEN \
        (RANGE DIGIT TIMES 5 EXCLUDE 'INVALID_SERIAL_NUM') THEN \
        RANGE DIGIT \
      ) CHECK 'PASSPORTMOD10' \
    ) \
  ) BOUND NONALNUM \
) APPLY 'ACME_CUST_ID_CONTEXT'

See CONTEXT and APPLY for more information.

Match Samples

Based on the GLASS expression in Part 13 - Context Space for Customer ID, the regional and worldwide customer IDs underlined in line 1, line 2 and line 4 (and line 3) will be returned as matches by the GLASS pattern matching engine.

The worldwide customer ID in line 5 will not be marked as a match as there are no contextual keywords within 64-bytes before the potential match.

The pattern on line 6 will not be marked as a match as it fails the checksum validation on the last digit of the regional customer ID.