Finding and Accessing Arbitrary Data

This section explains how to find, read or modify any data flowing inside the Iotellect installation.

First step is locating the context that exposes the necessary setting, operation or event. There are several ways to achieve that:

• Check server core context reference and/or vertical-solution-specific context references (that are also part of this documentation)
• Find necessary context in the System Tree of Iotellect Client or Web UI

• If the context containing necessary data was found in the context reference, check Public Variables, Public Functions or Public Events section of the corresponding article for name of variable/function/event providing necessary data

• If using Iotellect Server UI to locate the data, consider the following:
  • Tooltips of rows and cells of the Properties Editor component show names of variables;
  • Tooltips of events in Event Log component show event source context and name;
  • Function names may be tracked down using Entity Selector component;
  • Properties Editor provides View Variable Information operation in its context menu, while Event Log has View Event Definition context operation. These operations show all properties of the definitions, their formats, etc.

Since every value is a Data Table, it's necessary to find out what fields does its format have. That includes field names and types.

• If the necessary definition is found in context reference, its description contain a format table describing field names, types, and purposes.
• If using the UI, consider the following:
  • Values of variables, events data, or functions input/output are always opened in the Data Table Editor component. Column, row and cell tooltips in the Data Table Editor show field names and types;
  • View Variable Information and View Event Definition operations (see above) provide comprehensive information about all field properties, including their defaults, selection values, etc.

After locating the necessary context, variable/function/event, and their fields, you can access them programmatically, both from server plugins or using remote API:

• Get the necessary Context object using ContextManager.get(), Context.getChild() or Context.getParent() methods.

To programmatically construct server context names/paths use static helper methods defined in ContextUtils class and constants defined in Contexts class. Example: String alertContextPath = ContextUtils.alertContextPath("admin", "myAlert");

• Get/set variable, call function, of add event listeners using getVariable(), setVariable(), callFunction(), addEventListner() methods.
• To construct new value of variable of function input value from scratch, use the following code: new SimpleDataTable(VariableDefinition.getFormat()) or new SimpleDataTable(FunctionDefinition.getInputFormat()).
• When processing a DataTable, you can get a certain DataRecord using getRecord() method. The shortcut for getting the first record is rec() method.
• DataRecord provides generic getValue() and setValue() methods for reading/writing field values. However, there is a set of methods for getting field value castled to a certain type: getInt(), getString(), getBoolean(), etc.

To refer named server variables/functions/events/actions and their fields use constants defined in members of com.tibbo.aggregate.common.server package. Example: String serverVersion = rootContext.getVariable(RootContextConstants.V_VERSION).rec().getString(RootContextConstants.VF_VERSION_VERSION);

Was this page helpful?

Tell us more

Send

Thank you!