Root Context
This context is the root of Iotellect Server's context tree. It has some basic actions that are used to control the server.
Unique Actions
[ ? ]
Configure Server
This action is used to view or edit the global configuration options of Iotellect Server. Its only difference from a standard Configure action is that prompts the user to reboot the server once the new settings are saved (a reboot is needed to apply the changes). Additional information about server configuration may be found here.
Action Type: | |
Action Name: | configureServer |
Action Icon: |  |
Permissions: | Accessible at Administrator permission level |
View Server Information
This action shows information about Iotellect Server runtime environment. It may be useful for debugging and troubleshooting the server as well as resolving some performance issues.
There are several sections available:
Server Status. Different information about server real-time operational status, such as startup time or memory usage.
Server Environment. Information about Java Runtime environment and machine/operating system it's running on.
Database. Information about SQL database used in current Iotellect installation as configuration and event storage.
Context Statistics. List of all contexts and the number of variables, functions, events and actions in every context.
Expression Statistics. Statistics detailing the number of expressions parsed or evaluated, errors caught or generated, references parsed, as well as a breakdown of the number of times every function has been called.
Device Statistics. Overview of the number of variables read and written, as well as a count of device-related function calls and events.
License Information. Information about Iotellect license.
Active Plugins. Information about plugins being currently used by Iotellect Server.
Installed Modules. Table indicated installed modules, their IDs and versions.
Active Client Connections. The list of currently connected clients including remote address and connection type/time.
Cluster Status. Returns failover cluster node status information.
All Threads. List of server threads along with their state and stack trace. This information may be requested by Iotellect support team.
Thread Pool Statistics. The list of active and completed tasks for every server thread pool. This information may be helpful for analyzing server CPU load.
Thread Statistics. Overview of the number of live threads and total started threads.
Event Processing Rules Statistics. Detailed information about events processed over Event Processing Rules: number of suppressed, stored and de-duplicated events.
Event Queue Details. If Iotellect Server event queue is not empty, event details is displayed here: count of events in queue for each context.
Performance. Statistics related to memory management.
Action Type: | Configure (read-only mode) |
Action Name: | viewServerInfo |
Action Icon: |  |
Permissions: | Accessible at Administrator permission level |
Create Resources
This action is used to create pre-build resources (alerts, reports, widgets, etc.) that are included in Iotellect distribution. See Managing Pre-Built Resources for details.
Action Name: | createResources |
Action Icon: |  |
Permissions: | Accessible at Manager permission level |
Delete Resources
This action is used to delete pre-build resources (alerts, reports, widgets, etc.) that are included in Iotellect distribution. See Managing Pre-Built Resources for details.
Action Name: | deleteResources |
Action Icon: |  |
Permissions: | Accessible at Manager permission level |
Stop Server
This action allows to stop Iotellect Server. There are two options: immediate and delayed shutdown. In case of delayed shutdown all active operators are informed about the shutdown time and reason. This helps them to set current jobs aside and save all changes before the shutdown.
Action Type: | |
Action Name: | stop |
Action Icon: |  |
Permissions: | Accessible at Administrator permission level |
Restart Server
This action allows to restart Iotellect Server. There are two options: immediate and delayed restart. In case of delayed restart all active operators are informed about the restart time and reason. This helps them to set current jobs aside and save all changes before the restart.
 | Automatic restart is possible only when Iotellect Server is running in service mode. In other cases server must be stopped and started again manually. |
