Information Field Definitions

The following table describes the Information Field Definitions options.

Note

This is a multi-record option group. Records can be added as necessary.

Option nameValueDescription
Alternate IDAn alphanumeric value from zero to 40 characters

Specifies the alternate ID accepted for the information field.

  • 0—Primary Member Card
  • 3—Alternate Identifier
  • 4—Username
  • 5—Associate Id
  • 6—Email Address
  • 7—Secondary Member Card
  • 8—House Account Card
Custom Input DataAn alphanumeric value from zero to 255 characters

Specifies the customized input data.

Sample valid value:

  • PrintOnReceipt=true—specifies that the field and its value is printed on the transaction receipt.
  • PrintOnReceipt=false—specifies that the field and its value is not printed on the transaction receipt. This applies to items with ItemBasedPromptSchemes product attributes only. For more information, refer to Adding Product Attributes.
Note

This parameter accepts multiple values separated by a comma.

Custom Input TypeOne of the following values:
  • Text
  • Numeric
  • Alpha
  • DropDown
  • PhoneNumber
  • Selection
  • Date MMDD
  • Date MMYY
  • Country
  • CountrySubdivision
  • AlphaNumeric
  • Decimal
  • Email
  • DateTime
  • Date
  • Time
Specifies the data type of the field.
Note

The following parameter records support only Date as the value for Custom Input Type:

  • Birthdate
  • DateOfBirth
  • DateOfPurchase
  • DriversLicenseExpiryDate
  • EventDate
  • ExemptionExpiration
  • Expiration
  • PickupDate
  • TrainingReturnStartDate
  • TrainingStartDate
Display TextAn alphanumeric value from zero to 40 charactersSpecifies the name of the field to display on the POS application. This is the user-friendly name corresponding to the Field ID parameter in this group.
Entry MethodOne of the following values:
  • None
  • Scan
  • Swipe
  • Scan and Swipe
Determines what the POS application accepts as the entry method for the field.
  • None (0)—Allow key-in entry only.
  • Scan (1)—Allow scan entry only.
  • Swipe (2)—Allow swipe entry only.
  • Scan and Swipe (3)—Allow scan and swipe entry only.
Field IDAn alphanumeric value from zero to 40 characters

A unique identifier for a field used to collect information from the customer. The field label for this field is defined in the Display Text parameter in this group.

Field IDs ending in "WithPED" are intended for fields that collect information exclusively from the PIN Pad.

This parameter is the record's key.

Input MaskAn alphanumeric value from zero to 40 characte

Specifies the masking format for the information entered in the field. For example, fields collecting social security numbers will display only the last four digits of the social security number, and the initial portion of the number will be masked.

Sample value:

  • Last4
Internal Storage NameAn alphanumeric value from zero to 40 charactersSpecifies the internal name of the field in which the data will be stored on the POS.
Is MaskedYes/NoSpecifies if this field should display its information masked.
Is PED OnlyYes/NoDetermines whether or not the POS application only allows input for the field using a PIN pad device.
Linked Field to PED Data FieldAn alphanumeric value from zero to 255 characters

Specifies the linked variable data field defined for the PIN pad device. For more information about configuring the screens of PIN pad devices, refer to Configuring the PIN Pad View States.

Sample values:

  • AddressLine1
  • PhoneNumber
Maximum LengthA numeric value from zero to 99 charactersSpecifies the maximum length for data entered into the field.
Minimum LengthA numeric value from zero to 99 charactersSpecifies the minimum length for data entered into the field.
PED Input FieldAn alphanumeric value from zero to 255 characters

Specifies the name of the PIN pad screen on which the customer information form is displayed. For more information about configuring the screens of PIN pad devices, refer to Configuring the PIN Pad View States.

Note

This parameter accepts multiple values separated by a comma.

Format:

<ViewChain name>.<startingView>.

Sample values:

  • MemberEnrollment.FirstName
  • MemberEnrollment.EmailScreen
ValidatorAn alphanumeric value from zero to 40 characters

