Root Context

Top Previous Next

This context is the root of AggreGate 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 AggreGate 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:	Configure
Action Name:	configureServer
Action Icon:
Permissions:	Accessible at Administrator permission level

View Server Information

This action shows information about AggreGate Server runtime environment. It may be useful for debugging and troubleshooting the server as well as resolving some performance issues.

There are two sections available:

•	Server Status. Different information about server real-time operational status, such as startup time or memory usage.

•	Context Statistics. List of all contexts and the number of variables, functions, events and actions in every context.

•	License Information. Information about AggreGate license.

•	Active Plugins. Information about plugins being currently used by AggreGate Server.

•	Active Client Connections. The list of currently connected clients including remote address and connection type/time.

•	Threads. List of server threads along with their state and stack trace. This information is may be requested by AggreGate 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.

•	Server Environment. Information about Java Runtime environment and machine/operating system it's running on.

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 AggreGate distribution. See Managing Pre-Built Resources for details.

Action Name:	createResources
Action Icon:
Permissions:	Accessible at Manager permission level

STOP SERVER

This action stops AggreGate Server, after confirmation.

Action Type:	Call Function
Action Name:	stop
Action Icon:
Permissions:	Accessible at Administrator permission level

RESTART SERVER

This action restarts AggreGate Server after confirmation.

Automatic restart is possible only when AggreGate Server is running in service mode. In other cases server must be stopped and started again manually.

Action Type:	Call Function
Action Name:	restart
Action Icon:
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:	Call Function
Action Name:	changePassword
Permissions:	Accessible at Operator 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:	Call Function
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;

•	From Date to select only events which occurred after a certain date.

Here is an example of output (selecting user login events, Context Mask = users, Event Name = login, Filter Expression = ""):

ls_conref_event_history

Action Type:	Call Function
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:	Call Function
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:

•	Context where channel is defined;

•	Name of channel.

This action outputs channel statistics in the form of table.

Action Type:	Call Function
Action Name:	viewStatistics
Action Icon:
Permissions:	Accessible at Administrator permission level

Import

Used to import generic data into the system using a script.

Action Flow:

1.	Select a script to be used for processing the imported data.

2.	Select a file to be imported.

3.	[Optional] Specify import options, if any options are available for the format of the selected file.

4.	At this point, data is read from the file and converted to a Data Table.

5.	Review the data to be imported.

6.	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

Send Email

This Call Function instructs AggreGate Server to send an email message.

Action Type:	Call Function
Action Name:	sendMail
Action Group:	Advanced Actions

Send SMS

This Call Function instructs AggreGate Server to send an SMS message.

Action Type:	Call Function
Action Name:	sendSms
Action Group:	Advanced Actions

EXECUTE Application

This Call Function action is used to launch an external application by calling 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).

Action Type:	Call Function
Action Name:	execute
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 AggreGate Server database. Event/property counts are grouped by database table, context path and event/property name.

Action Type:	Edit Properties
Action Name:	viewDatabaseStatistics
Permissions:	Accessible at Admin permission level
Action Group:	Advanced Actions

Check Incoming Mail

This Call Function forces AggreGate Server to fetch mail from an incoming mail server.

Action Type:	Call Function
Action Name:	checkMail
Permissions:	Accessible at Engineer permission level
Action Group:	Advanced Actions

Update Host

This Call Function instructs AggreGate Server add or remove host from a DNS using a dynamic DNS update.

Action Type:	Call Function
Action Name:	updateHost
Permissions:	Accessible at Admin 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 AggreGate 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: None

Public Variables (Properties) [?]

SERVER VERSION

Returns version of AggreGate 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 AggreGate 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.
startTime	Date	Server startup timestamp.
uptime	Long	Server uptime.
freeMemory	Long	Free memory in the currently allocated Java Virtual Machine (JVM) heap.
maxMemory	Long	Maximum allowed size of JVM heap. Controlled by -Xmx parameter.
totalMemory	Long	Current size of JVM heap.
database	String	Diverse statistical metrics related to database access.

Context Statistics

Returns statistical information AggreGate 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 AggreGate Server context.
variableCount	Integer	Total number of variable definitions in the context.
functionCount	Integer	Total number of function definitions in the context.
eventCount	Integer	Total number of event definitions in the context.
actionCount	Integer	Total number of action definitions in the context.

License INFORMATION

Returns information about active AggreGate Server license.

Variable Name:	license
Records:	1
Permissions:	Readable at Observer permission level

Record Format:

Field Name	Field Type	Notes
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.

Active Plugins

Returns information active AggreGate 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.

Active Client Connections

Returns information 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.
type	String	Connection type (Client, Web Desktop, Web Service, etc.)
date	Date	Connection time.
address	String	Client's IP address.

Threads

Returns comprehensive list of server threads.

Variable Name:	threads
Records:	0...unlimited
Permissions:	Readable at Observer permission level

Record Format:

Field Name

Field Type

Notes

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.

stack

Data Table

Thread stack track with the following fields:

•	Class name

•	Method name

•

File name

•	Line number

Thread Pool Statistics

Returns statistical information about server thread pools.

Variable Name:	pools
Records:	0...unlimited
Permissions:	Readable at Observer 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 size.

SERVER Environment

Returns information about Java Virtual Machine that is running AggreGate 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 Statistics

Returns counts of events grouped by AggreGate 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 AggreGate 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.

Public Functions [?]

Registers new user account.

Function Name:

Permissions:

Accessible at None permission level

Input Records:

Input Format:

Name	Type	Description
username	String	Name of account.
password	String	Account password.
passwordre	String	Account password.
permissions	String	Permission level for a new user. Used only if registration is performed by administrator.

Output Records:

Output Format:

None

Pass authentication/authorization and continue session with access permissions of a certain user.

Function Name:

Permissions:

Accessible at None permission level

Input Records:

Input Format:

Name	Type	Description
username	String	Username of user to authenticate as.
password	String	User account password.

Output Records:

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

Change Password

Changes password of a currently authenticated user account.

Function Name:

changePassword

Permissions:

Accessible at Operator permission level

Input Records:

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:

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:

Input Format:

Name	Type	Description
query	String	Query text.

Output Records:

0...unlimited

Output Format:

Dynamic

EXECUTE Native QUERY

Executes a native query over AggreGate Server database. More information is available here.

Function Name:

executeNativeQuery

Permissions:

Accessible at Administrator permission level

Input Records:

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 AggreGate Server.

Function Name:	restart
Permissions:	Accessible at Administrator permission level
Input Records:	0
Input Format:	None
Output Records:	0
Output Format:	none

STOP SERVER

Stops AggreGate Server.

Function Name:	stop
Permissions:	Accessible at Administrator permission level
Input Records:	0
Input Format:	None
Output Records:	0
Output Format:	none

Public Events [?]

Common Events: info (Information)

FEEDBACK

Server generates this event to report its activity related to a currently logged user.

Event Name	feedback
Permissions:	Accessible at Observer permission level
Records:	1

Record Format:

Field Name	Field Type	Notes
message	String	Server message.