Page tree
Skip to end of metadata
Go to start of metadata

Action

In the context of gateway triggers, an action is distinct work item that executes as part of a trigger. Examples include:

  • Setting the data value in a device variable
  • Publishing a property for a thing
  • Inserting a row into a database table.
  • For more information, see: Projects and triggers

Each action may have inputs and outputs. Each action indicates the next action to execute, including ending the trigger execution based on the action's success, failure or other completion criteria.

In the context of cloud triggers defined in the M2M Service, an action is distinct work item that executes as part of a cloud trigger. Examples include:

  • Publishing a property for a thing
  • Executing a method for a thing
  • For more information, see: Triggers

Gateway triggers and their actions have different concepts and features from cloud triggers and their actions.



Alert

An alert is an indication at the gateway level of an important condition. A table of active alerts is valuable for quickly accessing the state of the gateway. These alerts can either be generated automatically by the system (for example, "the disk is full") or by the user through triggers (for example, "my application isn't working"). For more information, see Alert Management.

 


Alarm

An alarm is used to define an interesting event for a thing. Alarms are implemented as a state machine, where the events are defined as alarm states. For example, with a vehicle, you could define an alarm for Motion with alarm states of Forward, Reverse, or Stopped. For more information, see Defining alarms.

 


Application

In the context of gateways, an application is your triggers, transports, transport maps, devices, etc. that implement the solution for your business requirements. In this context, an application may mean the items and logic on one gateway, or an application may mean the items and logic on all of your gateways.

In the context of the M2M Service, an application is an item that is used to assign roles, license information and access control rights. The application is assigned an application token that is then referenced by a gateway or by an external application when connecting to the M2M Service. For more information, see Applications.

In the context of your overall solution, an application may be a reference to the enterprise applications that are interfaced with, such as database servers, messaging systems, and other "business applications". For more information, see Enterprise connectivity.

 


Application Token

A unique application token is assigned to each application defined in the M2M Service. The application token is then referenced by a gateway or by an external application when connecting to the M2M Service. The application token is used to reference the specific M2M Service defined application and the application's rights or characteristics. For more information, see Applications.

 


Asset Gateway

Also deviceWISE Asset Gateway. The deviceWISE software that can be installed on a wide variety of hardware and operating system options, including embedded computers, virtual machines or traditional desktops. At its core, the Asset Gateway is software that communicates with your company's assets, processes data and sends the processed data to the M2M Service or to enterprise applications via an Enterprise Gateway.

 


Asset Gateway: Web Interface

The Asset Gateway: Web Interface is the tool that allows the person who installs the Asset Gateway to configure the network settings, cellular settings and the connections to the downstream assets. For more information, see Asset Gateway Web Interface User's Guide.

 


Attributes

Attributes are key-value pairs that are used to define characteristics of a thing. For example, the attributes of a car could be Manufacturer, Model, or VIN. For more information, see Defining attributes.

 


Campaign

A campaign is an action or a task that will be run against a group of things. Campaigns are defined in the M2M Service and can be managed using the Management Portal. For more information, see Campaigns.

 


Cloud trigger

In the M2M Service, an individual portion of the overall application logic that is created to solve a need. Each cloud trigger has an event type that identifies when the cloud trigger is executed and one or more actions that contain the application logic. For information, see Triggers.

 


Connection

A connection is a cellular device. Each connection has its appropriate characteristics, including the carrier, rate plan, deployment status, data usage, SMS usage, location, roaming status, various identifiers (ICCID, IMEI, ESN, etc.), and other items that enables the cellular device to connect to the network. For more information, see Connections.

 


Device

In deviceWISE, a representation of a group of variables and possible communication interface information. This representation can be for:

  • A physical device, such as a programmable logic controller (PLC) or a sensor.
  • A logical device that only resides within deviceWISE, such as a Global Variables device.

When representing a physical device, the communication interface information could include properties such as the IP address, the TCP port, the communication timeout and the size and type of the variables within the device. For more information, see Device connectivity.

 


deviceWISE IoT Platform

The family of products including Asset Gateways, Enterprise Gateways, the M2M Service and the Workbench that allows you to easily create and maintain a solution for your company's business needs.

 


deviceWISE node

Also referred to as node. A general term used when referring to any type of deviceWISE run-time product installed on a computer. This ranges from embedded computers to high end server computers.

deviceWISE node is synonymous with deviceWISE gateway.

 


Enterprise applications

The business applications such as database servers, application servers, messaging applications and enterprise resource planning applications that provide the basis for a company's back office knowledge and value. These enterprise applications can be integrated with a company's devices and assets by using the deviceWISE IoT Platform products. For more information, see: Enterprise connectivity.

 


Enterprise Gateway

