Skip to main content

PayComplete™™ Help Center

Connect and third-party devices using XFS

You use the XFS protocol and drivers to connect third-party devices to TransportConnect when you want monitor the devices from TransportConnect.

Tip

  • You can connect PayComplete™ devices to TransportConnect using the XFS protocol.

  • You can run third-party software on PayComplete™ devices as long as the software supports the XFS protocol.

Connected third-party devices can report, for example, changes in hardware status, changes to box contents, and warnings/errors to TransportConnect as long as the device supports the XFS protocol. The XFS protocol controls which data the XFS drivers can collect and forward. Based on the information sent to TransportConnect, you can share error codes and log files with service technicians, use information on box contents to make more accurate cash plans, and simplify the distribution of update files. With a PayComplete™ XFS driver, you can also view transactions.

Prerequisites and requirements:

  • A third-party device that supports the XFS protocol

  • XFS drivers for the specific device.

  • An XFS manager

  • Hardware configuration for the XFS drivers. For more information on how to configure the hardware, see the XFS documentation for the specific hardware.

  • Configuration to establish communication between the device and TransportConnect.

    You use OrchardMonitorConfig for the configuration. You need to enter the following information:

    • Unique machine ID

    • IP address

    • Port number

    • Broker user name

    • Broker password

    • Tenant name

    Tip

    You obtain the IP address, port number, broker user name, broker password, and the tenant name from PayComplete™.

Note

If you choose to install OrchardXFS, the XFS manager and XFS drivers are included.

The XFS adapter (OrchardMonitor)

OrchardMonitor establishes a connection between TransportConnect and the third-party device. OrchardMonitor then collects device data from the XFS drivers and forwards the data to TransportConnect.