Scripts

ActivePOS events

ActivePOS events received by the script are represented by objects that have the following fields:

The activate_on_pos_events() function is used to get ActivePOS events

import time
def f(ev):
    message("Unique event number: %s" % ev.op_id)
    message("Event type: %s" % ev.type)
    message("Terminal ID: %s" % ev.pos_terminal)
    message("Terminal name: %s" % ev.pos_terminal_name)
    message("Associated video channel: %s" % ev.associated_channel)
    message("Flags: %s" % ev.flags)
    message("Position number: %s" % ev.position)
    message("Text: %s" % ev.text)
    message("Price per unit: %0.2f" % (ev.price/100.0))
    message("Weight: %0.3f" % (ev.weight/1000.0))
    message("Quantity: %s" % ev.quantity)
    message("Article: %s" % ev.article)
    message("Barcode: %s" % ev.barcode)
    message("Location: %s" % ev.location)
    message("Time of arrival on server: %s" %
        time.strftime("%H:%M:%S %d.%m.%Y",
        time.localtime(ev.ts_received/1000000)))
    message("Time indicated on receipt: %s" %
        time.strftime("%H:%M:%S %d.%m.%Y",
        time.localtime(ev.ts_in_receipt/1000000)))
activate_on_pos_events(f) 

To search for events from POS terminals in the database, use the search_pos_events() function. The function accepts 4 parameters:

As a filter, you need to transmit a dictionary, in which you can use the following keys:

import time
from pos_utils import *

filter = {
    "receipt_number": "1234567",
    "text": [StringFilter("Milk", SearchFlags.STARTS_WITH)],
    "cashiers": ("Ivanov I",)
}
search_pos_events(lambda event: alert(event.text), time.time() - 24 * 60 * 60, time.time(), filter) 

This example will find all events (maximum: 500) in the checks with the number "1234567" created by the cashier "Ivanov I", in the event_text, event_article or event_barcode fields containing the text beginning with the string "Milk" and received in the last 24 hours. The text of each event will be displayed in a separate pop-up window.

A script can find suspicious situations. You can use the pos_fraud() function to attract the operator's attention and record an alarm event on a receipt. You can create a filter to search and highlight based on the presence of such event in a receipt.

import time
def f(ev):
    if time.localtime().tm_hour < 23: return
    if ev.type!="POS_POSITION_ADD": return

    u = ev.text.decode("utf-8").upper().encode("utf-8")
    for w in ["BEER", "WINE", "VODKA", "COGNAC"]:
        if u.find(w) != -1:
            pos_fraud(ev, "Alcohol after 11pm")
            return

activate_on_pos_events(f) 

The upper() function converts the string to upper case (all capital letters). For this conversion to work, the string must be in Unicode (utf-8).

ActivePOS incidents

Incidents generated by ActivePOS detectors and received by the script are represented by objects with the following fields:

The activate_on_pos_incidents() function is used to get messages about new incidents. The function accepts two parameters:

activate_on_pos_incidents("", lambda incident: alert(incident.type_name)) 

The search_pos_incidents() function can be used to search for incidents in the database. The function accepts 4 parameters:

As a filter, you need to transmit a dictionary, in which you can use the following keys:

import time
from pos_utils import IncidentFlag
 
filter = {
    "flags": IncidentFlag.FILTER_CONFIRMED | IncidentFlag.FILTER_NONEMPTY_ESTIMATE,
    "limit": 20,
}
search_pos_incidents(lambda incident: alert(incident.type_name), time.time() - 24 * 60 * 60 * 2, time.time(), filter) 

This example will analyze all the receipts stored in the database for the last 2 days, then find the last 20 confirmed incidents with a non-zero damage estimate among them, and display the name of each type of incident in a pop-up window.

The pos_process_archive() function can be used to start the processing of the event archive by a particular detector. The function has 3 arguments:

import time

pos_process_archive("T1RuoVF7", time.time() - 24 * 60 * 60 * 2, time.time()) 

This example will start processing checks for the last 48 hours by a detector with a GUID equal to "T1RuoVF7".

The pos_incident_create() function can be used to create a new incident from a script. The function uses 4 mandatory arguments:

pos_incident_create("ZyPx6vF0", "Cancel position without the administrator", "Ivanov I", lambda err: alert(err.msg)) 

This example will create an incident with the "Cancel position without the administrator" type, associated with the terminal, the GUID of which is "ZyPx6vF0", and the cashier "Ivanov I".

In order to transfer or restore the detector configurations, you can use the pos_import_detector() function. This function accepts data in xml format containing the detector configuration.

with open("pos_detectors.xml") as detectors_config:
    pos_import_detector(detectors_config.read()) 

This example will delete the current detector configuration and restore it from the pos_detectors.xml file.

ActivePOS reports

The generate_pos_report() function can be used to generate ActivePOS reports. The function has 4 arguments:

import time
from pos_utils import ReportType

def report_ready(res):
    with open("pos_report.ods", "w") as report:
        report.write(res.zipped_report)

generate_pos_report(ReportType.VIOLATIONS_REPORT, str(int((time.time() - 24 * 60 * 60 * 10) * 1e6)), str(int(time.time() * 1e6)), report_ready) 

This example generates a "Violation Report" for the last 10 days and saves it to the file pos_report.ods.