Secondary Settings

These settings are normally correct at their default values but can be overridden if necessary.

Table 4-2 OPI - Secondary Settings

Setting Description Default Example

RequestResponseTimeout

Specifies the timeout when sending / receiving messages to / from the Oracle Payments Interface in seconds.

180

RequestResponseTimeout = 200

DetectReceiptSignatur eString

Specifies the text to find in the print data returned from the Oracle Payments Interface response in order to determine whether a signature check prompt is required for the request.

Signature

DetectReceiptSignatureString = # Signature #

ValidateMessaging

Specifies whether to validate all requests / responses against their respective XSDs.

false

ValidateMessaging = true

MaintenanceTimeout

Specifies the timeout for the core maintenance menu in seconds.

60

MaintenanceTimeout = 30

SignatureCheckTimeout

Specifies the timeout for the Signature Check prompt when required in seconds.

30

SignatureCheckTimeout = 15

BusyErrorText

Specifies the error text when the device is busy.

Device error retry

BusyErrorText = Busy Device Error

ReadResponseBuffer

Specifies a minimum buffer amount to allocate space in memory as a rough approximation of the expected content length of an OPI Retail Response in bytes.

1024

ReadResponseBuffer = 1024

MaxLineItemTextLength

Specifies the max length of an Item Description in characters. This is used to truncate the length of the item description in case the description of a product is too long during line item display on the pin entry device (PED) and on S/P request payload.

64

MaxLineItemTextLength = 64

CombinedReceiptFilter_X

Specifies custom filtering of information on the customer receipt. Replace X with a number between 0 and 100. A maximum of 100 filters are allowed and <blank> checks if empty lines should be suppressed.

blank

CombinedReceiptFilter_0 = <blank>

SuppressMerchantCopyForDecline

Specifies whether to suppress the printing of the merchant receipt transactions are declined.

false

SuppressMerchantCopyForDecline = false

DoNotCombineCustomerReceiptForDecline

Specifies whether to combine the customer receipt with the POS receipt when transactions are declined.

false

DoNotCombineCustomerReceiptForDecline = false

CardAcquisitionPromptTimeout

Specifies the timeout for the CardInserted DeviceRequest prompt on the POS for the specified BinRange and CountryCode sent from the TransactionResponse in seconds.

1200

CardAcquisitionPromptTimeout = 1200

GetCustomerVerificationAcceptLabel

Specifies the text label of the accept button for the Get Customer Verification custom form.

Yes

GetCustomerVerificationAcceptLabel = No

GetCustomerVerificationDeclineLabel

Specifies the text label of the decline button for the Get Customer Verification custom form.

No

GetCustomerVerificationDeclineLabel = No

DisplayMessageDuration

Specifies the timeout duration of the display message custom form in seconds.

30

DisplayMessageDuration = 60

GetPhoneNumberUseMaxLength

Specifies whether to use max length instead of the regex for phone number capture custom form.

true

GetPhoneNumberUseMaxLength = true

GetPhoneNumberMaxLength

Specifies the maximum number of digits for the phone number capture custom form.

10

GetPhoneNumberMaxLength = 12

GetPhoneNumberRegex

Specifies the regular expression for the phone number capture custom form.

\d{3}-\d{3}-\d{4}

GetPhoneNumberRegex = \d{3}-\d{3}-\d{4}

GetPhoneUseType63

Whether to use the transaction type 63 GetAlphaNumeric instead of the GetNumericField for capture Phone from PED.

false

GetPhoneUseType63 = false

GetSSNUseMaxLength

Specifies whether to use max length instead of the regex for social security number capture custom form.

false

GetSSNUseMaxLength = true

GetSSNMaxLength

Specifies the max length of the social security number capture custom form.

9

GetSSNMaxLength = 9

GetSSNRegex

Specifies the regular expression for the social security number capture custom form.

\d{3}-\d{2}-\d{4}

GetSSNRegex = \d{3}-\d{2}-\d{4}

GetEmailAddressMaxLength

Specifies the max length of the email address capture custom form.

50

GetEmailAddressMaxLength = 100

GetDriverLicenseMaxLength

Specifies the max length of the driver license capture custom form.

20

GetDriverLicenseMaxLength = 20

GetNumericFieldUseMaxLength

Specifies whether to use max length instead of a regex for the numeric field custom form.

true

GetNumericFieldUseMaxLength = true

GetNumericFieldMaxLength