Action Type: | |
Action Name: | restart |
Action Icon: |  |
Permissions: | Accessible at Administrator permission level |
Start Maintenance Mode
This action forces the server to enter maintenance mode.
Action Type: | |
Action Name: | startMaintenanceMode |
Permissions: | Accessible at Administrator permission level |
Stop Maintenance Mode
This action forces the server to exit maintenance mode.
Action Type: | |
Action Name: | stopMaintenanceMode |
Permissions: | Accessible at Administrator permission level |
Remote Update
This Call Function action is used to update Iotellect Server remotely. See Remote Upgrade for more details.
Action Type: | |
Action Name: | upgrade |
Permissions: | Accessible at Administrator permission level |
Change Password
This Call Function action is used to change the password of the currently authenticated user.
Action Type: | |
Action Name: | changePassword |
Permissions: | Accessible at Operator permission level |
Search
This action is used to access the unified search dialog.
Action Name: | search |
Action Icon: |  |
Permissions: | Accessible at None permission level |
View Variable History
This Call Function action is used to access and view the update history of a certain variable. It prompts user to specify the following options:
Context where variable is defined;
Name of variable;
From Date to track update history backwards up to a certain date only.
This action outputs variable update history in the form of table. Every field of monitored variable's format is shown in a separate field of resulting table. If variable value contains several rows, only data of the first row is shown.
Action Type: | |
Action Name: | variableHistory |
Action Icon: |  |
Permissions: | Accessible at Administrator permission level |
View Event History
This Call Function action is used to select and view certain events from event history. It prompts user to specify event selection and presentation criteria:
Mask of contexts to select events from;
Name of event;
Event filtering expression;
Start Date to select only events which occurred after a certain date.
Action Type: | |
Action Name: | eventHistory |
Action Icon: | |
Permissions: | Accessible at Administrator permission level |
Delete Event History
This Call Function action is used to delete certain events from event history. It prompts the user to specify event selection criteria:
Mask of contexts to delete events from;
Name of event;
Start Date to delete only events which occurred after a certain date (optional);
End Date to delete only events which occurred before a certain date (optional).
Action Type: | |
Action Name: | deleteEvents |
Permissions: | Accessible at Administrator permission level |
View Channel Statistics
This Call Function action is used to view statistics for a certain statistical channel. It prompts user to specify channel properties:
Mask of contexts where channel is defined;
Name of channel;
Key of statistics dataset;
Grouping period (hour, day, etc.);
Aggregation types (average, maximum, etc.)
This action outputs channel statistics in the tabular form.
Action Type: | |
Action Name: | viewStatistics |
Action Icon: |  |
Permissions: | Accessible at Administrator permission level |
View Raw Channel Statistics
This Call Function action is used to view raw (full) statistics for a certain statistical channel. It prompts user to specify channel properties:
Mask of contexts where channel is defined;
Name of channel.
This action outputs channel statistics in the tabular form.
Action Type: | |
Action Name: | viewRawStatistics |
Action Icon: | |
Permissions: | Accessible at Administrator permission level |
Purge Statistics Channel
This Call Function action is used to delete all data collected by a certain statistical channel. It prompts user to specify channel properties:
Mask of contexts where channel is defined;
Name of channel.
This action outputs channel statistics in the form of table.
Action Type: | |
Action Name: | deleteStatistics |
Permissions: | Accessible at Administrator permission level |
Fill Statistics from Variable History
This Call Function action is used to reinitialize a statistical channel by loading all "raw" historical values of a variable and pushing them into the channel along with their historical timestamps.
The action is useful for restoring statistics if statistics file is corrupted or missing for some reason.
 | All statistics accumulated in the channel will be lost after execution of this action. |
