Class TerminalSettings

the Settings for one terminal.

Inheritance

System.Object

TerminalSettings

Namespace: SIX.TimApi

Assembly: TimApi.dll

Syntax

public class TerminalSettings : object

Remarks

The per terminal configuration can be done on two ways:

• In a configuration file "TimApi.cfg"
• With the API TerminalSettings done from the application.

TIMApi reads the configuration file when the first Terminal instance is created.

The class TerminalSettings allows the setting from Application. Each instance of the Terminal class is initialized using an own instance of TerminalSettings containing the configuration relevant for this terminal. The Terminal instances read only the configuration file section with the matching terminal identifier. Multiple terminals can be configured as long as their terminal identifier are different.

All configuration has to be done before an instance of TerminalSettings is used to create a Terminal class instance.

Defines also automatic behavior for interacting with EFT terminals. By default all automatic behaviors are enabled.

Constructors

TerminalSettings()

Initializes a new instance of the TerminalSettings class.

Declaration

public TerminalSettings()

TerminalSettings(String)

Initializes a new instance of the TerminalSettings class.

Declaration

public TerminalSettings(String deviceId)

Parameters

Type	Name	Description
String	deviceId	The device identifier.

Fields

_ConnectTimeout

How long TIM API shall wait listening/connecting in seconds.

Declaration

public int _ConnectTimeout

Field Value

Type	Description
System.Int32

_MaxWaitForIdleAfterBusy

How long TIM API shall wait on the terminal in case it is busy to again become idle, in seconds. Round down to the next 2-divisable number (e.g. 11s > 10s).

Declaration

public int _MaxWaitForIdleAfterBusy

Field Value

Type	Description
System.Int32

PathTimApiCfg

Path to configuration file to load. Default value is "TimApi.cfg". Set this value before constructing a TerminalSettings instance.

Declaration

public static string PathTimApiCfg

Field Value

Type	Description
System.String

Properties

AllowClosedCardInsert

Allow insert card before activation.

Declaration

public bool AllowClosedCardInsert { get; set; }

Property Value

Type	Description
System.Boolean

AutoCommit

Declaration

