Glossary

agent a device’s component firmware that communicates with jetstream application an application created within jetstream, representing a logical boundary containing devices and users security is setup and configured at the application level for users the users within an application can only communicate and interact with the devices within that application this should not be confused with your in house developed application that consumes jetstream messages command a request or query assigned to a terso rfid device a command is executed on a device a command will be one of three types, described below, and will behave differently depending on whether the device is online or offline command type device is online device is offline synchronous, queueable immediate execution queued execution synchronous, not queueable immediate execution failure to execute not synchronous, queueable immediate execution queued execution command id a 36 character guid tying the following pieces of a command request together command response, commandqueuedevent, and commandcompletionevent each of these components will have the same value in their "commandid" property depending on which command type is being handled in a command request, these three parts will be created at different times and may end up buried with many other responses and events using their common "commandid" property enables you to gather all three pieces to determine if execution of a command on a device was successful or not command response a reply received within the response body from a command request being executed depending on the command type that was executed, described below, results are returned in the response body or not command type results returned in the response body? synchronous yes – see the output parameter list or exception list not synchronous no – see the output parameter list or exception list of the related commandcompletionevent docid\ t 7slqwzzeabu593fnbwt event configuration a setup, change, or request performed on a jetstream application configuration actions are performed for the maintenance and management of jetstream resources (e g , devices, device definitions, policies, events) device a terso rfid device our intelligent devices come in the form factors of enclosures, mobile cases, kiosks, and hand helds websockets capable devices are able to process eligible commands right away, providing near real time interaction currently, devices that are websockets capable include enclosures with firmware v4+ and mobile cases devices that are not websockets capable will poll for and execute queueable commands at a set time interval at the moment, devices that aren’t websockets capable include enclosures with firmware v3 and kiosks device definition a unique collection of settings establishing the identity of a specific terso rfid device the settings are a combination of identifiers (e g , name, firmware version, configuration parameters) for the device and capabilities (e g , restart, update firmware, scan for rfid tags) the device supports device specific command a command applicable to a specific terso rfid device this command is supported by some, but not all, terso rfid devices for example, the unlock a device's door docid\ qdtewzyti 4vmdsnli9qm command applies to enclosures with firmware version 4, but not to enclosures with firmware version 3, mobile cases, nor kiosks see device types docid\ wuwgpfex3jryi7wkewcll for the device specific commands supported by each device type event a message capturing information pertaining to the single occurrence of a process an event pertains to a device process or a jetstream process the table below summarizes the available event types and the process they relate to event type device process jetstream process aggregateevent x objectevent x commandqueuedevent x commandcompletionevent x x logicaldeviceaddedevent x logicaldeviceremovedevent x heartbeatevent x logentryevent x sensorreadingevent x events provide a window into all that is occurring in your jetstream application below is some, but not all of the questions events can answer what rfid tags were added/removed from a device during the last door open/close? what rfid tags are currently in a device? what commands have been queued for a device to process? what commands have been completed on/processed by a device? what devices have been added to a jetstream application? what devices have been removed from a jetstream application? what devices have/don’t have internet connectivity? what devices have a low battery? what are the temperature readings of a device? exception list a listing of exceptions while executing a command on a device or any issues in queuing/dequeuing the command immediate results results associated with the execution of a command on a device these results are returned to the calling system immediately in these circumstances, the calling system will receive a command response as well as a commandcompletionevent offline a connection status of a device indicating that it is not connected to jetstream either the device is not websockets enabled/capable or has lost power/internet connectivity online a connection status of a device indicating that it is connected to jetstream the device is websockets enabled and/or has power and internet connectivity output parameter list a listing of key value/parameter value settings resulting from the execution of a command on a device policy a unique collection of settings to manage a device’s configuration values (the configuration parameters are defined by the device’s definition) a policy may be added to a device to apply its configuration settings conversely, a policy may be removed from a device to revoke its configuration settings published results results associated with the execution of a command on a device these results are published to get events for retrieval in these circumstances, the calling system will receive a command response but the results will only be made available in commandcompletionevent which, along with commandqueuedevent, can be retrieved via get events region a geographic region where a device is being placed this is used to create the most reliable and lowest latency connection to the device possible locations include the following us (united states) eu (europe) ap (asia pacific) usgov (united states to meet u s government compliance requirements) standard command a typical command that can be, but doesn’t have to be, supported by any terso rfid device this is a stock command that is well defined with variables required to support the command see device types docid\ wuwgpfex3jryi7wkewcll for the standard commands supported by each device type unique an indicator that the value of a property is distinct and there cannot be another instance of the property with the same value user a person using the jetstream api during user account sign up, a user is provided a unique access key and is associated to a jetstream application multiple users may be associated to one jetstream application a user must use their access key to make jetstream api requests and these requests pertain to the user’s jetstream application