| This action will only work if raw value history storage is enabled for a variable the statistical channel is based on. If no raw history is available, this action will just purge the statistical channel. If raw history is available for a certain period only, the channel will then contain statistics for the same period. |
The action prompts user to specify channel properties:
Mask of contexts where channel is defined;
Name of channel.
Action Type: | |
Action Name: | fillStatisticsFromHistory |
Permissions: | Accessible at Administrator permission level |
Generate Thread Dump
This action is used to generate a thread dump. A thread dump is a text file with list of all the Java threads that are currently active in the server's Java Virtual Machine.
Action Type: | |
Action Name: | generateThreadDump |
Permissions: | Accessible at Manager permission level |
Generate Heap Dump
This action is used to generate a heap dump. A heap dump is a binary file that contains details on memory allocated within the server's Java Virtual Machine.
Action Type: | |
Action Name: | generateHeapDump |
Permissions: | Accessible at Manager permission level |
View Context Statistics
This action displays detailed statistics on server contexts, including information on per-context retained memory size.
Action Type: | |
Action Name: | viewContextsInfo |
Permissions: | Accessible at Manager permission level |
Import
Used to import generic data into the system using a script.
Action Flow:
Select a script to be used for processing the imported data.
Select a file to be imported.
[Optional] Specify import options, if any options are available for the format of the selected file.
At this point, data is read from the file and converted to a Data Table.
Review the data to be imported.
At this point, the import script is launched and imported Data Table is passed to its input. The script should process table data record by record and make necessary modifications to the system (e.g. create/modify resources).
Action Name: | import |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Administrator permission level |
Execute Application
This action is used to launch an external application by calling the execute function of this context. It may be used, for example, to launch some program in response to the raised alert (see Executing Non-Interactive Actions On Alert for more information).
| This function cannot execute shell commands of an operating system. To execute some shell commands, put them to an executable script and execute the script instead. |
Action Type: | |
Action Name: | execute |
Permissions | Accessible at Administrator permission level |
Action Group: | Advanced Actions |
Run Garbage Collection
This action is used to initiate full garbage collection cycle of the Java Virtual Machine running Iotellect Server. Use this action before checking Memory Usage, % of Maximum Allowed parameter of Server Status variable to figure out the real server's memory consumption.
| Executing this action will force JVM to freeze all activities until the garbage collection process is over (this is called "stop the world"). This will cause downtime of Iotellect Server and all applications it's running. The duration of this downtime is normally a few seconds, but can be up to several minutes in case of large JVM heap sizes. |
See Dealing with Memory Usage for more information.
Action Type: | |
Action Name: | runGarbageCollection |
Permissions | Accessible at Administrator permission level |
Action Group: | Advanced Actions |
View Database Statistics
This action shows number of events and properties in all tables of Iotellect Server database. Event/property counts are grouped by database table, context path and event/property name.
Action Type: | |
Action Name: | viewDatabaseStatistics |
Permissions: | Accessible at Admin permission level |
Action Group: | Advanced Actions |
Open in Browser
This action allows a user to open a specific URL in client's default browser.
Action Name: | browse |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Observer permission level |
Execution Parameters: |
|
Compare
This action allows a user to compare two strings in the graphical diff viewer.
Action Name: | compare |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Observer permission level |
Execution Parameters: |
|
Terminate Client Connection
This action is used to force de-authentication and disconnection of one or more client sessions regardless of their type (desktop, web, API, etc.)
Action Type: | |
Action Name: | terminateClientConnection |
Permissions | Accessible at Administrator permission level |
Action Group: | Advanced Actions |
Common Actions
[ ? ]
Edit Context Permissions, Monitor Related Events
Context States and Icons
This context has no states. It is usually represented by the 
icon. In Iotellect Client, the icon representing this context depends on the connection state. See details here.
Advanced Information |
Context Information
Context Type: root
Context Name: "" (Empty string)
Context Description: "" (Empty string)
Context Path: "" (Empty string)
Context Mask: "" (Empty string)
Context Permissions
[ ? ]
Level | Description |
None | Users login. Users self-registration. |
Observer | Executing plain text Iotellect queries. |
Operator | User password self-changing. |
Manager | Creating bundled resources. |
Engineer | Requests for checking and processing incoming mail. |
Administrator | Viewing server information. Server stopping and restarting. Executing plain text native queries. Executing external applications. Accessing variable/event history and statistics. Viewing database statistics. Sending E-mail and SMS messages. |
Public Variables (Properties)
[ ? ]
Server Version
Returns version of Iotellect Server.
Variable Name: | version |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
version | String | Server version string. |
Server Status
Returns run-time information about Iotellect Server.
Variable Name: | status |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Server instance description. |
version | String | Server version. |
buildNumber | String | Server version’s build number. |
revisionNumber | String | Commit hash of the revision. |
installationDate | Date | Installation date. |
startTime | Date | Server startup timestamp. |
startupDuration | Long | Time taken by the server to start. |
uptime | Long | Server uptime. |
maxMemory | Long | Maximum allowed size of Java Virtual Machine (JVM) heap. Controlled by -Xmx parameter. |
totalMemory | Long | Current size of memory allocated for JVM heap. |
freeMemory | Long | Free memory in the currently allocated JVM heap. |
memoryUsage | Double | Currently used percent of maximum JVM heap size. Shows the real server memory usage if checked right after executing the Run Garbage Collection action. |
cpuLoad | Double | CPU load caused by the Java Virtual Machine. |
cpuLoadSystem | Double | Total CPU load. |
diskUtilization | Data Table | Disk utilization information. |
Configuration Storage Statistics
Statistical overview of data table operations in Iotellect Server.
Variable Name: | storageStatisticsConfiguration |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
tablesSaved | Long | Number of save operations performed on data tables. |
tablesLoaded | Long | Number of load operations performed on data tables. |
tablesDeleted | Long | Number of delete operations performed on data tables. |
tablesMoved | Long | Number of move operations performed on data tables. |
Event Storage Statistics
Overview of event statistics in Iotellect Server.
Variable Name: | storageStatisticsEvents |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
eventsSaved | Long | Number of events saved. |
eventsLoaded | Long | Number of events loaded. |
eventsUpdated | Long | Number of events updated. |
eventsDeleted | Long | Number of events deleted. |
eventsExpired | Long | Number of events which have expired. |
eventsMoved | Long | Number of events moved. |
Binary Data Storage Statistics
Statistical overview of operations on binary data blocks in Iotellect Server.
Variable Name: | storageStatisticsBinaryData |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
blocksSavedAndUpdated | Long | Number of save and update operations performed on binary data blocks. |
blocksLoaded | Long | Number of load operations performed on binary data blocks. |
blocksDeleted | Long | Number of delete operations performed on binary data blocks. |
Relational Database Statistics
Returns statistical overview of Iotellect Server relational database.
Variable Name: | relationalDatabase |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
queries | Long | Number of queries executed since server startup. |
transactions | Long | Number of transactions completed since server startup. |
loaded | Long | Number of objects fetched from the database since server startup. |
updated | Long | Number of objects updated in the database since server startup. |
inserted | Long | Number of objects inserted into the database since server startup. |
deleted | Long | Number of objects deleted from the database since server startup. |
maxQueryTime | Long | Maximum execution time of all database queries performed since server startup. |
Relational Database Table Statistics
Returns detailed statistics of Iotellect Server relational database tables.
Variable Name: | realtionalDatabaseTables |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
table | String | Table name. |
loaded | Long | Number of objects fetched from the table since server startup. |
updated | Long | Number of objects updated in the table since server startup. |
inserted | Long | Number of objects inserted into the table since server startup. |
deleted | Long | Number of objects deleted from the table since server startup. |
Relational Database Connection Statistics
Returns statistical overview of Iotellect Server relational database connections.
Variable Name: | relationalDatabaseConnections |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
connections | Long | Number of connections in the connection pool. |
idleConnections | Long | Number of idle connections in the connection pool. |
busyConnections | Long | Number of busy connections in the connection pool. |
unclosedConnections | Long | Number of unclosed connections in the connection pool. |
Relational Database Cluster Statistics
Returns detailed statistics of Iotellect Server relational database cluster.
Variable Name: | relationalDatabaseCluster |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
node | String | Database cluster node name. |
location | String | Location (URL) of the database cluster node. |
alive | Boolean | Shows whether a database is available for connections. |
active | Boolean | Shows whether a database is currently being used by the cluster. |
synchronizationDuration | Long | Duration of current cluster database synchronization or NULL if no synchronization is currently performed. |
Context Statistics
Returns statistical information Iotellect Server contexts, variables, functions, events, and actions.
Variable Name: | sysinfo |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
context | Integer | Name and description of the Iotellect Server context. |
variableCount | Integer | Total number of variable definitions in the context. |
functionCount | Integer | Total number of function definitions in the context. |
eventCountco | Integer | Total number of event definitions in the context. |
actionCount | Integer | Total number of action definitions in the context. |
variablesRead | Long | Number of variable read operations performed since server startup. |
variablesWritten | Long | Number of variable write operations performed since server startup. |
functionsCalled | Long | Number of function call operations performed since server startup. |
eventsFired | Long | Number of events fired since server startup. |
eventHandleOffers | Long | Number of times event handlers were offered to handle this event. |
eventHandleExecutions | Long | Number of times event handlers handled this event. |
eventListenerCount | Long | Number of event listeners for this event. |
eventQueuesLength | Long | Context's internal event queue for this event. |
memory | Long | Approximate amount of heap space retained by this context. |
Expression Statistics
Indicates some information related to expression processing.
Variable Name: | expressionStatistic |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
parsed | Long | Expressions Parsed. |
evaluated | Long | Expressions Evaluated. |
errGenerated | Long | Errors Generated. |
errCaught | Long | Errors Caught. |
refProcessed | Long | References Processed. |
funcCalled | Data Table | Table detailing how many times each function has been called, with fields:
|
Device Statistics
Returns brief statistical information about Iotellect Server devices.
Variable Name: | deviceStatistics |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
variablesRead | Long | Number of variable read operations performed since server startup. |
variablesWritten | Long | Number of variable write operations performed since server startup. |
functionsCalled | Long | Number of function call operations performed since server startup. |
eventsFired | Long | Number of events fired since server startup. |
License Information
Returns information about active Iotellect Server license.
Variable Name: | license |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
issueDate | Data | License issue date. |
holder | String | License holder. |
version | String | Server version pattern. |
trialPeriod | Integer | Trial period (days), or NULL for non-trial license. |
trialRemaining | Integer | Remaining trial period (days), or NULL for non-trial license. |
maxDevices | Integer | Maximum number of devices allowed by the license. |
curDevices | Integer | Current number of registered devices. |
activationKey | String | Server activation key. |
pluginGroups | Data Table | Plugin groups included into the license:
|
Active Plugins
Returns information active Iotellect Server plugins.
Variable Name: | plugins |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
id | String | Plugin ID. |
type | String | Plugin type. |
name | String | Plugin description. |
Installed Modules
List of modules installed in the system and some identifying information.
Variable Name: | modules |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
id | String | Module ID. |
description | String | Module Description |
image | Data Block | Module Image. |
versions | Data Table | Information detailing module versions. |
Active Client Connections
Returns information about active client connections.
Variable Name: | connections |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
user | String | Username of authenticated user. |
login | String | Login of authenticated user. May differ from username if external authentication is being used. |
type | String | Connection type (Client, Web, Web Service, etc.) |
date | Date | Time when connection was established. |
address | String | Client's IP address. |
eventsQueued | Long | Current number of unprocessed events in current client session event queue. |
eventsDiscarded | Long | Number of events discarded during current client session due queue overflow. |
contextLocks | Data Table | List of active context locks. |
Current Session Username
Returns current session username.
Variable Name: | username |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
value | String | Username of authenticated user. |
Current Session Login
Returns current session login.
Variable Name: | login |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
value | String | Login of authenticated user. May differ from username if external authentication is being used. |
Current Session Connection Type
Returns current session connection type.
Variable Name: | type |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
value | String | Connection type (Client, Web UI, Web Service, etc.) |
Cluster Status
Returns failover cluster node status information.
Variable Name: | cluster |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
id | String | Cluster node ID. |
role | Integer | Cluster node role. |
time | Long | Time elapsed since node live status confirmation. |
Threads
Returns comprehensive list of server threads.
Variable Name: | threads |
Records: | 0...unlimited |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
id | Long | Thread unique ID. |
name | String | Thread name. |
group | String | Thread group name. |
priority | Integer | Thread priority. |
state | String | Thread state. |
daemon | Boolean | True if thread is a daemon thread. |
interrupted | Boolean | True if thread has been interrupted. |
cpu | Double | Thread's average CPU load during last second of server operation. It's measured in percent of server's overall CPU load. Threads that are currently blocked have zero CPU load while new threads are shown with NULL load. |
stack | Data Table | Thread stack track with the following fields:
|
Thread Pool Statistics
Returns statistical information about server thread pools. This allows to diagnose health and performance of various server thread pools, including but not limited to:
Synchronization Executors, i.e. threads executing device synchronization tasks
Synchronization Timers initiating new device synchronizations upon schedule
Context Operation Executors that enable concurrent server startup/shutdown, as well as parallel execution of tasks raised by contexts
Client Command Processors which are threads responsible for processing requests received from Iotellect Client instances and via server API
Command Senders that push Iotellect protocol commands into network sockets
Asynchronous Update Handlers that process events and value updates received via Iotellect protocol
Custom thread pools used by modules like Alerts, Trackers, etc.
Variable Name: | pools |
Records: | 0...unlimited |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
poolName | String | Pool name. |
activeCount | Integer | Number of active tasks. |
completedCount | Long | Number of completed tasks. |
totalCount | Long | Total number of tasks. |
coreSize | Integer | Pool core size. |
largestSize | Integer | Pool largest (peak) size. |
maximumSize | Integer | Pool maximum allowed size. |
queueLength | Integer | Task queue length. |
Thread Statistics
Returns overall statistics on server threads.
Variable Name: | threadStatistics |
Records: | 1 |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
live | Integer | Number of currently running live threads. |
maximumLive | Integer | Maximum number of simultaneously running live threads since server startup. |
totalStarted | Integer | Total number of threads started since server startup. |
Server Environment
Returns information about Java Virtual Machine that is running Iotellect Server and server/PC that it is running on.
Variable Name: | environment |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
property | String | Name of property. |
value | String | Property value. |
Event Processing Details
Returns generic information and statistics on server event processing.
Variable Name: | eventProcessingDetails |
Records: | 0...unlimited |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
eventQueueLength | Integer | Server context event dispatcher queue length. |
eventsScheduled | Long | Total number of scheduled events. |
eventsProcessed | Long | Total number of processed events. |
Event Processing Rules Statistics
Returns statistical information collected by event processing rules. Note, that event rules statistics is reset upon server restarts.
Variable Name: | eventRuleStatistics |
Records: | 0...unlimited |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
context | String | Context path. |
event | String | Event name. |
filtered | Long | Number of events that were suppressed by this rule. |
stored | Long | Number of events that passed the rules and were saved in the server database. |
Event Queue Details
Returns statistical information about the event queue. Note that if there are no events in the queue, this variable will have no records.
Variable Name: | eventQueueStatistics |
Records: | 0...unlimited |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
context | String | Context path. |
eventCount | Long | Number of unprocessed events that are present in the queue for this context. |
Event Statistics
Returns counts of events grouped by Iotellect Server database table, context path and event name.
Variable Name: | eventStatistics |
Records: | 0...unlimited |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
table | String | Database table name. |
context | String | Context path. |
event | String | Event name. |
count | Long | Number of events of the above type that occurred in the above context. Note, that all events of a certain type that occurred in a single context are always stored in a single table. |
Variable Statistics
Returns how many variables values are stored in the database for each Iotellect Server context.
Variable Name: | variableStatistics |
Records: | 0...unlimited |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
context | String | Context path. |
count | Long | Number of context variable's values that are currently stored in the database. Note, that default variable values are not saved to the database, and, thus, counts may be very low right after server installation. |
Memory Clearing
Returns information on the state of the memory management sub-system that supervises the non-persistent cache of variable values and other large in-memory structures. The Memory Clearing operation monitors the JVM heap memory consumption, partially or fully clearing the caches when necessary. Low Memory Mode activates in an attempt to prevent Out Of Memory errors when allocated memory is not sufficient for memory-intensive operations.
Variable Name: | memoryClearing |
Records: | 0...unlimited |
Permissions: | Readable at Admin permission level |
Record Format:
Field Name | Field Type | Notes |
lowMemoryMode | Boolean | Indicates Low Memory Mode is active and only certain server functions will be available until memory usage is brought below the maximum threshold. |
lastLowMemoryModeDuration | Long | Number of milliseconds elapsed during the most recent activation of Low Memory Mode. |
currentCacheEntryCount | Integer | Current number of cache entries. |
maximumCacheEntryCount | Integer | Largest number of observed cache entries. |
estimatedCacheSize | Long | Estimated size of cache expressed as bytes. |
lastCleaningDuration | Long | Number of milliseconds elapsed during the most recent Memory Clearing operation. |
lastCleaningStart | Date | Timestamp indicating when the Memory Clearing operation was most recently activated. |
clearingRunsCount | Integer | Number of times the Memory Clearing operation was activated since server start. |
lastCleanedMemorySize | Long | Number of bytes cleared from cache during the most recent Memory Clearing operation. |
lastCleanedEntityCount | Integer | Total number of entities removed from cache during the most recent Memory Clearing operation. |
lowMemoryModesCount | Integer | Indicates the number of times the server has entered Low Memory Mode since the server started. |
Public Functions
[ ? ]
Register New User Account
Registers new user account.
Function Name: | register | ||
Permissions: | Accessible at None permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
name | String | Account username. | |
password | String | Account password. | |
passwordre | String | Repeat account password to confirm. | |
initializationPassword | Boolean | If True, the user will be required to change their password after the first successful login. | |
permissions | String | Permission level for a new user. Used only if registration is performed by administrator. | |
adminPermissions | String | If selected, Iotellect will attempt to use an External Authentication method during the Authentication and Authorization Sequence. | |
globalPermissions | String | Permission level the user will have for global resources that do not belong to any users. | |
useExternalAuthentication | Boolean | Indicates that the user should be authenticated with an External Authentication plugin. | |
externalUser | String | Optional, indicates the external user with which this account should be associated. | |
Output Records: | 0 | ||
Output Format : | None | ||
Login
Pass authentication/authorization and continue session with access permissions of a certain user.
Function Name: | login | ||
Permissions: | Accessible at None permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
username | String | Username of user to authenticate. | |
password | String | User account password. | |
code | String | Authentication code (optional). | |
state | String | Authentication state (optional). | |
provider | String | Authentication provider (optional). | |
countAttempts | Boolean | Defines whether login attempt counting is enabled (optional). | |
Output Records: | 0 | ||
Output Format : | None | ||
Logout
Log out to continue session with None user permissions.
Function Name: | logout |
Permissions: | Accessible at None permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format : | none |
 | If you call this function in widget inside web environment, you can't see any changes till page refresh. But you can use the Logout operation of widget root panel instead. |
