Utilities

This context is a system context that provides miscellaneous operations. It is not shown in the visible context tree.

Unique Actions [?]

Show Data

This action fetches some data from the system by calculating an expression, shows it to the user using Edit Data UI procedure, and enables automatic re-retrieving and auto-refreshing of the shown data.

Action Name:

showData

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at None permission level

Execution Parameters:

1. Data Acquisition:

•	Expression to calculate

•	Refresh period

2. Data Presentation:

•	Title of the data window

•	Help, the text to show in the data window

•	Icon, the icon ID string of the data window icon

3. Location of the data window

Variable-Related Actions [?]

View Change History

This action shows historical changes of variable's value. It outputs the variable update history in the form of table. Every field of the monitored variable's format is shown in a separate field of the resulting table. If the variable value contains several rows, only the first row is shown.

View Variable Information

This action shows variable definition properties and its format.

Event-Related Actions [?]

View EVENT Information

This action shows event definition properties and its format.

Advanced Information

Context Information

Context Type: utilities

Context Name: utilities

Context Description: Utilities

Context Path: utilities

Context Mask: utilities

Context Permissions: None

Public Variables (Properties) [?]

This context has no public variables (properties).

Public Functions [?]

GET VARIABLE HISTORY

Returns update history of a specified variable. See View Variable History action for more information.

Function Name:

variableHistory

Permissions:

Accessible at Observer permission level

Input Records:

Input Format:

Name	Type	Description
mask	String	Context where variable is defined.
event	String	Variable name.
fromDate	String	Timestamp used to select only variable update events which occurred after a certain date. If it is NULL, all update events will be selected.

Output Records:

0...unlimited

Output Format:

Dynamic

Execute External Application

This function executes an external application referred by input arguments, waits for its termination and returns its output.

Function Name:

execute

Permissions:

Accessible at Administrator permission level

Input Records:

Input Format:

Name	Type	Description
command	String	Command fully qualified name with arguments.
directory	String	Working directory, may be omitted.

Output Records:

Output Format:

Name	Type	Description
exitCode	Integer	Command exit code.
output	String	Capture of command output.
errors	String	Capture of command error output.

Check Mail

Instructs AggreGate Server to fetch and process incoming e-mail messages.

Function Name:	checkMail
Permissions:	Accessible at Engineer permission level
Input Records:	0
Input Format:	None
Output Records:	0
Output Format:	none

Send EMail

Sends an email. This function will work properly only if mail sending is properly set up in server global configuration.

Function Name:

sendMail

Permissions:

Accessible at Operator permission level

Input Records:

Input Format:

Name	Type	Description
recipients	String	Comma-separated list of email recipients.
subject	String	Message subject.
message	String	Message text.
html	Boolean	Indicates that message text is in HTML format.

Output Records:

Output Format:

None

Send SMS

Sends an SMS message. This function will work properly only if SMS sending is properly set up in server global configuration.

Function Name:

sendSms

Permissions:

Accessible at Operator permission level

Input Records:

Input Format:

Name	Type	Description
recipient	String	Phone number of SMS recipient in international format.
message	String	Message text.

Output Records:

Output Format:

None

Update Host

Updates host in a dynamic DNS.

Function Name:

updateHost

Permissions:

Accessible at Operator permission level

Input Records:

Input Format:

Name	Type	Description
host	String	Host name to update. DNS zone to be updated is configured in Dynamic DNS global settings.
ip	String	IP address of the host.
remove	Boolean	Unregister host from DNS zone if false, or register it if true.

Output Records:

Output Format:

None

List Variables

This function returns a list of values of all single-cell (i.e. non-tabular and non-array) variables in all contexts matching to a certain mask and belonging to a certain group.

Function Name:

listVariables

Permissions:

Accessible at Observer permission level

Input Records:

Input Format:

Name	Type	Description
mask	String	Mask of context to list variables from.
group	String	Variable's group.

Output Records:

0...unlimited

Output Format:

Name	Type	Description
context	String	Context description.
variable	String	Variable description.
value	String	String representation of variable's value.

Statistics

This function returns last values for a statistical channel (e.g. last month's average, last day's minimum, etc.)

Function Name:

statistics

Permissions:

Accessible at Observer permission level

Input Records:

Input Format:

Name

Type

Description

mask

String

Mask of context to fetch statistical data from.

channel

String

Name of channel.

key

String

Dataset key or NULL to use default dataset.

period

String

Time period to show last values for. If NULL, the data will be fetched for all periods.

Period names:

•	millisecond or ms for Milliseconds

•	second, sec or s for Seconds

•	minute, min or m for Minutes

•	hour, hr or h for Hours

•	day or d for Days

•	week or w for Weeks

•	month for Months (Note, that month is zero-based, i.e. value for January is 0.)

•	year or y for Years

full

Boolean

If true, all statistical values are returned according to the above period (e.g. all hourly averages). If false, only last collected values are returned (e.g. last full hour averages).

average

Boolean

Show average value for the last period of selected type.

minimum

Boolean

Show minimum value for the last period of selected type.

maximum

Boolean

Show maximum value for the last period of selected type.

sum

Boolean

Show total value for the last period of selected type.

first

Boolean

Show first value for the last period of selected type.

last

Boolean

Show last value for the last period of selected type.

Output Records:

0...unlimited

Output Format:

Name	Type	Description
context	String	Name of context that originated data.
start	Date	Start of time period.
end	Date	End of time period.
key	String	Dataset key or NULL if default dataset was used.
average	Float	Average value for the time period.
minimum	Float	Minimum value for the time period.
maximum	Float	Maximum value for the time period.
sum	Float	Total value for the time period.
first	Float	First value for the time period.
last	Float	Last value for the time period.

Raw Statistics

This function returns raw statistical data for a statistical channel.

Function Name:

rawStatistics

Permissions:

Accessible at Observer permission level

Input Records:

Input Format:

Name	Type	Description
context	String	Name of context to fetch statistics from.
name	String	Name of channel to fetch statistics from.

Output Records:

0...unlimited

Output Format:

Dynamic

Public Events [?]

Common Events: info (Information)