Aggiunta di proprietà agli oggetti a livello di codice
Il servizio AddPropertyDefinition può essere utilizzato per creare una nuova proprietà locale o associata in remoto in un oggetto, un modello di oggetto o una thing shape. Il servizio presenta i parametri riportati di seguito.
|
Parametro
|
Tipo di base
|
Descrizione
|
|---|---|---|
|
name
|
STRING
|
Obbligatorio. Nome della proprietà da creare.
|
|
type
|
BASETYPENAME
|
Obbligatorio. Tipo di base ThingWorx della proprietà. Per un elenco dei tipi di base ThingWorx, vedere la tabella "Tipi di base" in Proprietà degli oggetti.
|
|
description
|
STRING
|
Descrizione della proprietà.
|
|
category
|
STRING
|
Nome della categoria per classificare la proprietà.
|
|
dataShape
|
DATASHAPENAME
|
Quando il tipo di base della proprietà è INFOTABLE, definisce la data shape utilizzata dalla proprietà.
• Prima di eseguire il servizio, è necessario che sia presente l'entità data shape specificata per questo parametro.
• Questa parametro non è obbligatorio. Tuttavia, non è possibile impostare INFOTABLE tramite Composer (utilizzando il pulsante Imposta) senza una data shape specificata.
|
|
defaultValue
|
STRING
|
Specifica il valore di default della proprietà.
|
|
readOnly
|
BOOLEAN
|
True se la proprietà è di sola lettura, in caso contrario false.
|
|
persistent
|
BOOLEAN
|
True se i valori rimangono persistenti dopo un riavvio del servizio ThingWorx (i valori sono memorizzati nel provider di persistenza), false se il valore viene cancellato al riavvio del servizio ThingWorx.
|
|
logged
|
BOOLEAN
|
Se true, la proprietà è memorizzata in uno stream di valori configurati.
|
|
dataChangeType
|
STRING
|
Definisce ciò che costituisce una modifica del valore della proprietà a scopo di registrazione/avviso. Sono presenti Sempre, Mai, ON, OFF o Valore.
• Sempre - Attiva un evento di modifica per qualsiasi modifica del valore della proprietà.
• Mai - Non attiva mai un evento di modifica per una modifica del valore della proprietà.
• ON - Per la maggior parte dei valori, qualsiasi modifica alla proprietà attiva un evento di modifica dati.
• OFF - Attiva un evento di modifica dati se il nuovo valore restituisce il valore booleano false.
• Valore - Per i tipi numerici (NUMBER, INTEGER, LONG e così via), un evento di modifica è attivato se la differenza tra il valore precedente della proprietà e quello nuovo supera la soglia specificata nel parametro dataChangeThreshold.
|
|
dataChangeThreshold
|
NUMBER
|
Numero minimo di modifiche della proprietà numerica prima della generazione di un evento di modifica dati.
|
Proprietà remote
Per le proprietà associate in remoto sono presenti parametri aggiuntivi. Vengono specificati come array di remoteBindingAspects.
 |
Non è necessario specificare queste proprietà, a meno che la proprietà da definire sia associata a una proprietà remota.
|
|
Parametro
|
Tipo di base
|
Descrizione
|
||
|---|---|---|---|---|
|
remote
|
BOOLEAN
|
True se la proprietà è associata a una proprietà remota, false in caso contrario. (Default: false)
|
||
|
remotePropertyName
|
STRING
|
Nome della proprietà dell'oggetto remoto da associare.
|
||
|
cacheMethod
|
STRING
|
Modalità di lettura dei valori delle proprietà dell'edge associate:
• Read from server cache impedisce al server di richiedere il valore della proprietà all'edge. Il valore viene sempre recuperato dalla cache del server. Gli aggiornamenti del valore memorizzato nella cache dipendono dal parametro dataChangeType della proprietà e dalla frequenza di analisi. Senza le impostazioni della proprietà nell'edge, è possibile che il server non riceva mai il valore dall'edge e restituisca solo il valore di default memorizzato nel server. Se il parametro dataChangeType della proprietà è ALWAYS o VALUE, questa è l'impostazione di default di cacheMethod.
• Fetch from remote every read recupera il valore dall'edge per ogni richiesta. Questa opzione non implica alcuna memorizzazione nella cache. Se il parametro dataChangeType della proprietà è NEVER, questa è l'impostazione di default del tipo di cache.
• Cached for specific time consente di controllare la frequenza con cui vengono effettuate richieste all'edge. Dopo la prima richiesta, il server accede alla proprietà nel dispositivo edge per ottenerne il valore. Non vengono effettuate altre richieste all'edge fino alla scadenza dell'intervallo cacheIntervaldefinito. Tenere presente che in tale intervallo di tempo il dispositivo edge potrebbe aggiornare il valore sul server tramite push.
|
||
|
cacheInterval
|
NUMBER
|
Quando il parametro cacheMethod è impostato su Cached for specific time, il numero di secondi per i quali il server memorizza nella cache il valore della proprietà prima che venga inviata una richiesta all'edge per ottenere tale valore. Alla prima richiesta, il valore viene sempre recuperato dal dispositivo edge.
|
||
|
timeout
|
INTEGER
|
Tempo di attesa in secondi per ottenere una risposta dall'oggetto remoto.
|
||
|
pushType
|
STRING
|
Definisce la modalità di push dei valori dal dispositivo remoto. Impostare su ALWAYS, NEVER, ON, OFF o VALUE, con definizioni simili a dataChangeType sopra.
|
||
|
pushThreshold
|
NUMBER
|
Definisce la soglia che una proprietà di tipo numerico deve superare prima del push di una modifica dati al dispositivo remoto.
|