Also deviceWISE Enterprise Gateway. The deviceWISE software that can be installed on a wide variety of hardware and operating system options, typically on higher end server machines. An Enterprise Gateway has all of the features and components that an Asset Gateway has, and in addition has the ability to interact with enterprise applications such as database servers, application servers, messaging applications and enterprise resource planning applications. An Enterprise Gateway is enterprise-grade software that can be installed in your back-office to easily map data from your Asset Gateways to your enterprise applications.

 


Event

For a trigger, the event identifies when the trigger will execute. Some example trigger event types are: on a periodic schedule, on a variable data value change, on a PLC logic event (a PLC command or unsolicited message) and on demand from a user.

Gateway triggers and their events have different concepts and features from cloud triggers and their events.

For more information on gateway triggers, see Projects and triggers

For more information on cloud triggers, see Triggers



Gateway

Also deviceWISE gateway. A general term used when referring to both an Asset Gateway and an Enterprise Gateway.

deviceWISE gateway is synonymous with deviceWISE node.

 


Geofence

A geofence is a circular or polygonal area that has special meaning for location aware and mobile things. Geofences can be used in conjunction with triggers and notification groups to allow users to be informed when a thing enters or leaves a geofence. For more information, see Geofences.

 


License key

An authorization key that allows features of a deviceWISE gateway to be activated. Some features of a gateway are available without the need to install a license key. Some licenses keys are installed in a gateway when it connects to the M2M Service. And some license keys must be installed in a gateway using the Workbench. License keys can be imported from a file or entered one at a time via the keyboard.

For more information, see

Licenses

Gateway Licenses

Applications

 


Listener

In deviceWISE, a listener represents a connection to an enterprise application where the data originates in the enterprise application and is destined for your deviceWISE application logic defined in a trigger. Listeners may have an optional reply message sent from the trigger back to the enterprise application. For more information, see: Enterprise connectivity.



Lua

Lua is a scripting language that is supported by deviceWISE as a means to perform custom functions in gateway triggers that would not be possible with the standard provided deviceWISE gateway trigger actions. For more information, see Extending the system using Lua scripting.

 


M2M Service

Also deviceWISE M2M Service. The hosted service that handles all security, messaging, device management and administration for your M2M application solution. You configure and monitor the M2M Service using the web-based Management Portal. For more information, see Management Portal User's and Administrator's Guide.

 


M2M Service API

The set of HTTP and MQTT based APIs that are used to interact with the M2M Service. These APIs enable new devices to connect to the M2M Service, or mobile and desktop applications to interact with the rich data available within the M2M Service. For more information, see M2M Service API Reference Guide.

 


Management Portal

The web-based program that is part of the M2M Service. Using the Management Portal, you can view and manage your gateways and things that are connected to the M2M Service. In addition, the Management Portal lets you manage users, configure tunnels, update deviceWISE firmware and many of the other batch type processing you might want to perform on your field of gateways. For more information, see: Management Portal User's and Administrator's Guide.

 


Method

A method defines the interface to a function that is implemented in a gateway trigger (using TR50 Method trigger event type) or is implemented in an application. The "calling" of a thing's method can be from a gateway trigger, from an application, from the thing's page in the Management Portal, or from a cloud trigger within the M2M Service. For more information, see Defining methods.

 


Notification group

A notification group is a group of users who are notified via email or SMS when an event occurs. Notification groups are conceptually analogous to mailing lists. For more information, see Notification groups.

 


Organization

An organization is the top level container that other items (such as applications, roles, thing definitions and things) belong to. Sub-organizations can be created to further partition the items in your M2M solution. For more information, see Managing organizations.

 


Package

A software component that provides a specific portion of deviceWISE capability. A device driver can be implemented as a package. For more information, see: Packages.

 


Property

A property is a numeric value representing a value at a specified timestamp. Typically this would be a sensor reading such as voltage, humidity, speed, etc. Properties have a history and can be aggregated over time periods for use in graphs or tables. For more information, see Defining Properties.

 


Role

A role identifies the access control rights (view, modify, execute, etc.) to items within the M2M Service. For more information, see Managing roles and permissions.



Software update package

A deviceWISE feature that includes the ability to create, upload to the Management Portal, view and deploy to gateways a "bundle" of files and actions.
The content of the package might include third party library updates, deviceWISE software updates, and other software updates such as drivers included with the hardware. The actions available include file/directory handling and the start or stop of deviceWISE on the gateway. For more information, see Creating a software update package.

 


Security tag

A security tag is a user defined label that can be associated with a thing. Security tags are used to restrict access to a thing and the thing's methods and tunnels.

Update security tag