Specifies the validator used to validate the input.

Note

This parameter accepts multiple values separated by a comma.

Sample values:

The following values can enable third–party validation for retailers using SAIL.

  • SAEmailValidator—This value enables the validation of third–party e-mail addresses.
  • SAPhoneNumberValidator—This value enables the validation of third–party phone numbers.
Validator DataAn alphanumeric value from zero to 40 characters

Specifies the data that will be used for validation.

Sample values:

  • Match=^((?! and ).)*$—This value enables the POS application to customer name data entered using a PIN pad device.
  • “Match=^@.{30,}$”—This value enables the POS application to accept the following barcode formats:
    • PDF417
    • 2D barcode
    • Other driver’s license barcode formats that do not start with @ and have fewer than 30 characters
Default Data
Field IDInternal Storage NameDisplay TextMini
mum Length
Maxi
mum Length
Custom Input TypeInput
Mask
Custom Input DataValidatorValidator DataIs MaskedLinked Field to PED Data FieldIs PED OnlyPED Input FieldEntry MethodAlternate ID
Address1Address1Address Line 1030 Any(None)(None)WhiteSpaceValidator(None)NoAddressLine1No(None)0(None)
Address2Address2Address Line 2030 Any(None)(None)WhiteSpaceValidator(None)NoAddressLine2No(None)0(None)
AssociateID(None)Associate ID032AlphaNumeric(None)(None)(None)(None)No(None)No(None)0(None)
BagNumberBagNumberBag Number88Numeric(None)(None)(None)(None)No(None)No(None)0(None)
BagSealNumberBagSealNumberBag Seal Number88Numeric(None)(None)(None)(None)No(None)No(None)0(None)
BirthdateDateOfBirthBirthdate010DateOnly(None)(None)PreviousDateValidator(None)No(None)No(None)0(None)
BusPhoneNumber BusinessPhoneNumberBusiness Phone Number 1020PhoneNumber(None)(None)PhoneNumberValidatorValidCharacterSet=01234567890-(),AuthOverride=ApproveInvalidatedPhoneNumberNoBusinessPhoneNumberNo(None)0(None)
CardHolderName CardHolderNameCard Holder Name080Any(None)(None)RegexValidator,WhiteSpaceValidatorMatch=^((?! and ).)*$NoCardHolderNameNo(None)03
CareGuideCareGuideCare Guide020Any(None)(None)RegexValidator"Match=^(400522301812).*"No(None)No(None)2(None)
CityCityCity020AlphaNumeric(None)(None)WhiteSpaceValidator(None)NoCityNo(None)03
CNPIDTypePersonalIDTypeID Type016DropDown(None)idset=CardNotPresentTenderPersonalIDTypePOSLog(None)No(None)No(None)0(None)
ConfirmationNumberConfirmationNumberConfirmation #1010Numeric(None)(None)(None)(None)No(None)No(None)0(None)
CountryCountryCountry02Country(None)altid=Country(None)(None)No(None)No(None)0(None)
CreditSSNLast4WithPEDSocialSecurityLast4Last 4 Digits of SSN44Numeric(None)(None)(None)(None)NoSSNNoHouseAccountCreditAppPromptSSNLast4.PromptSSNLast40(None)
CustomerIDCustomerIdCustomer ID1010Numeric(None)(None)(None)(None)NoCustomerIdNoLookupSelect.LoyaltyNumber30
CustomerIDFieldLinkCustomerIdCustomer ID1010Numeric(None)(None)(None)(None)NoCustomerIdNoLookupSelect.LoyaltyNumber00
DateofBirth(None)Date of Birth010DateOnly(None)(None)PreviousDateValidator, MinimumAgeValidatorMinimumAge=18NoDateOfBirthNo(None)0(None)
DateofBirthMMDD(None)Date of Birth35MonthDate(None)(None)BaseDateFieldValidator(None)NoDateOfBirthNo(None)0(None)
DateofBirthMMDDWithPEDDateOfBirthMMDDDate of Birth35MonthDate(None)(None)BaseDateFieldValidator(None)NoDateOfBirthMMDDNoMemberEnrollment.DateOfBirthMMDD0(None)
DateOfPurchase(None)Date of Purchase010DateOnly(None)(None)TodayOrPreviousDateValidator(None)No(None)No(None)0(None)
DepositBagNumberDepositBagNumberDeposit Bag #1010Numeric(None)(None)(None)(None)No(None)No(None)0(None)
DepositSlipNumberDepositSlipNumberDeposit Slip Number1010Numeric(None)(None)(None)(None)No(None)No(None)0(None)
DestinationNameExternalFinancialEntityNameDestination035Any(None)(None)(None)(None)No(None)No(None)0(None)
DriversLicenseExpiryDateDriversLicenseExpiryDateDriver's License Expiry Date010DateOnly(None)(None)TodayOrFutureDateValidator(None)No(None)No(None)0(None)
DriversLicenseIssuingStateDriversLicenseIssuingStateDriver's License Issuing State02CountrySubdivision(None)altid=CountrySubdivisionCountrySubdivisionValidatorReferenceField=CountryNoStateNo(None)0(None)
DriversLicenseNumberPersonalIDNumberDrivers License525Any(None)(None)WhiteSpaceValidator(None)No(None)No(None)0(None)
EmailEmailEmail060Email(None)(None)EmailValidatorAuthOverride=ApproveInvalidatedEmailAddressNoEmailNo(None)06
EmailWithPEDEmailEmail060Email(None)(None)EmailValidatorAuthOverride=ApproveInvalidatedEmailAddressNoEmailNoMemberEnrollment.EmailScreen0(None)
ESNESNESN1111Any(None)(None)CharacterSetValidatorValidCharacterSet=01234567890ABCDEFGHIJKLMNOPQRSTUVWXYZNo(None)No(None)0(None)
EventDate(None)Event Date010DateOnly(None)(None)TodayOrFutureDateValidator(None)No(None)No(None)0(None)
ExemptionExpirationExemptionExpirationExpiration010DateOnly(None)(None)TodayOrFutureDateValidator(None)No(None)No(None)0(None)
ExpirationExpirationDateExpiration010DateOnly(None)(None)TodayOrFutureDateValidator(None)No(None)No(None)0(None)
ExpireDateMMYYExpirationDateExpiration Date35MonthYear(None)(None)TodayOrFutureDateValidator(None)No(None)No(None)0(None)
FirstNameFirstNameFirst Name027Any(None)(None)RegexValidatorMatch=^((?! and ).)*$NoFirstNameNo(None)03
FirstNameWithPEDFirstNameFirst Name027Any(None)(None)RegexValidatorMatch=^((?! and ).)*$NoFirstNameNo(None)0(None)
HomePhoneNumber(None)Home Phone Number1020Phone Number(None)(None)PhoneNumberValidatorValidCharacterSet=01234567890-(),AuthOverride=ApproveInvalidatedPhoneNumberNoHomePhoneNumberNo(None)0(None)
IMEIIMEIIMEI Capture1517Numeric(None)(None)(None)(None)No(None)No(None)2(None)
InventoryItemCodeupcItem Code014Numeric(None)key=uniquekey(None)(None)No(None)No(None)0(None)
InventoryItemSizesizeItem Size016Any(None)key=sizeDescriptions(None)(None)No(None)No(None)0(None)
InventoryItemStylestyleItem Style #016Any(None)key=productStyles(None)(None)No(None)No(None)0(None)
InventoryItemSearchRangerangeDistance03Numeric(None)prefillparam=POSInventory.DefaultInventorySearchDistanceParameter(None)(None)No(None)No(None)0(None)
InventoryZipCodelocationZip Code510Any(None)prefillparam=POSInventory.LocatorPostalCodeParameterCharacterSetValidatorValidCharacterSet=01234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ -NoZipCodeNo(None)03
Issuing CountryPersonalIDCountryIssuing Country02Country(None)altid=Country(None)(None)No(None)No(None)0(None)
IssuingStatePersonalIDStateIssuing State02CountrySubdivision(None)altid=CountrySubdivisionCountrySubdivisionValidatorReferenceField=CountryNo(None)No(None)0(None)
ItemCodeItemCodeItem Code014Numeric(None)key=uniquekey(None)(None)No(None)No(None)0(None)
ItemColorItemColorItem Color016Any(None)key=colorDescriptions(None)(None)No(None)No(None)0(None)
ItemDepartmentItemDepartmentItem Department016Any(None)key=departmentDescription(None)(None)No(None)No(None)0(None)
ItemDescriptionItemDescriptionItem Description035Any(None)key=longDescription(None)(None)No(None)No(None)0(None)
ItemSizeItemSizeItem Size016Any(None)key=sizeDescriptions(None)(None)No(None)No(None)0(None)
ItemStyleStyleNumberItem Style #016Any(None)key=productStyles(None)(None)No(None)No(None)0(None)
ItemVendorItemVendorItem Vendor016Any(None)key=vendorCodes(None)(None)No(None)No(None)0(None)
LastNameLastNameLast Name028Any(None)(None)RegexValidator,WhiteSpaceValidatorMatch=^((?! and).*$NoLastNameNo(None)03
LastNameWithPEDLastNameLast Name028Any(None)(None)RegexValidator,WhiteSpaceValidatorMatch=^((?! and).*$NoLastNameNoMemberEnrollment.LastName0(None)
LocalReceiptMessage1LocalReceiptMessage1Local Receipt Message 1044Any(None)(None)(None)(None)No(None)No(None)0(None)
LocalReceiptMessage2LocalReceiptMessage2Local Receipt Message 2044Any(None)(None)

(None)

(None)No(None)No(None)0(None)
LocalReceiptMessage3LocalReceiptMessage3Local Receipt Message 3044Any(None)(None)(None)(None)No(None)No(None)0(None)
LocalReceiptMessage4LocalReceiptMessage4Local Receipt Message 4044Any(None)(None)(None)(None)No(None)No(None)0(None)
LocalReceiptMessage5LocalReceiptMessage5Local Receipt Message 5044Any(None)(None)(None)(None)No(None)No(None)0(None)
LookupEmailWithPEDEmailEmail060Email(None)(None)EmailValidatorAuthOverride=ApproveInvalidatedEmailAddressNoEmailNoLookupSelect.EmailScreen06
LookupPhoneNumberWithPEDPhoneNumberTelephone1020PhoneNumber(None)(None)PhoneNumberValidatorValidCharacterSet=01234567890-()AuthOverride=ApproveInvalidatedPhoneNumberNoPhoneNumberNoLookupSelect.PhoneNumber03
MicrosoftSNSerialNumberSerial Number1212Numeric(None)(None)RegexValidator, Microsoft"Match=\b\d{10}[01345]\d{1}\b"No(None)(None)(None)2(None)
MicrosoftXBOXSNSerialNumberSerial Number1414Numeric(None)(None)RegexValidator"Match=\b\d{10}[01345]{1}\d{3}\b"No(None)(None)(None)2(None)
MiddleNameMiddleNameMiddle Name025Any(None)(None)RegexValidator,WhiteSpaceValidatorMatch=^((?! and).)*$No(None)No(None)03
MilitaryIDNumberPersonalIDNumberMilitary ID2525Any(None)(None)(None)(None)No(None)No(None)0(None)
Nintendo11SNSerialNumberSerial Number1111Any(None)(None)RegexValidator, Nintendo11"Match=\b[a-z,A-Z]{2}(\d){9}\b"No(None)(None)(None)2(None)
Nintendo14SNSerialNumberSerial Number1414Any(None)(None)RegexValidator, Nintendo14"Match=\b[a-z,A-Z]{3}(\d){11}\b"No(None)(None)(None)2(None)
NoOfBagsNoOfBags# Bags09Numeric(None)(None)NoOfBagsAllowed(None)No(None)No(None)0(None)
NoteCustomNotesNote099Any(None)(None)(None)(None)No(None)No(None)0(None)
Organization OrganizationOrganization 024AlphaNumeric(None)(None)(None)(None)No(None)No(None)0(None)
OrganizationNumberOrganizationNumberOrganization #010Numeric(None)(None)(None)(None)No(None)No(None)0(None)
PassportNumberPassportNumberPassport Number2525Any(None)(None)(None)(None)No(None)No(None)0(None)
PersonalIDPersonalIDID Number325Any(None)(None)PersonalIDFieldValidatorReferenceField=PersonalIDType, ValidationSchemeID=PersonalIDFieldLinkNo(None)No(None)0(None)
PersonalIDType(None)ID Type025Selection(None)idset=NonReceiptedCustomerIdTypesPersonalIDTypePOSLog(None)No(None)No(None)0(None)
PetAdoptionGroupPetAdoptionGroupAdoption Group Info56Numeric(None)(None)(None)(None)No(None)No(None)2(None)
PetAdoptionKitPetAdoptionKitPet Adoption Kit1214Numeric(None)(None)(None)(None)No(None)No(None)2(None)
PetSalesRecordPetSalesRecordPet Sales Record020Any(None)(None)RegexValidator"Match=^(040050638013).*"No(None)No(None)2(None)
PhoneNumberPhoneNumberTelephone1020PhoneNumber(None)(None)PhoneNumberValidatorValidCharacterSet=01234567890-(),AuthOverride=ApproveInvalidatedPhoneNumberNoPhoneNumberNo(None)03
PhoneNumberWithPEDPhoneNumberTelephone1020PhoneNumber(None)(None)PhoneNumberValidatorValidCharacterSet=01234567890-(),AuthOverride=ApproveInvalidatedPhoneNumberNoPhoneNumberNoMemberEnrollment.PhoneNumber0(None)
PickupDatePickupDatePickup Date010DateOnly(None)(None)TodayOrFutureDateValidator(None)NoPreScreenNumberNo(None)0(None)
PreScreenNumberCreditPreScreenNumberPre Screen Number1212Numeric(None)(None)(None)(None)No(None)No(None)0(None)
ReceiptDepositDateReceiptDepositDateDate010DateOnly(None)(None)TodayOrPreviousDateValidator(None)No(None)No(None)0(None)
ReceiptNumberReceiptNumberReceipt Number3434Numeric(None)(None)(None)(None)No(None)No(None)2(None)
ResidentAlienID(None)Resident Alien ID88AlphaNumeric(None)(None)(None)(None)No(None)No(None)0(None)
ReturnReasonTextAdditionalTextAdditional Detail099Any(None)(None)(None)(None)No(None)No(None)0(None)
RxNumberRxNumberRx Number120Numeric(None)(None)(None)(None)No(None)No(None)2(None)
ServiceInvoiceServiceInvoiceService Invoice18Numeric(None)(None)(None)(None)No(None)No(None)2(None)
ShoppingTagShoppingTagShopping Tag1616Numeric(None)(None)RegexValidatorMatch=^6037437[0-9]*$No(None)No(None)03
SocialSecurityNumberSocialSecuritynumberSocial Security Number025Numeric(None)(None)(None)(None)NoSSNNo(None)03
SoldByEmployee(None)Sold By Employee025AlphaNumeric(None)(None)(None)(None)No(None)No(None)0(None)
SourceNameExternalFinancialEntityNameSource135Any(None)(None)(None)(None)No(None)No(None)0(None)
SSNFullWithPEDSocialSecurityNumberSocial Security Number99NumericLast4(None)(None)(None)NoSSNNoHouseAccountCreditAppPromptFullSSN.PromptSSNFull0(None)
SSNLast4WithPEDSocialSecurityLast4Last 4 digits of SSN44Numeric(None)(None)(None)(None)NoSocialSecurityLast4NoMemberEnrollment.SocialSecurityLast40(None)
StateStateState22CountrySubdivision(None)altid=CountrySubdivisionCountrySubdivisionValidatorCountryNoStateNo(None)0(None)
StateCodeStateIssuing State22Any(None)(None)(None)(None)No(None)No(None)0(None)
StateIssuedID(None)State Issued ID88AlphaNumeric(None)(None)(None)(None)No(None)No(None)0(None)
StreetNumber(None)Street Number025AlphaNumeric(None)(None)(None)(None)NoStreetNumberNo(None)0(None)
TaxExemptIDCertificateNumberTax Exempt ID025AlphaNumeric(None)(None)(None)(None)No(None)No(None)0(None)
TrainerFirstNameTrainerFirstNameTrainer's First Name120Any(None)(None)(None)(None)No(None)No(None)2(None)
TrainingReturnStartDateTrainingReturnStartDateTraining Start Date010DateOnly(None)(None)PastOrFutureDateValidatorFutureDaysLimit=365No(None)No(None)2(None)
TrainingStartDateTrainingStartDateTraining Start Date010DateOnly(None)(None)TodayOrFutureDateValidatorFutureDaysLimit=120No(None)No(None)2(None)
ZipCodeZipCodeZip Code510Any(None)(None)CharacterSetValidatorValidCharacterSet=01234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ -No(None)No(None)03
ZipCodeWithPEDZipCodeZip Code510Any(None)(None)CharacterSetValidatorValidCharacterSet=01234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ -NoZipCodeNoMemberEnrollment.ZipCode0(None)
Sample Data

The following table provides sample records that can be used to support different POS features according to each retailer's needs.

Related POS featureField IDInternal Storage NameDisplay TextMini
mum Length
Maxi
mum Length
Custom Input TypeInput
Mask
Custom Input DataValidatorValidator DataIs MaskedLinked Field to PED Data FieldIs PED OnlyPED Input FieldEntry MethodAlternate ID
Band Use Tax ExemptionStatusCardExemptionIdStatus Card110Numeric(None)(None)(None)(None)Yes(None)(None)(None)0(None)
Enhanced Paid InPONumberNonMerchandiseAdditionalInfoPO Number135Numeric(None)(None)(None)(None)No(None)No(None)0(None)
Enhanced Paid InReasonCodeNonMerchandiseAdditionalInfoReason Code135DropDown(None)DepositCheck=Deposit Check;Supply=Supply Purchase(None)(None)No(None)No(None)0(None)
Enhanced Paid InVendorNameNonMerchandiseAdditionalInfoVendor Name135Any(None)(None)(None)(None)No(None)No(None)0(None)
Enroll Customer ScreenOptInEmailOptInEmailOpt-In Email010DropDown(None)Yes=Yes;No=No(None)(None)No(None)No(None)0(None)
Enroll Customer ScreenOptInTextOptInTextOpt-In Text010DropDown(None)Yes=Yes;No=No(None)(None)No(None)No(None)0(None)
Enroll Customer ScreenPhoneTypePhoneTypePhone Type010DropDown(None)Mobile=Mobile;Home=Home;Work=Work(None)(None)No(None)No(None)0(None)
Item ActivationSerialNumber SerialNumberSerial Number 514Numeric(None)(None)(None)(None)No(None)(None)(None)2(None)
Member Information UpdateOptInEmailOptInEmailOpt-In Email010DropDown(None)Yes=Yes;No=No(None)(None)No(None)No(None)0(None)
Member Information UpdateOptInTextOptInTextOpt-In Text010DropDown(None)Yes=Yes;No=No(None)(None)No(None)No(None)0(None)
Member Information UpdatePhoneTypePhoneTypePhone Type010DropDown(None)Mobile=Mobile;Home=Home;Work=Work(None)(None)No(None)No(None)0(None)
Printing Associate ChitAssociateID(None)Associate ID099AlphaNumeric(None)(None)(None)(None)No(None)No(None)1(None)