Model Variables
The model variables table contains properties of variables declared by the model.
Field Description | Field Name |
Name. Name of the variable. | name |
Description. Variable description. | description |
Format. Format of the variable. See format section for details. | format |
Writable. Flag indicating that variable is writable. | writable |
Help. Detailed variable description. | help |
Group. Variable group, or NULL if variable does not belong to any group. | group |
Read Permissions. Permission level in the model context (or a context the relative model is attached to, or an instantiable model's instance context) required to read the variable. | readPermissions |
Write Permissions. Permission level in the model context (or a context the relative model is attached to, or an instantable model's instance context) required to write the variable. | writePermissions |
Storage Mode. Defines whether variable's value is persistent (Database storage type) or transient (Memory storage type). | storageMode |
History Storage Time. Defines how long historical values of this variable are preserved in the server database. | updateHistoryStorageTime |
History Rate. Controls storing and firing updates policy. If it is 'Changes Only' then setting the same value for the variable will be ignored. If it is set to 'All Values' then any set operation for the variable will be stored and update is fired. | historyRate |
Cache Time. Defines minimal period of subsequent remote reads of variable value. If remote components try to read the variable twice during the cache period, 2nd read attempt will retrieve value from the cache. Non-defined value disables caching. | cacheTime |
Server In-memory Value Caching. Allows to control how the server cache variable values. Keep Always - variable cache will always hold last written value of the variable. Keep While Enough Memory - variable cache will hold last written value of the variable if server memory consumption is not critical. | serverCachingMode |
Add Previous Value To Variable Update Event. The flag indicating that the variable's Updated event will contain previous variable value. | addPreviousValueToVariableUpdateEvent |
These properties may be accessed through the modelVariables variable.
Read more about variable definition properties under Variables.
Was this page helpful?