Enterprise RTView® 
User Guide


Object Descriptions
Enterprise RTView objects are categorized in the Object Palette according to the appearance and behavior of each type of object. This section describes how to work with each type of object and assumes you have already reviewed the following: Add/Edit Objects, Object Properties and the Attach To Data section for your data source.

To view sample displays with tutorials, product features, and data source specific examples go to the demos directory, run the data simulators that apply to your Enterprise RTView data sources and start the Display Builder. Open the file alldisplays.rtv and double-click on your selection. NOTE: To learn how to start the Display Builder and run the data simulators refer to the Quick Start Example.
 
Graphs The Object Palette features several types of graph objects -- trend, bar, pie, radar, and XY graphs-- that are useful for comparing data. Trend graphs are used to display a single variable per trace over time. Bar, pie, radar, and XY graphs are designed to display information returned by a tabular element in your data attachment. See the Graphs section for more details on working with these objects.
Tables The Object Palette features three table objects--standard table, rotated table and object grid--that offer the ability to display large amounts of data. See the Tables section for more details on working with these objects.
General The General tab contains flexible objects that can be used to display data and images in addition to executing commands either manually or based on thresholds. To display values on these objects, attach the value property to numeric data or the valueString property to text data, and the label property to text data.

General objects that feature the image property can be customized to display your image (.gif, .jpg or .png) file. Click in Property Value field and select the name of the image file from the drop down menu. The drop down menu contains the names of image files located in the current directory, as well as image files located in first level of subdirectories. If an image is not listed, enter the name (including relative path) of the file. To scale your image to the size of the object, check the imageScaleFlag. The visFlag property controls the visibility of the object. The transparencyPercent property controls the transparency of the object.

The sample display file general_objects.rtv (located in demos/tutorials) features information on working with objects from the General tab.


Threshold Objects
Objects labeled Range Dynamic and Discrete Dynamic on the General Tab support threshold functionality, allowing you to change the image and color of the object as well as execute a threshold command from the object based on the current value of the value property.  Both the range dynamic and the discrete dynamic objects have the thresholding functionality turned off by default. In the descriptions below, the object's value is the current value of the value property.

Range Dynamic Range dynamic objects allow you to setup your threshold so that if the object's value is within a range of numbers, the threshold functionality executes. To enable the high alarm threshold, check the valueHighAlarmEnabledFlag. This will enable several related properties. When the object's value is greater than or equal to the valueHighAlarm property, the background of the object will change to the valueHighAlarmColor, the bitmap on the image will change to the valueHighAlarmImage and the valueHighAlarmCommand will be executed. To enable the high warning threshold, check the valueHighWarningEnabledFlag. When the object's value is greater than or equal to the valueHighWarning, but less than the valueHighAlarm, the background of the object will change to the valueHighWarningColor, the bitmap on the image will change to the valueHighWarningImage and the valueHighWarningCommand will be executed. The low alarm and low warning threshold properties work the same way, but activate when the object's value is less than or equal to the valueLowAlarm or valueLowWarning properties.

For both the discrete dynamic and range dynamic objects, threshold commands will only execute if the number of seconds specified in the valueCommandTimeout has elapsed since the previous threshold command was executed and the value has changed to another threshold.  For example, if the high warning threshold range is between 40 and 50, when object's value enters this range, the valueHighWarningCommand will be executed. The valueHighWarningCommand will not be executed again until the object's value leaves the high warning threshold range and then re-enters it. If this occurs in less time than is specified in the valueCommandTimeout property, it will not be executed until that time elapses. If the valueCommandTimeout is set to 0, the internal default, 5 seconds, is used.

Discrete Dynamic Discrete dynamic objects are similar to range dynamic objects, except that the threshold functionality is executed when the object's value equals the threshold value instead of when it is within the range of threshold values. To enable the high alert threshold, check the valueHighAlertEnabledFlag. When the value property equals the valueHighAlert, the background of the object will change to the valueHighAlertColor, the bitmap on the image will change to the valueHighAlertImage and the valueHighAlertCommand will be executed. To enable the medium alert threshold, check the valueMediumAlertEnabledFlag. When the value property equals the valueMediumAlert, the background of the object will change to the valueMediumAlertColor, the bitmap on the image will change to the valueMediumAlertImage and the valueMediumAlertCommand will be executed. The low alert threshold property works the same way, but activates when the object's value is less than or equal to the valueLowAlert property.

For both the discrete dynamic and range dynamic objects, threshold commands will only execute if the number of seconds specified in the valueCommandTimeout has elapsed since the previous threshold command was executed and the value has changed to another threshold.  For example, if the high warning threshold range is between 40 and 50, when object's value enters this range, the valueHighWarningCommand will be executed. The valueHighWarningCommand will not be executed again until the object's value leaves the high warning threshold range and then re-enters it. If this occurs in less time than is specified in the valueCommandTimeout property, it will not be executed until that time elapses. If the valueCommandTimeout is set to 0, the internal default, 5 seconds, is used.