Change Password
Changes password of a currently authenticated user account.
Function Name: | changePassword | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
oldPassword | String | Old password for the account. | |
newPassword | String | New password. | |
repeatPassword | String | Must match the new password. | |
Output Records: | 0 | ||
Output Format : | None | ||
Execute Query
Executes a custom Query with permissions of current user.
Function Name: | executeQuery | ||
Permissions: | Accessible at Observer permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
query | String | Query text. | |
Output Records: | 0...unlimited | ||
Output Format : | Dynamic | ||
Execute Native Query
Executes a native query over an Iotellect Server relational database. More information is available in the Queries Context References.
Function Name: | executeNativeQuery | ||
Permissions: | Accessible at Administrator permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
query | String | Query text. | |
update | Boolean | Flag indicating that query is an update query (DELETE, INSERT, UPDATE, etc.). | |
Output Records: | 0...unlimited | ||
Output Format : | Dynamic | ||
Restart Server
Restarts Iotellect Server.
Function Name: | restart | ||
Permissions: | Accessible at Administrator permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
instantly | Boolean | Allows to choose between immediate and delayed restart. | |
delay | Long | Delay before scheduled restart. | |
reason | String | Reason of scheduled restart. | |
Output Records: | 0 | ||
Output Format : | none | ||
Stop Server
Stops Iotellect Server.
Function Name: | stop | ||
Permissions: | Accessible at Administrator permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
instantly | Boolean | Allows to choice between immediate and delayed shutdown. | |
delay | Long | Delay before scheduled shutdown. | |
reason | String | Reason of scheduled shutdown. | |
Output Records: | 0 | ||
Output Format : | none | ||
Start Maintenance Mode
This action forces the server to enter maintenance mode.
Function Name: | startMaintenanceMode |
Permissions: | Accessible at Administrator permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format : | none |
Stop Maintenance Mode
This action forces the server to exit maintenance mode.
Function Name: | stopMaintenanceMode |
Permissions: | Accessible at Administrator permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format : | none |
Session Set
Sets value of the session variable. Variable is available till current user session is open.
Function Name: | sessionSet | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
sessionVariable | String | Session variable name. | |
sessionValue | Data Table | Variable value. | |
Output Records: | 0...unlimited | ||
Output Format : | none | ||
Session Get
Gets value of the mentioned session variable.
Function Name: | sessionGet | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
sessionVariable | String | Session variable name. | |
Output Records: | 0...unlimited | ||
Output Format : | Dynamic | ||
Public Events
[ ? ]
Common Events: info (Information)
Context Added
Fires when a new context of any type is added to the server context tree. This event may fire multiple times for the same context, e.g. during each server startup.
Event Name | contextAdded |
Permissions: | Accessible at Administrator permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Path of context. |
Context Removed
Fires when a context of any type is removed from the server context tree. This event may fire multiple times for the same context, e.g. during each server shutdown.
Event Name | contextRemoved |
Permissions: | Accessible at Administrator permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Path of context. |
Context Created
Fires when a new resource context (e.g. alert, widget or device ) is created. In contrast to contextAdded event this event fires only once for every resource upon its initial creation. It will not fire again on server startup.
Event Name | contextCreated |
Permissions: | Accessible at Administrator permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Path of context. |
Context Destroyed
Fires when a resource context (e.g. alert, widget or device ) is permanently destroyed. In contrast to contextRemoved event this event fires only once when the resource is being deleted. It does not fire during server shutdown.
Event Name | contextDestroyed |
Permissions: | Accessible at Administrator permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Path of context. |
Context Entity Added
Fires when a new entity definition (variable, function, event, action) is added to the any server context.
Event Name | contextEntityAdded |
Permissions: | Accessible at Administrator permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Path of context where entity was added. |
entity | String | Entity name. |
entityType | Integer | Entity type: |
Context Entity Removed
Fires when entity definition (variable, function, event, action) is removed from the any server context.
Event Name | contextEntityRemoved |
Permissions: | Accessible at Administrator permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Path of context where entity was removed. |
entity | String | Entity name. |
entityType | Integer | Entity type: |
Feedback
Server generates this event to report its activity related to a currently logged user.
Event Name | feedback |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
message | String | Server message. |
duration | Long | Number of milliseconds to display the |
Server Started
The server generates this event to report the completion of the startup.
Event Name | serverStarted |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
startupDuration | Long | Startup duration in milliseconds. |
Session Variable Updated
Fires when session variable is updated.
Event Name | sessionVariableUpdated |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
sessionVariable | String | Name of the updated session variable. |
sessionOldValue | Data Table | Old session variable value. |
sessionNewValue | Data Table | New session variable value. |
Was this page helpful?