Micros 3700 Configuration Guide
Summary
This document describes the various configuration parameters for the Sparkfly integration to the Micros 3700 POS system. There is one main configuration file:
| File | System | Location | Purpose |
|---|---|---|---|
| gateway.ini | BOH | [Install Path]\gateway.ini |
Contains configuration for the Sparkfly Micros Gateway. This is the main configuration file for our Micros 3700 integration. |
The INI file contains multiple sections. Each section and its associated configuration keys are listed below.s
[logging]
The logging section primarily deals with the log files produced by the Sparkfly Micros Gateway.
| Key | Type | Description |
|---|---|---|
| maxLogLevel | enum | the maximum log verbosity. Default is 'info'. Levels are (in increasing verbosity): error, warn, info, debug |
| logRetentionDays | number | the number of days to retain logs for. Default is 10 days. |
[microsGateway]
The microsGateway section deals with settings that affect basic behavior of the Sparkfly Micros Gateway.
| Key | Type | Description |
|---|---|---|
| listenPort | number | This is the port the gateway will listen on. Default is 15009. The SIM interface configuration must match this. |
| siteId | string | The site ID for this location. Unique by store. This key or siteIdPrefix must be specified. |
| credentialItemId | number | The record number of the 0$ item used to place the Sparkfly item on the check. |
| credentialItemType | string | The record type of the 0$ item used to place the Sparkfly item on the check. This defaults to MI and should not be changed without consulting Sparkfly. |
| apiUsername | string | Sparkfly platform API user provided by Sparkfly. |
| apiPassword | string | Sparkfly platform API password provided by Sparkfly. |
| apiEndpoint | string | Sparkfly platform API endpoint to use when making requests. For staging: https://posapi-staging.sparkfly.com For production: https://posapi.sparkfly.com |
| apiTimeout | number | Timeout to use when making requests to the Sparkfly cloud platform. The value is specified in milliseconds and defaults to 10000 (10 seconds) |
| offlineQueueEnabled | boolean | If set to true, the gateway will store failed finalizes in an offline retry queue, and attempt to retry sending them. Set to false by default. Consult with Sparkfly before enabling — this feature results in loss of identifier validation in some cases and is only suited for loyalty accrual functions. |
| offlineMessage | string | If offlineQueueEnabled is true, this value is the message that will be presented to the POS operator when a transaction fails and drops to offline behavior. |
| finalizeAllTransactions | boolean | Whether every transaction sent through the POS is sent to Sparkfly. This is set to false by default, and will only work correctly if the appropriate licensing is in place for Sparkfly Transactional Services. |