Labels The Labels tab includes several types of labels. All of the labels have at least one of the following properties: value, valueString and label.  The value property is used to display numeric data from a data attachment or static value. Some of the label objects which display numeric data also contain scales that display this value, some change color according to this value. The valueString and label properties are used to display text from a data attachment or static value. The visFlag property controls the visibility of the object. The transparencyPercent property controls the transparency of the object.
Meters The Meters tab includes several meters which are useful for displaying data that falls within a known range. You can control the range of data displayed in the meter by setting the valueMax and valueMin properties. The value property should be attached to your data as this property controls the value displayed by the meter. The visFlag property controls the visibility of the object. The transparencyPercent property controls the transparency of the object.
Scales The Scales tab includes several scale objects which are useful for displaying data that falls within a known range. You can control the range of data displayed in the scale by setting the valueMax and valueMin properties. The value property should be attached to your data as this property controls the value displayed in the scale. All of the scales, except the pie scale, support a variety of axis styles and can be oriented vertically or horizontally. See the Scales section for more details on working with these objects.
Indicators The Indicators tab features objects useful for displaying discrete alert information. Attach your data to the valueAlert and status properties to display your alerts. Some of these objects change color according to the value being displayed and some will toggle visibility. The last object on the tab displays aggregate alert information. Attach your data to valueTable and the top half of the object will display the color for the highest alert from the data attachment and the lower half will display the relative percents of each alert level from the data attachment. The visFlag property controls the visibility of the object. The transparencyPercent property controls the transparency of the object.
Controls The Controls tab features objects that allow you to issue action commands and update variables that may be used to control other objects in the display. The visFlag property controls the visibility of the object. See the Controls section for more details on working with these objects.
Links The Links tab features three link objects. The Direct link draws a straight line between the objects it connects. The Orthogonal link draws a line at right angles between the objects it connects. The Direct Offset link attaches to the object at a right angle, but draws a diagonal line for the remainder of the link. Once a link is in your display, you may switch between the different types of links by setting the linkPathType property.

The visFlag property controls the visibility of the object. The transparencyPercent property controls the transparency of the object. The properties arrow1VisFlag (source) and arrow2VisFlag (target) control the visibility of source and target arrows on the link. Use linkSize to control the thickness of the link. If you are using a Direct link, selecting the connectEdgeFlag will attach the link to the center of the side closest to the other object (instead of connecting to the center of the object). Orthogonal and Direct Offset links always attach to the center of the side closest to the other object, so the connectEdgeFlag does not affect these links.

If you are using a Direct link, selecting the connectEdgeFlag will attach the link to the center of side closest to other object (instead of connecting to the center of the object). By default, Orthogonal and Direct Offset links attach to the center of the side closest to the other object.

Attach your data to the value property. To display the value of the link, select the iconVisFlag. When iconVisFlag is selected, use iconBgVisFlag to control the visibility of the background rectangle.

Set valueAlertMode property to Discrete Alerts or Range Alerts to enable several additional alert and alarm properties. When set to Discrete Alerts the color of the link will change when the value equals the discrete alarm value, i.e., valueHighAlert, valueLowAlert, valueNoAlert. When the valueAlertMode property is set to Range Alerts the color of the link will change when the value property is greater than the valueHighAlarm or valueHighWarning properties or less than the valueLowAlarm or valueLowWarning properties. Set valueAlertMode to No Alerts to disable all alert and alarm properties.

Composite The Composite tab features some pre-configured composite objects. The composite object allows you to show a display (.rtv) file within an object. This is useful for creating groups of objects that you want to use multiple times, either directly in your display, or in an object grid. See the Composite page for more information.
Fx Graphs The Fx Graphs tab features our Adobe® Flash graphs that have been designed specifically for use in the Thin Client deployment. These graphs are similar to other objects featured in the Graphs palette, but support additional interactivity in the Thin Client deployment. See the Fx Graphs section for details.
 


 
Enterprise RTView contains components licensed under the Apache License Version 2.0.

 

Treemap Algorithms v1.0  is used without modifications and licensed by MPL Version 1.1. Copyright © 2001 University of Maryland, College Park, MD

 

Datejs is licensed under MIT. Copyright © Coolite Inc.

 

JCalendar 1.3.2 is licensed under LGPL. Copyright © Kai Toedter.

 

jQuery is licensed under MIT. Copyright © John Resig,

 
JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only. 

 
SL, SL-GMS, GMS, Enterprise RTView, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2009 Sherrill-Lubinski Corporation. All Rights Reserved.