Specifies the max length of the numeric field capture custom form.

50

GetNumericFieldMaxLength = 50

GetNumericFieldRegex

Specifies the regular expression for the numeric field custom form. Default is empty.

GetNumericFieldRegex = \d{3}-\d{2}-\d{4}

GetAlphanumericFieldUseMaxLength

Specifies whether to use max length instead of a regex for the alpha numeric field custom form.

true

GetAlphanumericFieldUseMaxLength= true

GetAlphaNumericFieldMaxLength

Specifies the max length of the alpha numeric field capture custom form.

50

GetAlphaNumericFieldMaxLength = 50

GetAlphaNumericFieldRegex

Specifies the regular expression for the alpha numeric field custom form. Default is empty.

GetAlphaNumericFieldRegex = \d{3}-\d{2}-\d{4}

DisplayQRCodeButtonLabel

Specifies the label of the button on the QR code custom form.

Done

DisplayQRCodeButtonLabel = Cancel

GetPhoneNumberGuidanceText

Specifies the guidance text when capturing a phone number. Default is empty.

GetPhoneNumberGuidanceText = Please input your phone number below in the form of XXX-XXX-XXXX (replace X with a number between 0-9)

GetEmailAddressGuidanceText

Specifies the guidance text when capturing an email address. Default is empty.

GetEmailAddressGuidanceText = Please input your email address below, for example; test@oracleretail.com.

GetSSNGuidanceText

Specifies the guidance text when capturing a social security number. Default is empty.

GetSSNGuidanceText = Please input your social security number below, for example; 078-05-1120

GetDateGuidanceText

Specifies the guidance text when capturing a date of birth. Default is empty.

GetDateGuidanceText = Please input your date of birth below, for example; 1971-01-01 (YYYY-MM-DD)

GetDriverLicenseGuidanceText

Specifies the guidance text when capturing a driver license number. Default is empty.

GetDriverLicenseGuidanceText = Please input your driving license below, for example; 123 456 789

GetNumericFieldGuidanceText

Specifies the guidance text when capturing generic numeric data. Default is empty.

GetNumericFieldGuidanceText = Please input your loyalty number below, for example; 123-456-7891

GetAlphanumericFieldGuidanceText

Specifies the guidance text when capturing generic alpha-numeric data. Default is empty.

GetAlphanumericFieldGuidanceText = Please enter your name below incl. middle names, for example; Joe M Bloggs

MaxInstallmentsAllowed

Specifies the maximum number of installments allowed per transaction. If the entered value on the installments prompt exceeds the MaxInstallmentsAllowed value, the installments prompt will retry until the configured NoOfInstallmentsPromptRetries amount is reached.

24

MaxInstallmentsAllowed = 30

NoOfInstallmentsPromptRetries

Specifies the number of installments prompt retries.

3

NoOfInstallmentsPromptRetries = 1

NoOfInstallmentsPromptTimeout

Specifies the timeout in seconds of the number of installments prompt.

600

NoOfInstallmentsPromptTimeout = 60

DebitCreditSele ctionPromptTimeout

Specifies the timeout in seconds of the prompt between Debit and Credit card type.

600

DebitCreditSelec tionPromptTimeout = 60

GiftCardPinEntryOnPOSEnabled

Specifies whether to enable processing of Gift Card Pins from the POS.

Do not use this setting in conjunction with GiftCardPinEntryOnPEDEnabled=true as GiftCardPinEntryOnPOSEnabled will take precedence.

false

GiftCardPinEntryOnPOSEnabled = true

GiftCardPinEntryOnPEDEnabled

Specifies whether to request a PIN for the supplied Gift Card on the PED.

Do not use this setting in conjunction with GiftCardPinEntryOnPOSEnabled=true as GiftCardPinEntryOnPOSEnabled will take precedence.

false

GiftCardPinEntryOnPEDEnabled = true

GiftCardPinEntryTypes

Specifies which OPI Retail Gift Card Transactions should apply Gift Card PIN processing.

This is a comma-delimited string, and the values must map to the OPI Retail TransType equivalents.

27,28,29,30

GiftCardPinEntryTypes = 27,28,29,30

GiftCardPinEntryMinimumLength

Specifies the minimum length of the PIN to be entered on the POS.

4

GiftCardPinEntryMinimumLength = 3

GiftCardPinEntryMaximumLength

Specifies the maximum length of the PIN to be entered on the POS.

4

