Device

Add, edit, enable, disable, and delete transaction devices in the Device tab. Set the connection type of the transactions device, define filter conditions for the transaction information, pair the camera, and choose the style of On-Screen Display.

Add device

To add a transaction device:

  1. Click add. An Add Transaction Device Wizard window will appear.
  2. Enter a name to identify this device in the Name field.
  3. Select a transaction source from the Transactions source drop-down menu:
  4. Select one of the following connection types from the Connection type drop-down menu:
  5. Click Next to continue with the setting of data definition. If you select Surveillance Station WebAPI as the connection type, you will be directed to the display settings.
  6. Select the correct encoding method, check that Start Collecting Raw Data is enabled and enter the data on the device side. The received data is displayed in the Raw data field.
  7. Please set the rules for the start and end of the transaction.
  8. You can add a filter rule by clicking on the button at the top right corner. You can ignore characters, or replace characters with line break or with other characters.
  9. The results of filtered data will be displayed directly in the filtered data field. And the corresponding data will be marked in the original data.
  10. Click Next to continue with display settings.
  11. Select whether or not you want to set up a paired camera for this device from Paired Camera.
  12. In On-Screen Display, transaction data can be set to be displayed in live view and video clips.
  13. Click Finish to complete the setting.

Limitations:

Edit device

To edit a transaction device:

  1. Select the device you want to modify, then click Edit. You can also double-click on the device to change the settings.
  2. Set up User Defined events in the Event page. This can be used in Action Rule, Live View alerts, and Notification.
  3. Texts corresponding to Start of transaction, End of transaction, or Canceled transaction can be set to be omitted in the Advanced page, omitted text will not be stored in historical records, and will not be displayed on the on-screen display.
  4. Specify a duration for clearing the on-screen text overlay in the Advanced page. Set the duration (in seconds) for the texts to remain on the on-screen display when there are no new messages generated. You can also choose to clear texts from the on-screen display upon receiving specific texts or upon the start of a new transaction.
  5. Click Finish to save changes.

Enable or disable the device

The new device must be enabled before managing all supported actions.

To enable or disable a device:

  1. Select the device you want to enable or disable, And Enable or Disable from the Enable drop-down menu.

Note:

Delete device

  1. Select the device you want to delete, then click Delete.
  2. You will see a confirmation window. Once you have chosen to keep the transactions of the device, click Yes to continue.

Note:

Surveillance Station Web API

Surveillance Station Web API provides you with a more convenient way to connect your device, send Web API requests in a format that conforms to the specification, and record your transaction data.

Standard format to send Web API requests:

  1. API: SYNO.SurveillanceStation.Transactions provides the following five types of methods (Insert,Begin, Complete, Cancel, and AppendData) to record transaction information:
  2. Insert:

    Notifies Surveillance Station to start recording a transaction. Includes the following parameters:

    Begin:

    Notifies Surveillance Station to start recording a transaction. Includes the following parameters:

    Complete:

    Notifies Surveillance Station to end the transaction and that the transaction is completed. Includes the following parameters:

    Cancel:

    Notifies Surveillance Station to end a transaction and that the transaction is canceled. Includes the following parameters:

    AppendData:

    Notifies Surveillance Station to record the contents of a transaction. Includes the following parameters:

  3. Basic request format: http://{IP}:{Port}/webapi/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transaction&method="{method}"&version=2&deviceName="{device name}"&sessionId="{session id}"

Examples of Web API requests:

  1. Starting the transaction:

    http://{IP}:{Port}/webapi/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transaction&method="Begin"&version=2&deviceName="POS01"&sessionId="1"&timeout=300

  2. Recording the transaction:

    http://{IP}:{Port}/webapi/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transaction&method="AppendData"&version=2&deviceName="POS01"&sessionId="1"&content="Start\n2017/01/01"

  3. Recording the transaction:

    http://{IP}:{Port}/webapi/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transaction&method="AppendData"&version=2&deviceName="POS01"&sessionId="1"&content="Pen $40\nBook $300"

  4. Recording the transaction:

    http://{IP}:{Port}/webapi/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transaction&method="AppendData"&version=2&deviceName="POS01"&sessionId="1"&content="Total $340\nEnd"

  5. Ending the transaction:

    http://{IP}:{Port}/webapi/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transaction&method="Complete"&version=2&deviceName="POS01"&sessionId="1"

Note:

AXIS Barcode

To configure a transaction device with AXIS Barcode as the source:

  1. Add a transaction device with AXIS Barcode as its source.
  2. Install AXIS Barcode Reader and AXIS Barcode to Synology Surveillance Station on an ACAP compatible camera.
  3. Open ACAP settings of the camera. Adjust the AXIS Barcode Reader settings to set the type of barcode you want to scan.
  4. Find the settings page for AXIS Barcode to Synology Surveillance Station which is also located in the ACAP settings page. Configure the address, user account, password of your Synology NAS, and the name of the transaction device.