public bool? AutoCommit { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AutoShiftManagement

Declaration

public bool AutoShiftManagement { get; set; }

Property Value

Type	Description
System.Boolean

AutoShutterManagement

Declaration

public bool AutoShutterManagement { get; set; }

Property Value

Type	Description
System.Boolean

AutoSysInfo

Declaration

public bool AutoSysInfo { get; set; }

Property Value

Type	Description
System.Boolean

BroadcastInterface

Gets or sets the broadcast interface.

Declaration

public String BroadcastInterface { get; set; }

Property Value

Type	Description
String

CardInsertionTimeout

Timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request.

Declaration

public int CardInsertionTimeout { get; set; }

Property Value

Type	Description
System.Int32	The card insertion timeout.

CardRemovalTimeout

Timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction.

Declaration

public int CardRemovalTimeout { get; set; }

Property Value

Type	Description
System.Int32	The card removal timeout.

CommitTimeout

Timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received. Timer starts with response and is reset in case client enters information in the terminal.

Declaration

public int CommitTimeout { get; set; }

Property Value

Type	Description
System.Int32	The commit timeout.

ConnectionIPPort

Listening Port of the EFT terminal in case of ConnectionMode OnFixIP.

Declaration

public int ConnectionIPPort { get; set; }

Property Value

Type	Description
System.Int32	The connection ip port.

ConnectionIPString

IP address of the EFT terminal in case of ConnectionMode OnFixIP.

Declaration

public String ConnectionIPString { get; set; }

Property Value

Type	Description
String	The connection ip string.

ConnectionListen

EFT connects to ECR instead of ECR connecting to EFT, which is the default way to connect.

Declaration

public bool ConnectionListen { get; set; }

Property Value

Type	Description
System.Boolean

ConnectionListenIPPort

Listening Port of the ECR if listening.

Declaration

public int ConnectionListenIPPort { get; set; }

Property Value

Type	Description
System.Int32	The connection listen ip port.

ConnectionListenIPString

IP address of the ECR if listening.

Declaration

public String ConnectionListenIPString { get; set; }

Property Value

Type	Description
String	The connection listen ip string.

ConnectionMode

Gets or sets the connection mode. default: Broadcast

Declaration

public ConnectionMode ConnectionMode { get; set; }

Property Value

Type	Description
ConnectionMode	The connection mode.

ConnectTimeout

Declaration

public int ConnectTimeout { get; set; }

Property Value

Type	Description
System.Int32

Dcc

Indicates if Dcc shall be supported.

Declaration

public bool Dcc { get; set; }

Property Value

Type	Description
System.Boolean	true if DCC; otherwise, false.

EnabledHacks

Enabled hacks. For internal use only.

Declaration

public List<int> EnabledHacks { get; set; }

Property Value

Type	Description
List<System.Int32>

EnableKeepAlive

Enable Keep-Alive handling. Default is true.

Declaration

public bool EnableKeepAlive { get; set; }

Property Value

Type	Description
System.Boolean

FastNtfMode

Set enable fast notification mode. This parameter is only used if {@link com.six.timapi.constants.Guides#AUSTRIAN_USE_CASES} is enabled.

Declaration

public bool FastNtfMode { get; set; }

Property Value

Type	Description
System.Boolean

FetchBrands

Declaration

public bool FetchBrands { get; set; }

Property Value

Type	Description
System.Boolean

Guides

Required guides. Login succeeds only if the terminal is able to provide all requested guides.

Declaration

public List<Guides> Guides { get; set; }

Property Value

Type	Description
List<Guides>	The guides.

IntegratorId

Gets or sets the integrator identifier.

Declaration

public String IntegratorId { get; set; }

Property Value

Type	Description
String	The integrator identifier.

LateCheckinTimeout

This timeout indicates how long a terminal shall wait in seconds for an AmtAdjustment notification from the ECR in case of a late-checkin.

Declaration

public int LateCheckinTimeout { get; set; }

Property Value

Type	Description
System.Int32

LogBackend

Gets or sets the log level for the backend module.

Declaration

public String LogBackend { get; set; }

Property Value

Type	Description
String	The log level.

LogComm

Gets or sets the log level for the commumication module.

Declaration

public String LogComm { get; set; }

Property Value

Type	Description
String	The log level.

LogDir

Defines where the Log File has to be generated. Use "." to log into the current directory. Use empty string to disable logging.

Declaration

public String LogDir { get; set; }

Property Value

Type	Description
String	The log dir.

LogFileCountPerArchive

Number of log files to keep before per archive file.

Declaration

public int LogFileCountPerArchive { get; set; }

Property Value

Type	Description
System.Int32

LogRetainArchiveCount

Number of log file archives to keep before deleting them. Use 0 to disable delete

Declaration

public int LogRetainArchiveCount { get; set; }

Property Value

Type	Description
System.Int32

LogRetainFileCount

Number of log files to keep before archiving them. 0 to disable using archive files.

Declaration

public int LogRetainFileCount { get; set; }

Property Value

Type	Description
System.Int32

LogStateMachine

Gets or sets the log level for the statemachine module.

Declaration

public String LogStateMachine { get; set; }

Property Value

Type	Description
String	The log level.

LogTerminal

Gets or sets the log level for the terminal module.

Declaration

public String LogTerminal { get; set; }

Property Value

Type	Description
String	The log level.

ManufacturerFlags

Gets or sets the manufacturer flags.

Declaration

public int ManufacturerFlags { get; set; }

Property Value

Type	Description
System.Int32	The manufacturer flags.

MaxWaitForIdleAfterBusy

Declaration

public int MaxWaitForIdleAfterBusy { get; set; }

Property Value

Type	Description
System.Int32

OgoneBaseUrl

Ogone: Base URL.

Declaration

public String OgoneBaseUrl { get; set; }

Property Value

Type	Description
String

OmnichannelAPIKey

Omnichannel: Key for API access.

Declaration

public String OmnichannelAPIKey { get; set; }

Property Value

Type	Description
String

OmnichannelAPISecret

Omnichannel: Secret key for API access.

Declaration

public String OmnichannelAPISecret { get; set; }

Property Value

Type	Description
String

OmnichannelHostTimeout

Declaration

public int OmnichannelHostTimeout { get; set; }

Property Value

Type	Description
System.Int32

OmnichannelHostURL

Omnichannel: Host-URL (for example Ogone's Direct API URL).

Declaration

public String OmnichannelHostURL { get; set; }

Property Value

Type	Description
String

PartialApproval

Indicates if partial approval shall be supported.

Declaration

public bool PartialApproval { get; set; }

Property Value

Type	Description
System.Boolean	true if [partial approval]; otherwise, false.

PartialCommit

Declaration

public bool? PartialCommit { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

PersistentState

Enable persistent state if supported. Default is false

Declaration

public bool PersistentState { get; set; }

Property Value

Type	Description
System.Boolean

PreferOmniChannel

Prefer OmniChannel for these functions

Declaration

public List<TransactionType> PreferOmniChannel { get; set; }

Property Value

Type	Description
List<TransactionType>

ProceedTimeout

Timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned.

Declaration

public int ProceedTimeout { get; set; }

Property Value

Type	Description
System.Int32	The proceed timeout.

ProtocolType

Protocol type.

Declaration

public ProtocolType ProtocolType { get; set; }

Property Value

Type	Description
ProtocolType	Protocol type.

QRCTimeout

Timeout in seconds the terminal displays the loyalty QR code after a "StartCheckout" call before returning to its "Idle" screen. Numeric number that specifies the QRCTimeout in seconds.

Declaration

public int QRCTimeout { get; set; }

Property Value

Type	Description
System.Int32

RequestRepetition

Set number of send request repetitions or 0 to disable. Default is 0. Affects these functions:

• Commit
• Rollback

Declaration

public int RequestRepetition { get; set; }

Property Value

Type	Description
System.Int32

SaferpayBaseUrl

Saferpay: Base URL.

Declaration

public String SaferpayBaseUrl { get; set; }

Property Value

Type	Description
String

SaferpayCredentials

aferpay: Base64 encoded user name + password.

Declaration

public String SaferpayCredentials { get; set; }

Property Value

Type	Description
String

SaferpayCustomerId

Saferpay: Customer ID.

Declaration

public String SaferpayCustomerId { get; set; }

Property Value

Type	Description
String

SaferpayTerminalId

Saferpay: Terminal Id.

Declaration

public String SaferpayTerminalId { get; set; }

Property Value

Type	Description
String

SerialBaudrate

Gets or sets the serial baudrate.

Declaration

public int SerialBaudrate { get; set; }

Property Value

Type	Description
System.Int32	The serial baudrate.

SerialPort

Gets or sets the serial port.

Declaration

public String SerialPort { get; set; }

Property Value

Type	Description
String	The serial port.

SIXmlRequestTimeout

Declaration

public int SIXmlRequestTimeout { get; set; }

Property Value

Type	Description
System.Int32

TerminalId

Terminal ID to be broadcasted in case of ConnectionMode Broadcast.

Declaration

public String TerminalId { get; set; }

Property Value

Type	Description
String	The terminal identifier.

TipAllowed

Tip is allowed for purchase transactions. This parameter is only used if {@link com.six.timapi.constants.Guides#GASTRO} is enabled.

Declaration

public bool TipAllowed { get; set; }

Property Value

Type	Description
System.Boolean	true if [tip allowed]; otherwise, false.

WakeupTimeout

Returns the timeout for terminal wake-up operations.

Wake up is only possible on terminals that support wake-up via ECR interface. The wake-up process is transparent to the user and is triggered by calling a function that needs the terminal.

Default timeout is 20s.

Declaration

public int WakeupTimeout { get; set; }

Property Value

Type	Description
System.Int32

Methods

ToString()

Declaration

public override String ToString()

Returns

Type	Description
String