GiftCardPinEntryMaximumLength = 6

GiftCardPinEntryRetries

Specifies the maximum amount of retries to attempt on the POS if the default maximum length of the PIN in the OPI specification is exceeded.

This property may be used in the event that the GiftCardPinEntryMinimumLength and GiftCardPinEntryMaximumLength settings are not set.

3

GiftCardPinEntryRetries = 5

GiftCardProviders

Specifies the gift card provider to use, when a single entry is configured.

If a list of providers is specified, the cashier will be prompted to select the provider from the list.

If no GiftCardProvider is specified, then this entry will not be used, and no value is passed to the EPS in the ProviderId element of the TransactionRequest. This is a comma-delimited string.

blank

GiftCardProviders = SVS, GIVEX

GiftCardProvidersPromptTimeou

Specifies the timeout in seconds to be used for the Gift Card Provider selection prompt.

1200

GiftCardProvidersPromptTimeout==1200
EnforceCardNameSetByOPI If true, the card name returned in the CardServiceResponse adheres to the mappings specified by the OPI spec and is not overridden by any mapping performed within the cardrange.xml. false EnforceCardNameSetByOPI = true

QuickChipAverageTransactionValue

Specifies the average quickchip transaction value. This value determines the PED prompts in the transaction (for example NFC).

20

QuickChipAverageTransactionValue = 20

InvoicePaymentPromptForCardOrCashEnabled

Specifies whether to prompt for Card or Cash at the POS for Invoice Payment transactions.

false

InvoicePaymentPromptForCardOrCashEnabled = true

InvoicePaymentPromptForCardOrCashTimeout

Specifies the timeout in seconds of the prompt for Card or Cash for Invoice Payments transactions.

600

InvoicePaymentPromptForCardOrCashTimeout = 720

InvoicePaymentPromptScanBarcodeRetries

Specifies the number of Scan Barcode prompt retries.

3

InvoicePaymentPromptScanBarcodeRetries = 6

CellPhoneRechargePromptForCardOrCashEnabled

Specifies whether to prompt for Card or Cash at the POS for Cell Phone Recharge transactions.

false

CellPhoneRechargePromptForCardOrCashEnabled = true

CellPhoneRechargePromptForCardOrCashTimeout

Specifies the timeout in seconds of the prompt for Card or Cash for Cell Phone Recharge transactions.

600

CellPhoneRechargePromptForCardOrCashTimeout = 720

MerchantReference

Unique merchant reference.

N/A

MerchantReference=Merchant A

MerchantReferenceFormat

Specify the format of the merchant reference - replaces static value with a dynamically generated value using several substitutions.

See Merchant Reference Formats.

R (use existing static merchant ref)

MerchantReferenceFormat=R-dddddddddd-SSSSSS.WW WWWW.YYYYMMDD.hhmmss.TTTTTT.qq

CapCancellation

Determines response for the getCapCancellation request.

true

CapCancellation = false

CapReversal

Determines response for the getCapReversal request

true

CapReversal = false

MerchantReferenceSpecialChar

Specify a character that is to be passed through 'as is' in addition to the ones already mentioned.

N/A

MerchantReferenceSpecialChar = K

PrintDataLogMasking

When enabled force masking on log of receipt information on <PrintData> tag

false

PrintDataLogMasking = false

AlternativePrintDataOrder If true, then the OPICore expects the customer receipt copy first and the merchant receipt copy second inside the PrintData field within the transaction response. false AlternativePrintDataOrder = true
SaleTransactionRequestLineItemEnabled If false, this will suppress the LineItem Field within the S/P Transaction request. true SaleTransactionRequestLineItemEnabled = false
UsePspPaymentBrandForCardCircuit If true, and a value exists in the pspPaymentBrand field, then this value is mapped to the CardCiruit field in the cardServiceResponse. false UsePspPaymentBrandForCardCircuit = true
AdminMenu0.<X> Specifies the ability to customize the Admin Menu. Replace X with a value between 0 - 2.

AdminMenu0.1 = TXT_RECONCILIATION, Reconciliation

AdminMenu0.2 = TXT_CANCEL, Cancel

AdminMenu0.1 = TXT_RECONCILIATION, Reconciliation

AdminMenu0.2 = TXT_CANCEL, Cancel
IssuerId_<31 - 60> Allows the modification to the default IssuerId values set in the OPI Spec. Defaults match the values set by the OPI Spec Issuerid31 = Bluebird