MASKS

Product

Civic Platform, Citizen Access

Type

System Switch

Description

This Standard Choice gives agencies the ability to control the configuration of a mask for the parcel number, SSN, or FEIN field. For example, when you specify a parcel number mask, users must follow a unique numbering sequence when entering parcel numbers in Civic Platform.

When you define a mask for the parcel number, SSN, or FEIN field, Civic Platform uses the mask for the field wherever you find it. If you do not define the mask, the field displays with the raw (unmasked) data.

Table 1. MASKS Standard Choice Values
Standard Choice Value Value Desc Description
PARCEL_ID Enter the variables for your parcel number mask. PACEL_ID defines the mask element for the parcel number field. FEIN defines the mask element for the FEIN field, and SSN defines the mask element for the SSN field.See Table 2. See Table 3 for examples of the effects of variables.
FEIN Enter the variables for your FEIN mask.
SSN Enter the variables for the SSN mask.
PARCEL_ID_MASKED_IN_DB Yes

No

 This value allows you to store either the masked or unmasked parcel number in the database. The parcel table stores the parcel number. If the Value Desc is Yes, the database stores the masked value. Otherwise, The database stores the unmasked or system default parcel number.

The Standard Choice value descriptions must use the variables in Table 2 in any sequence. For a few examples of how the mask generates sequence and how it displays within Civic Platform see Table 3.

Table 2. Variables Available for Masks
Variable Definition Apply to Fields Example Output
# [0-9] Use the # symbol to represent a string of numeric combinations that allows a user to enter numbers 0 through 9. Parcel Number, FEIN, SSN 0811 results in ####.
` Escape character to ignore any special formats of characters Parcel Number ENG- results in ###-.
U [A-Z] Any upper case letter character combination that uses A through Z Parcel Number, SSN STU results in UUU.
L a-z Any lower case letter character combination that uses a through z. Parcel Number, SSN bldg results in LLLL.
A [Aa 0-9] Any mixed letter case combination and numeric combination from A through Z, a through z, and 0 through 9. Parcel Number, FEIN, SSN Am8 results in AAA.
? [Aa] Any mixed letter case combination of upper and lower case letters from A through Z, and a through z. Parcel Number, SSN Xyz results in ???.
* Replace any letter or digit with the asterisk symbol “*”. FEIN, SSN *** replaces three characters, digits, or their combination with “***”
[*L] [*U] [*A] [*?] [*#] Use the symbol after “*” (such as L, U, etc.) to represent the type of character that requires a user to enter, and replace the character entered with the asterisk symbol “*”. FEIN, SSN [*#] replaces the digit that the user entered with “*”. [*L] replaces the lower case letter that the user entered with “*”.

Table 3. Examples of Masks
Field Mask Possible Parcel Number, SSN or Masked FEIN
FEIN AAA-###-***** NYC-001-*****
FEIN ###-***-AAAAA 001-***-NewYC
Parcel Number UUU-###-###-??? JUL-020-110-00a
Parcel Number LLLL-???-???-### bldg-001-00A-129
SSN [*#][*#][*#]-[*#][*#]-#### ***-**-1234