An update security tag is a user defined label that can be associated with a thing's characteristics. Update security tags are used to restrict edit and update access to a thing's: alarms, attributes or properties.

View security tag

A view security tag is a user defined label that can be associated with a thing's characteristics. View security tags are used to restrict view access to a thing's: alarms, attributes or properties.

 


Tag

A tag is a label that can be associated with an item, such as a thing, a file, or a user. Tags can then be used to filter the items that are displayed within the Management Portal pages. Tags can be system defined or user defined.

 


Thing

A thing is a logical item that is used to represent a portion of your M2M solution in your business environment.

Things are instances of a previously defined thing definition. Things inherit their characteristics from their thing definition.

A thing is a logical item in the sense that it is defined with the characteristics that are important to your M2M solution and your application logic. It may not have all of the characteristics of an actual physical item.

  • Each gateway connected to the M2M Service is an example of a thing.
  • An application connected to the M2M Service, using the M2M Service API, is another example of a thing.
  • Other important portions of your M2M solution can be defined to be a thing when it is desirable to have a common set of characteristics (through a thing definition) for that portion of your M2M solution.

 



Thing definition

A thing definition models the attributes, alarms, properties, methods, tunnels and other characteristics of a particular type of item that is a portion of your M2M solution.

Things are instances of a previously defined thing definition. Things inherit their characteristics from their thing definition. For more information, see: Thing definitions.

 


Thing key

A thing key is the unique identifier of a specific thing.

 


Transport

In deviceWISE, a transport represents a connection to an enterprise application, such as a data base server, where the data or requests originate in your deviceWISE application logic. Transport features include connection management and store and forward of the outbound data. For more information, see: Enterprise connectivity

 


Trigger

In the context of gateway, an individual portion of the overall application logic that is created to solve a need. Each trigger has an event type that identifies when the trigger is executed and one or more actions that contain the application logic. For more information, see: Projects and triggers.

In the context of the M2M Service, a cloud trigger is an individual portion of the overall application logic that is created to solve a need. Each cloud trigger has an event type that identifies when the cloud trigger is executed and one or more actions that contain the application logic. For more information, see: Triggers.

Gateway triggers and their actions have different concepts and features from cloud triggers and their actions.

 


Tunnel

A communication mechanism that allows one network communication protocol to be encapsulated and sent over a different network communication protocol. The M2M Service includes a Tunnel Manager feature that supports creating and using tunnels to a gateway. These tunnels can be used to remotely access a gateway with a variety of client applications, including the Workbench. For more information, see: Defining tunnels.

 


Update security tag

See security tag.

 


Variable

An individual data item. In some systems, variables may also be referred to as registers or tags. In deviceWISE, each variable is associated with (or belongs to) a specific item. Examples include:

  • Variables associated with a device are device variables
  • Variables associated with a trigger are local variables, static variables, event variables, macros and constants.

For more information, see: Device connectivity.

 


View security tag

See security tag.

 


Workbench

The Workbench is the main tool used to configure a deviceWISE gateway. The Workbench provides full development capabilities along with the ability to administer and debug an individual gateway in the field.

With the use of the tunneling feature provided by the M2M Service, the Workbench can remotely access a gateway connected to the M2M Service.

For more information, see: The Workbench.

 



deviceWISE Application Enablement Platform release 13.3.0 and prior terms


Asset

A logical item that is used to represent a physical item in your business environment.

It is logical in the sense that it is defined with the properties that are important to your M2M solution and your application logic. It may not have all of the properties of the actual physical item. Assets can be used by your application logic to help define and manage the wide variety of physical items that are accessed by the gateways that are part of your M2M solution.

 


The feature that handles communication between a gateway and the 13.3.0 (and prior) releases of the M2M Service.

In the 14.1.0 and follow on releases of the M2M Service, the TR50 feature provides the communications between a gateway and the M2M Service.

 


CloudLINK Alias

The M2M Service provides a CloudLINK Alias feature that allows multiple gateways to service requests destined to a single ID, the CloudLINK Alias ID. This CloudLINK Alias ID is in addition to each gateway's CloudLINK ID.
The CloudLINK Alias feature facilitates redundancy of portions of your application logic. This redundancy of your application can be used to provide load balancing and availability capabilities.

 


CloudLINK ID

For each gateway, the unique identifier for the connection to the M2M Service. The CloudLINK ID is assigned for a gateway by the M2M Service and can be changed using the Management Portal. A gateway's CloudLINK ID is not the same property as the gateway's node name.

 


CloudSMS

The M2M Service provides a Cloud short message service (SMS) feature, referred to as CloudSMS, to send SMS messages to a phone number.
The CloudSMS feature allows gateways to use SMS messages as part of their application logic without the gateway having direct support of a cellular modem.


  • No labels