SCA Functional Specification

Deployment Parameters

Last updated: 04-Dec-2024
Download as PDF

This table describes the required parameters used for deployment configurations.

Config.usr1/Parameter DLD Name Description Valid/Max Values Default Value Name in PropertiesData.xml
AUTOPREAMBLE
  • Y – SCA will perform automated preamble process. NOTE: If autopreamble=Y and preamble_success=Y then preamble can be skipped.
  • N – Merchant must access SCA menu structure to manually complete preamble
  • N - Disable
  • Y - Enable
 Y autopreamble
DIALCONFIGREQD
  • N – SCA will not prompt for dial setup
  • Y – SCA will prompt for dial setup. NOTE: If preamble_success=Y then preamble prompting for dial setup can be skipped
  • N - Disable
  • Y - Enable
 N dialconfigreqd
DOADMREQ This parameter is used to get device key. Setting the parameter value as 1, can be used in order to move a device from one Client ID to another and perform the registration to PWC. When the parameter value is 2, it can be used in case of re-sync with PWC is needed. This option can be used by merchant to perform re-sync with PWC without resetting the device on PWC.
  • 0 – DDo not perform Device Registration.
  • 1 – Clear Keys on Device and Perform Device Registration.
  • 2 – Perform Registration again on the device.
 2 doadmreq
DOADMREQPINPAD This parameter is used for preamble admin request for the External PINPad device. Setting the parameter value as 1, can be used in order to move a device from one Client ID to another and perform the registration to PWC. When the parameter value is 2, it can be used in case of re-sync with PWC is needed. This option can be used by merchant to perform re-sync with PWC without resetting the device on PWC. NOTE: This parameter is applicable if ANYWHERECARDENABLED is set to 1.
  • 0 – Do not perform Device Registration.
  • 1 – Clear Keys on Device and Perform Device Registration.
  • 2 – Perform Registration again on the device.
 1 doadmreqpinpad
ENCRYPTION_ACTIVATED This parameter is used to decide on preamble encryption activation. When the value is set to N, means encryption activation did not take place or was unsuccessful. The application will trigger another VSP registration attempt (3 attempts including first try). When the value is set to Y, means encryption activation successfully completed. NOTE: If encryption_activated = N and redoencreg=N then encryption registration can be skipped. NOTE: Encryption type used by SCA, defined in ENCRYPTMODE parameter in PropertiesData.xml.
  • N - No
  • Y - Yes
 N encryption_activated
ENCRYPTION_ACTIVATEDPINPAD This parameter is used to decide on preamble encryption activation for the External PINPad device. When the value is set to N, means encryption activation did not take place or was unsuccessful. The application will trigger another VSP registration attempt (3 attempts including first try). When the value is set to Y, means encryption activation successfully completed. NOTE: This parameter is applicable if ANYWHERECARDENABLED is set to 1. NOTE:* If encryption_activated = N and redoencreg=N then encryption registration can be skipped. **NOTE: Encryption type used by SCA, defined in ENCRYPTMODE parameter in PropertiesData.xml.
  • N - No
  • Y - Yes
 N encryption_activatedpinpad
LANEIDLENGTH Length of Lane ID required during the merchant settings acceptance stage on startup (based on MERCHANTSETTINGSREQD) Numeric, 0 to Default behavior Blank laneidlength
MAXIPRETRYCOUNT Number of attempts the application needs to make to connect to the network before proceeding with initialization. -1 – Infinite, Numeric > 0 5 maxipretrycount
MERCHANTSETTINGSREQD This parameter is used to enable and disable prompt for merchant MID/TID/Lane at preamble. NOTE: When MERCHANTSETTINGSREQD is set to Y, MIDLENGTH, TIDLENGTH, LANEIDLENGTH and DOADMREQ parameters also need to be configured mandatorily to get successful preamble by entering MID, TID and LANEID details, when they are prompted during host registration process.
  • N - Disable
  • Y - Enable
 N merchantsettingsreqd
MIDLENGTH Length of Merchant ID required during the merchant settings acceptance stage on startup (based on MERCHANTSETTINGSREQD) Numeric, 0 to Default behavior Blank midlength
NETWORKCFGREQD This parameter is used to enable and disable prompt for network configuration screen
  • N - Disable
  • Y - Enable
  1. For UGP the default is N
 networkcfgreqd
PPCLMIDPROMPT This parameter is used to enable and disable PPCLMID (ValueLink Merchant ID) prompt. If the value is set to 1, the application will prompt for PPCLMID. If set to 0 then no prompt for PPCLMID under merchantsettingsreqd. NOTE: This parameter is applicable only if MERCHANTSETTINGSREQD is set to Y.
  • 0 - Disable
  • 1 - Enable
 0 ppclmidprompt
PREAMBLECOMMSETUP
  • DIAL – Not available as of this publication Dial-up transaction processing will be used. Merchant will be required to load Authorization phone number into configuration file. SCA will not prompt for this.
  • IP – IP transaction processing will be used
  • DIAL
  • IP
 IP preamblecommsetup
PREAMBLE_SUCCESS
  • N - Preamble not successful (will need to be re-attempted)
  • Y - Preamble was successful
  • N - No
  • Y - Yes
 N preamble_success
PROMPTVHQDEVICEID This parameter is used to prompt for Device ID on the terminal during Preamble. If PROMPTVHQDEVICEID is set to 1, then the terminal will prompt for Device ID. Once Device ID is entered, VHQ will download Parameter Template automatically if it is out of Sync. If PROMPTVHQDEVICEID is set to 0, the terminal will not prompt for Device ID. NOTE: Once the Device ID is entered, this Device ID will be stored in the VHQDEVICEID parameter, that can be accessed using SCA Configuration menu in the Terminal.
  • 0 - Disable
  • 1 - Enable
 0 promptVHQDeviceID
REDOENCREG This parameter is used to redo the encryption registration. NOTE: If encryption_activated = N and redoencreg=n then encryption registration can be skipped.
  • N - No
  • Y - Yes
 Y redoencreg
REDOENCREGPINPAD This parameter is used to redo the encryption registration for the External PINPad device. NOTE: This parameter is applicable if ANYWHERECARDENABLED is set to 1. NOTE: If encryption_activated = N and redoencreg=n then encryption registration can be skipped.
  • N - No
  • Y - Yes
 Y redoencregpinpad
SKIPLANEIDPROMPT This parameter is used to enable or disable skip lane ID prompt during merchant setup.
  • 0 - Disable
  • 1 - Enable
 0 skiplaneidprompt
TIDLENGTH Length of Terminal ID required during the merchant settings acceptance stage on startup (based on MERCHANTSETTINGSREQD) Numeric, 0 to Default behavior Blank tidlength
VHQDEVICEIDLENGTH This parameter is used to set the length for VHQ Device ID. NOTE: If the value is set to 0 or blank, then the application will ignore this parameter. Numeric, 2. Possible value: 1 - 99 Blank vhqdeviceidlength
Rate this article:

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Get in touch

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Contact sales Get Started
Verifone logo