Eigenschaften programmgesteuert zu Dingen hinzufügen
Der Dienst AddPropertyDefinition kann verwendet werden, um eine neue lokale oder remote-gebundene Eigenschaft für ein Ding, eine Dingvorlage oder eine Dingform zu erstellen. Der Dienst verfügt über die folgenden Parameter:
|
Parameter
|
Basistyp
|
Beschreibung
|
|---|---|---|
|
name
|
STRING
|
Erforderlich. Der Name der zu erstellenden Eigenschaft.
|
|
Typ
|
BASETYPENAME
|
Erforderlich. Der ThingWorx Basistyp der Eigenschaft. Eine Liste der ThingWorx Basistypen finden Sie in der Tabelle "Basistypen" in Dingeigenschaften.
|
|
description
|
STRING
|
Beschreibung der Eigenschaft.
|
|
category
|
STRING
|
Kategorienname zum Klassifizieren der Eigenschaft.
|
|
dataShape
|
DATASHAPENAME
|
Wenn der Basistyp der Eigenschaft INFOTABLE lautet, definiert er den von der Eigenschaft verwendeten Data Shape.
• Die Data Shape-Entität, die für diesen Parameter angegeben wird, muss vorhanden sein, bevor der Dienst ausgeführt wird.
• Dieser Parameter ist nicht erforderlich. Die INFOTABLE kann jedoch nicht über Composer festgelegt werden (mit der Schaltfläche "Festlegen"), ohne dass ein Data Shape angegeben ist.
|
|
defaultValue
|
STRING
|
Gibt den Standardwert für diese Eigenschaft an.
|
|
readOnly
|
BOOLEAN
|
"true", wenn die Eigenschaft schreibgeschützt ist, andernfalls "false".
|
|
persistent
|
BOOLEAN
|
"true", wenn Werte auch nach einem Neustart des ThingWorx Diensts persistent sind. (Werte werden im Persistenzanbieter gespeichert.) "false", wenn der Wert beim Neustart des ThingWorx Diensts gelöscht wird.
|
|
logged
|
BOOLEAN
|
Bei Festlegung auf "true" wird die Eigenschaft in einem konfigurierten Wert-Stream gespeichert.
|
|
dataChangeType
|
STRING
|
Definiert, was eine Änderung des Werts der Eigenschaft für Protokollierungs-/Warnungszwecke darstellt. Folgende Werte sind möglich: Immer, Nie, Ein, Aus oder Wert.
• Immer – Für jede Änderung eines Eigenschaftswerts wird ein Änderungsereignis ausgelöst.
• Nie – Bei Änderung eines Eigenschaftswerts wird niemals ein Änderungsereignis ausgelöst.
• Ein – Für die meisten Werte löst jede Änderung der Eigenschaft ein Datenänderungsereignis aus.
• Aus – Ein Datenänderungsereignis wird ausgelöst, wenn der neue Wert in den booleschen Wert "false" ausgewertet wird.
• Wert – Für numerische Typen (NUMBER, INTEGER, LONG usw.) wird ein Änderungsereignis ausgelöst, wenn der Unterschied zwischen dem alten und dem neuen Eigenschaftswert den Schwellenwert überschreitet, der im dataChangeThreshold-Parameter angegeben ist.
|
|
dataChangeThreshold
|
NUMBER
|
Mindestzahl, um die sich die numerische Eigenschaft ändern muss, bevor ein Datenänderungsereignis ausgelöst wird.
|
|
accessModifier
|
JSON
|
Definiert die Zugänglichkeit oder den Umfang für das Ding.
|
Remote-Eigenschaften
Für remote-gebundene Eigenschaften sind zusätzliche Parameter vorhanden. Sie werden als ein Array von remoteBindingAspects angegeben.
 |
Diese Eigenschaften müssen nicht angegeben werden, es sei denn, die definierte Eigenschaft wird an eine Remote-Eigenschaft gebunden.
|
|
Parameter
|
Basistyp
|
Beschreibung
|
||
|---|---|---|---|---|
|
remote
|
BOOLEAN
|
"True", wenn die Eigenschaft an eine Remote-Eigenschaft gebunden ist, andernfalls "false". (Standardeinstellung: false)
|
||
|
remotePropertyName
|
STRING
|
Der Name der Eigenschaft im Remote-Ding, an die gebunden werden soll.
|
||
|
cacheMethod
|
STRING
|
Eine Methode zum Lesen gebundener Edge-Eigenschaftswerte:
• Read from server cache verhindert Server-Anforderungen an Edge für den Wert der Eigenschaft. Der Wert wird immer aus dem Server-Cache abgerufen. Alle Aktualisierungen des zwischengespeicherten Werts hängen vom dataChangeType und der Scanrate der Eigenschaft ab. Ohne die Edge-Eigenschafteneinstellungen für die Eigenschaft ist es möglich, dass der Server nie den Edge-Wert hat und nur den auf dem Server gespeicherten Standardwert zurückgibt. Wenn der dataChangeType der Eigenschaft ALWAYS oder VALUE ist, wird die cacheMethod standardmäßig auf diese Einstellung festgelegt.
• Fetch from remote every read ruft den Edge-Wert für jede Anforderung ab. Es ist kein Zwischenspeichern an dieser Option beteiligt. Wenn der dataChangeType der Eigenschaft NEVER ist, wird der Cache-Typ standardmäßig auf diese Einstellung festgelegt.
• Cached for specific time ermöglicht es Ihnen, zu steuern, wie oft Edge-Anforderungen erfolgen. Nach der ersten Anforderung greift der Server auf die Eigenschaft auf dem Edge-Gerät in Bezug auf den Wert zu. Eine weitere Edge-Anforderung erfolgt erst dann, wenn das definierte cacheInterval abläuft. Beachten Sie, dass das Edge-Gerät den Wert auf dem Server (per Push) in diesem Zeitraum evtl. aktualisiert.
|
||
|
cacheInterval
|
NUMBER
|
Wenn cacheMethod auf Cached for specific time festgelegt ist, Anzahl der Sekunden, die der Server den Eigenschaftswert zwischenspeichert, bevor eine Anforderung an Edge in Bezug auf den Eigenschaftswert gesendet wird. Der Wert wird immer bei der ersten Anforderung vom Edge abgerufen.
|
||
|
timeout
|
INTEGER
|
Zeitraum in Sekunden, in dem auf eine Antwort vom Remote-Ding gewartet werden soll.
|
||
|
pushType
|
STRING
|
Definiert, wie Werte vom Remote-Gerät übertragen werden. Mögliche Werte sind IMMER, NIE, EIN, AUS oder WERT, mit ähnlichen Definitionen wie für dataChangeType weiter oben.
|
||
|
pushThreshold
|
NUMBER
|
Definiert den Schwellenwert, den eine numerische Eigenschaft überschreiten muss, bevor eine Datenänderungen an das Remote-Gerät übertragen wird.
|