input.Json  is the JToken object representing the root of the JSON document. This is typically a JObject or a JArray. For more information on these types, consult the Newtonsoft.Json documentation.

input.Level  is the current processing level in the recursive processing, where the root is level 0.

app.ProcessJson()  Start the recursive processing of the JSON message.

app.PointNameModifier()  The point name modifier method described above.

app.ObjectProcessor()  The object processor method described above.

app.ArrayProcessor()  The array processor method described above.

app.PropertyProcessor()  The property processor method described above.

app.ValueProcessor()  The value processor method described above.

app.ArrayValueNamer()  The array value naming method described above.

app.TopicInitialization()  The topic initialization method described above.

app.ExcludePaths  An array of strings representing the full JSON paths to fields that should not be processed. You would use this, for example, to ignore a field that contains a date that you do not want to be written to a data point. Instead, you would extract that date and use it as the timestamp when writing other data points.

app.DefaultDomain  A read-only string representing the data domain configured for the MQTT broker or client. If there is no default domain configured for this broker or client, then the first element of a path (topic or JSON path) will be used as the domain name when creating DataHub data points.

app.RegisterPoint  There are multiple forms of this function with different signatures. This function associates a data point with a publish format. If the point name is null, or the form of app.RegisterPoint does not accept a point name, then the data point name is formed by concatenating the topic and path arguments separated by a slash and then calling the PointNameModifier function on the result. The full topic is formed by concatenating the topic and jsonPath arguments. If the jsonPath is null then it is ignored. Whenever the data point changes in the DataHub data engine, the point value will be written to the full topic.

app.WritePoint  There are multiple forms of this function with different signatures. This function writes a value to a DataHub data point with the given quality and timestamp. At least one of jsonPath, pointName, and basepointName must be a non-empty string. The target point name will be determined as follows:

app.WritePoint(pointName, value)  Writes a value to a DataHub point with quality = PointQuality.Good and a timestamp of the current system time.

app.WritePoint(pointName, value, quality, timestamp)  Writes a value to a DataHub point with the provided quality and timestamp.

app.WritePoint(topic, jsonPath, value)  Writes a value to a DataHub point with quality = PointQuality.Good and a timestamp of the current system time.

app.WritePoint(topic, jsonPath, value, quality, timestamp)  Writes a value to a DataHub point with the provided quality and timestamp.

app.WritePoint(topic, jsonPath, property)  Writes a value to a DataHub point with quality = PointQuality.Good and a timestamp of the current system time. The value written to the data point is the value of the JProperty property.

app.WritePoint(basePointName, property, quality, timestamp)  Writes a value to a DataHub data point with the given quality and timestamp. The value is provided as a JProperty rather than a simple value. The value written to the data point is the value of the JProperty.

DataPoint app.ReadPoint(pointName)  Reads a single data point from the DataHub data engine. This returns a DataPoint instance from which the value can be extracted using point.DblVal, point.StrVal, etc. The available members of a DataPoint are listed in the Common Formulas table, under Points, in the Advanced JSON Message Format window.

DataPoint[] app.ReadPoints(pointNames)  Reads multiple data points from the DataHub data engine. This is much more efficient than reading multiple points one at a time using ReadPoint. The list of pointNames can be any IEnumerablestring type.

DataPoint[] app.GetChildren(parentname, pattern, includeLeaves, includeBranches, recursive)  Retrieves the current names and values for all child points of the parentname, a fully qualified point name, including the domain: prefix. The pattern is a globbing pattern, not a regular expression. See the shell_match function for the matching rules. Use the asterisk character ( * ) to retrieve all child points. For includeLeaves and includeBranches, an entry of true or false indicates whether to retrieve leaf or branch points, respectively. For recursive, an entry of true or false indicates whether to recursively descend into all descendent children of the parent point. If recursive is false, GetChildren will return only the immediate children of the parent point.

DataPoint[] app.GetRegisteredPoints()  Returns a list of the points that have been configured for this connection.

app.Log(message)  Logs a message. During testing this will write the message to the test output pane. At runtime this will write the message to the DataHub Event Log. This function does not add a newline at the end of the message.

app.Debug(message)  Logs a message only during testing. At runtime this will do nothing.

string app.PointNameFromTopic(topic)  Constructs a point name given an MQTT topic or JSON path. MQTT topics and JSON paths are sequences of path elements separated by forward slash characters. The first character should not be a slash. The path is converted to a DataHub point name by concatenating the default domain (see app.DefaultDomain), a colon character ( : ), and the path elements separated by dot characters. If a path element contains a dot, it will be converted to a slash in the point name. If no default domain is set then the first element of the topic will be used as the domain name, and the point name will be constructed from all subsequent path elements. If the first element in the topic name is app.DefaultDomain, it is removed from the resulting point name to avoid having it included twice.

string app.TopicFromPointName(pointName)  Constructs a topic name from a point name. The point name (pointName) should be fully qualified, including the domain: prefix. All dot characters in the point name will be converted to slash characters in the resulting topic name. If the point name contains a slash character, it will be converted to a dot in the topic name. If the domain name of the point is app.DefaultDomain then the domain name is omitted from the resulting topic. Otherwise, the domain name in the point will be treated like any other path element.

msg.ClientId  The client ID of the connection. In the DataHub broker this is the ID of the client that originated a message. In a DataHub client, this is the client ID from the connection configuration.

msg.IpAddress  In the DataHub broker, this is the IP address of the connected client. In the DataHub client, this is the hostname from the connection configuration.

msg.Username  In the DataHub broker, this is the user name that the client used to log in, or null if there is no username. In the DataHub client, this is the username from the connection configuration, or null if no username is configured.

Eu  A string defining the engineering units, such as m/s or kPa.

Description  A string describing the point.

EuHigh  A double containing the upper bound of the engineering unit range.

EuLow  A double containing the lower bound of the engineering unit range.

InstrumentHigh  A double containing the upper bound of the raw measurement range.

InstrumentLow  A double containing the lower bound of the raw measurement range.

ContactCloseLabel  A string containing the label to use for a Boolean value of true.

ContactOpenLabel  A string containing the label to use for a Boolean value of false.

Label  A string containing the label of the connection that originated the value. This could be nullor an empty string. .

Description  A string containing the description of the connection that originated the value. This could be nullor an empty string.

User  A string containing the name of the user credential associated with the connection. This could be nullor an empty string.

Host  A string containing the IP address or DNS name of the computer that originated an inbound connection, or the IP address or DNS name of the computer to which an outbound connection is targeted. This could be nullor an empty string.

Type  A string containing the type of connection that originated this value. This could be nullor an empty string.

RefCount  An integer that approximately indicates the number of points that share this origin. This is primarily used internally, and is not expected to be exact.