Skip to content
curl -k '
ERROR 100: Too many attempts have been made to retrieve a poll file from the system. Only one attempt by any API key is allowed every 2 minutes.This one can be ignored.ERROR 200: The API key accepted, but the target business date was not found.ERROR 300: The API key is missing or invalid.Email the client letting them know we need a new API key because the one they gave us is invalid.ERROR 400: The software has not been enabled. Contact SICOM Support to enable the software.Email the client letting them know they need to contact SICOM to enable the manager terminal endpoint.ERROR 500: An invalid mode has been entered into the URL. Only modes 1, 2, and 3 are currently available.
Sicom
Note: In order for the customer to have their SICOM terminals generate XML output, they must first purchase the SICOM Surveillance Interface Software module. They can contact to purchase this software. We cannot proceed until this has been done.
------ [ XML listener ] ------
port:
type:
------ [ employee data ] -----
terminal
API:
Configuring Sicom POS Integration
In order to create a new Sicom POS integration config, we first need to have in hand the necessary information:
- TCP/UDP port for the device to listening the POS information
- For the Poll Retrieval API setup, we will need to know the api key and the terminal ip:port information, for obtaining the polling key,
the customer can configure this from their terminal System → Tools → Pollfile API Edit: (either get an existing one or create/generate a new one)
we will also need the terminal address (usually 192.168.1.80)
The client is also going to need to setup a DCHP lease reservation for our Edge Device in order to ensure that it doesn't get it's IP changed and therefore we stop receiving transactions.
image.png
14.4 kB
Enter the location Id as external id and select sicom from the dropdown as the type
image.png
22.1 kB
Then click create a new sicom config, so we can setup the specific information for sicom integrations
image.png
73.3 kB
Fill out the information:
image.png
23.7 kB
After the edge device is installed at the location we also need the client to make a request to their Sicom folks to add an additional Surveillance POS XML Feed to our edge device's IP address on a high, unused, unblocked port, for example 5015.
Enabling Transaction Data to be Passed to the Edge Device (Enabling XML Output (from Xenial Docs))
In order to have your SICOM terminals generate XML output, you must first purchase the SICOM Surveillance Interface Software module. Contact to purchase this software, if you don't already have it. Once purchased, SICOM Support will configure your SICOM POS system to send XML output to your camera system. In order to receive this output, you must provide a LAN IP address and a TCP port that you wish the output to be streamed to (ex. 192.168.1.201:9001). The LAN IP must be on the 192.168.1.x network, it must be on the same subnet as the SICOM system (255.255.255.0) and the device must be pingable by the SICOM manager’s terminal, whose LAN IP is 192.168.1.80.
This LAN address is the LAN address of the Savi Edge Device. The port is the specified on the Sicom config we send to our edge device. Usually 5015.
Testing the Sicom Configuration
To test the availability of labor data, from the edge device in the Balena UI, pick the Sicom container and run the following command:
This can be ran at the point of install, or any time after, as long as the device is at the location. If this doesn't return a huge response: of somewhat garbage looking text, it may not be working.
It may also return any of the following errors:
You may get the following:
<!--
- COPYRIGHT (C) 2009 SICOM Systems Inc
- 4140 Skyron Drive
- Doylestown, PA 18902
- 215-489-2500, FAX: 215-489-2769
-
- $Id$
-->
<html>
<HEAD>
<TITLE>Call SICOM</TITLE>
<LINK rel="stylesheet" href="mgrng_style.css">
<META HTTP-EQUIV="Refresh" CONTENT="240">
</HEAD>
<body leftmargin=30>
<p>
<H1>Call SICOM Systems 1.800.547.4266</H1>
<p><b>A configuration error has occurred.</b> <u>Status 404 - Not Found</u><br><br>
Please contact SICOM Systems Support to investigate and correct this.
<br><br>
Please be prepared to provide the following information:<br><br><b>
Your Name,<br>
Your Company Name,<br>
Your Restaurant's Telephone Number, City, and State,<br>
And, a brief description of what action was performed prior to this message.<br>
</b>
<br>
Thank you!
</body>
This indicates you need to check the URL of your request.
Other errors that will be common that you'll need to reach out to the client's IT team for include timeout, or host unreachable.
If none of the above then we need to reach out to the client's IT team and inform them that their network is misconfigured, or that their manager terminal doesn't have the interface configured for us.
Unfortunately the only way to see if the terminal is sending transactions is to wait for them.
See attached items for XML and API guides
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ··· in the right corner or using a keyboard shortcut (
CtrlP
) instead.