User's Manual

28 | Page
Proprietary and Confidential Revised 10-11-11
Appendix C: SXL1 Data Interface
Scope
This document describes the SXL1 Data Interface (Datastreams) transport methods and data formats
available for machine-to-machine communications from a device to a Value Added Reseller (VAR) or
customer’s back office. All methods and formats described in this document can be configured in the
FELIX Software Administration website. It is assumed the reader is familiar with the terms and
technology described in this document.
Transport Layers
The Datastream functionality implements common Internet transport layers to facilitate ease of
integration with the VAR back office. The following protocols can be utilized for data transport:
HTTP/HTTPS, SMTP (E-Mail), and SFTP. For a description of these protocols please refer to the
table below.
Acronym Description Reference
HTTP/HTTPS
Hypertext Transport
Protocol (Secure) 1.1
http://tools.ietf.org/html/rfc2068
SMTP (E-mail /
SMS)
Simple Mail Transport
Protocol (Electronic Mail)
http://www.ietf.org/rfc/rfc0821.txt
SFTP
Secure File Transport
Protocol
http://www.openssh.org/txt/draft-ietf-
secsh-filexfer-02.txt
Data Formats
Tracker XML Description
trackermessages: The root element of the Tracker XML which contains the individual tracker
messages.
trackermessage: The element for each tracker message that generated the trigger. Normally only
one tracker message will be sent during each transmission.
asset: The element containing the FELIX fields of the Asset. Values for the elements are attained at
the time the message is forwarded.
esn: The Electronic Serial Number of the Tracking Device. The format of this field will be different,
depending on the type of Tracking Device.
name: The FELIX Asset Name. This value is a free text field that may contain spaces and non
alphanumeric characters.
user_data: The FELIX “Custom Fields” as configured by Administrative users and as assigned to
the Asset. The data for the custom field is free text, spaces are allowed.
field name: The field name will represent the Organization defined custom field name as assigned to the
asset. The “data” field will represent the value of the field defined for the Asset.
cause: This element and its children refer to the FELIX datastream trigger that is configured to
forward the tracker message when certain conditions are met.
trigger: The FELIX datastream trigger that was configured to send this message. This will match the
list of triggers found in FELIX.
condition: The condition that was matched that triggered this forwarded message. The options for
this condition are specific to the tracking device sending the message unless the trigger is set for
any message received.
position: The position information, and calculated address information of the position information.
coordinate: The Tracker XML outputs the coordinates in type “dd”, decimal degrees.
latitude: The latitude reported in the forwarded tracker message, and determined by the
hexadecimal field in the payload.