Axeda.Asset Thing Shape
The Axeda.Asset Thing Shape defines a set of properties and services that are used in the following Axeda Thing Templates:
Properties
The Axeda.Asset Thing Shape includes the following properties described in the table below. Note that the properties apply if your Axeda Agent supports the related feature.
|
Property Name
|
Base Type
|
Grant Permissions to Non-Admin Users?
|
Description
|
|---|---|---|---|
|
acceptableMissedPings
|
INTEGER
|
Yes
|
This property specifies the number of times that an eMessage agent can miss a ping before its reporting status is evaluated, along with the additionalMissedTimeAllowed. The default number of missed pings is 3. The additionalMissedTimeAllowed is set in the AxedaPollingStrategy Thing.
|
|
address
|
STRING
|
Not recommended.
|
The address of the location associated with an asset. On Axeda Platform, this is the equivalent of "Location".
|
|
agentVersion
|
STRING
|
The version of the agent software used on the asset when it was deployed.
|
|
|
alarms
|
INFOTABLE
|
The last alarm that was sent by the asset. The alarms fields are defined by the Axeda.Alarm Data Shape. The eMessage Connector supplies the value for this property. Note that alarms should not be added manually.
|
|
|
assetLogEvents
|
INFOTABLE
|
The last log event that was sent by the asset. The assetLogEvents fields are defined by the AxedaLogEvent Data Shape. The eMessage Connector supplies the value for this property. Users cannot edit this property.
|
|
|
assetName
|
STRING
|
The name of the asset.
|
|
|
buildVersion
|
STRING
|
The build version of the agent. .
|
|
|
condition
|
STRING
|
The status of the agent.
|
|
|
firstRegistrationDate
|
DATETIME
|
The date that the asset first registered. The eMessage Connector updates this property when a device registers with it.
|
|
|
language
|
STRING
|
The language used for the asset.
|
|
|
latestRegistrationDate
|
DATETIME
|
The date that the asset last registered with the ThingWorx Platform. The value of this property is written by the eMessage Connector. This field is used to calculate Thing presence.
|
|
|
offline
|
BOOLEAN
|
Indicates whether the asset is offline or not.
|
|
|
pingRate
|
LONG
|
The frequency with which the asset contacts the ThingWorx Platform.
|
|
|
priority
|
LONG
|
The priority level for the asset.
|
|
|
registeredScripts
|
INFOTABLE
|
The list of scripts that are registered to the asset.
|
|
|
serialNumber
|
STRING
|
The serial number of the asset.
|
|
|
sharedKey
|
STRING
|
The key used by the asset to authenticate with the ThingWorx Platform.
|
|
|
timezoneName
|
STRING
|
The time zone that the agent reports on registration. This value can be overwritten (as an IANA time zone name, for example, America/New_York) and sent to the agent with the AgentTimeSync service.
|
|
|
token
|
PASSWORD
|
The token used by the asset for authentication. The
isPersistent
aspect of this property is set to true.
|
|
|
tokenInvalid
|
BOOLEAN
|
Indicates whether the token used by the asset is invalid.
|
 |
The Axeda.Asset Thing Shape also has a subscription to the DataChange event for the token property. This subscription fires the ClearCacheEntry event that is configured on the Connection Services Hub. The AuthenticatorService clears the SecurityClaimsStash.
|
Services
The Axeda.Asset Thing Shape provides the services described in the table below. Note that the services apply if your Axeda Agent supports the related feature. For example Axeda Gateway and Connector agents can run scripts.
|
Service Name
|
Description
|
|---|---|
|
AgentTimeSync
|
Sends a Time Sync message to the Axeda Agent. This service uses the currently set timezoneName property to override the default OS timezone offset. NOTE: This service does not change the OS timezone and time settings, only how the agent reports its timezone time values."
|
|
RegisterScript
|
This service takes two parameters, name and file. These two STRING parameters specify the name of the script to register and its file name.
|
|
UnregisterScript
|
This service takes one parameter, name, to specify the script to unregister.
|
|
RunScript
|
This service takes one parameter, name, to specify the script to run.
|
|
UpdateRegisteredScripts
|
Updates the registeredScripts property. This service takes two parameters, registerScripts (an INFOTABLE with values from the Axeda.ScriptName Data Shape) and unregisterScripts (also an INFOTABLE with fields from the Axeda.ScriptName Data Shape.
As a result of running this service, values in the registerScripts input parameters will be added to the registeredScripts list. In addition, values in the unregisterScripts input parameter will be removed from the registeredScripts list.
|