IPSentry Add-In SDK
GraphItemsXML Property
Add-In SDK Index | Top
sep

Return a XML document fragment of type string to IPSentry for logging into the graphing database.   See below for the format of this collection.

Parameters
None - Read Only

Returns
(XML Document Fragment of type String)

Each element in the GraphItemValues element contains an XML element representation of a Graph Item Values in the following format for use by IPSentry in logging graphing detail information for inclusion on the IPSentry graphing charts.

This allows for your add-in component to return multiple values unique to your add-in component results for named access in the IPSentry Graphing Tool.

Return XML Fragment as string in the following format:
<GraphItemValues>
    < gValue Name=”” Value=”” Scale=”” Desc=”” State=”” IsGlobal=”0” />
    < gValue Name=”” Value=”” Scale=”” Desc=”” State=”” IsGlobal=”0” />
    ...
</GraphItemValues>


Where:

Scale
The graphing scale representation of the numeric value represented in the ENGRAPH_VALUE_SCALE enumeration.

Name
A descriptive textual name for this value associated with this add-in. e.g. “Temperature” The name should be unique for each item.

Desc
A description for this graph value item.

Value
A numeric value to store in the graphing database. Either integer or float.

State
The state of the add-in result as 0=fail, 1=success

IsGlobal
Reserved for future use, set to “0”

Visual Basic
Public Property Get GraphItemsXML() as String
   
End Property

VB.NET
Public ReadOnly Property GraphItemsXML() as String

End Property
 

sep

© 2011 by RGE, Inc.  (All Rights Reserved)
Unauthorized use or reproduction is strictly prohibited
IPSentry® is a registered trademark of RGE, Inc.

https://ipsentry.com
 Support@ipsentry.com