Attach
to TIBCO Rendezvous Data
NOTE: The TIBCO Rendezvous data
source may not be licensed in your RTView installation.
From the Object Properties window you
can access the Attach to TIBCO Rendezvous Data dialog, which is used to
register an RTView object as a listener for a TIBCO Rendezvous
message. In the Attach to TIBCO Rendezvous Data dialog, enter the name
of a message subject and specify which message field should be used to
update an object property. Once an object property has been attached to
a message, it receives continuous updates. It is also possible to set up
a filter based on a particular field in the message.
For example, a message with the subject
orders.STATUS.London has two possible message fields: PERCENTCOMPLETED
and PLANT. The first field, PERCENTCOMPLETED, tracks the status of an order.
The second field, PLANT, indicates which London plant (L1 or L2) the message
is describing.
Setting the Message Field to PERCENTCOMPLETED
will set the attached object to indicate the real-time status of an order.
Without a filter, the attached object would receive simultaneous updates
from both London plants. To receive updates for a specific plant, you would
set up a filter for the PLANT field and enter a Filter Field Value of either
L1 or L2 to indicate which London plant will update the attached object.
In the RVALIAS.ini file, you
may create an alias for (top level
or nested) messages, message fields and XML data embedded in messages.
Once RVALIAS.ini
is saved and RTView is restarted, you
will be able to access these aliases from the
Message
Subject drop down menu
To bring up the Attach to TIBCO Rendezvous
Data dialog, right-click on the Property Name from the Object Properties
window and select Attach to Data>RV. The Attach to TIBCO Rendezvous
Data dialog provides several drop down menus that allow you to specify
information regarding a message. If the drop down menu does not contain
the item you require, type your selection into the text field.
Message Subject |
Message subject
or alias name. Enter a specific subject name or use * as a wild card character.
For example
*.*.* or orders.STATUS.*. |
Message Field |
Message field
chosen to update the attached object. |
Filter |
Check box to
indicate whether or not to filter the message. |
Filter Field
Name |
Name of the
message field to use as a filter. |
Filter Field
Value |
Value that
the filter field must equal. |
Data Server |
Select to read data through your configured Data
Server and not directly from the TIBCO Rendezvous data source.
Default - Select the default Data
Server you configured in Application
Options>Data Server.
None - Bypass data being redirected
through the specified data server(s) for this attachment and instead attach
directly to the data source.
Named Data Servers - Select a
Named Data Server
that you configured in Application Options>Data Server.
Multi-Server Attachment - To configure
multiple data servers, enter a semicolon (;) delimited list containing two or
more
Named Data Servers (e.g. ds101;ds102). Each name specified must
correspond with a
Named Data Server
that you configured in Application Options>Data Server. It is also possible to
specify __default and __none (e.g. __default;ds101;ds102).
NOTE: The values __default and __none begin with two
underscore characters.
Alternatively, a value of * can be
entered to specify all data servers, including __default and __none.
When multiple data servers are specified, the
data attachment will be directed to each data server in the list. For tabular
data attachments, a column named DataServerName will be added as the
first column of the table and contain the name of the server from which the
data was received.
A multi-server attachment will receive data
independently from each of the servers it specifies, so in most cases it will
be necessary to combine the tables received into a single table. This can be
accomplished in two ways:
1) The multi-server attachment can be
applied to a local cache that has the DataServerName column specified
as an index column. The current table of that cache will contain the
combination of the tables received from all servers. NOTE: It may also be
necessary to configure cache row expiration settings to remove defunct rows.
2) The multi-server attachment can be applied as the Table argument of the
RTView function named
Combine
Multi-Server Tables.
|
A Message Repository file can be used
to populate the initial values of drop down menus for all fields. See
Application
Options for information on how to create a Message Repository file.
Otherwise, drop down menus populate based on message subjects added from
the Application Options dialog or those typed directly into the Attach
to TIBCO Rendezvous Data dialog. Message subjects will not be added to
drop down menus until at least one TIBCO Rendezvous message with that subject
has been received by RTView.
When an object property has
been attached to data, the Property Name and Value in the Object Properties
window will be displayed in green. This indicates that editing values from
the Object Properties window is no longer possible. To remove the data
attachment and resume editing capabilities in the Object Properties window,
right-click on the Property Name and select Detach from Data. You
will recognize that an object property has been detached from the data
source when the Property Name and Value are no longer green.
Validation Colors
Fields in the dialog change colors
according to the information entered. These colors indicate whether or
not information is valid. Information is validated against the Message
Repository file, message subjects added from Application Options dialog,
or those typed directly into the Attach to TIBCO Rendezvous Data dialog.
Message subjects will not be validated until at least one TIBCO Rendezvous
message with that subject has been received by RTView.
NOTE: Some subjects using wild card characters are not validated at this
time.
The following describes the significance
of the validation colors:
|
Blue |
Unknown |
Entry is not
recognized. When a Subject is unknown, the Message Field, Filter Field
Name, and Filter Field Value are also unknown. |
|
White |
Valid state |
Entry is valid. |
|
Red |
Invalid state |
Entry is not
valid. |
Substitutions
The Substitutions feature
allows you to build open-ended displays in which data attachments depend
on values defined at the time the display is run. A generic Message Subject
such as $subject is used instead of a specific message. Later when the
display is running, this generic value is defined by the actual name of
a specific message, such as orders.STATUS.London. In this way, a single
display can be reused to show data from a number of different sources.
For more information on creating displays using substitution values, see
Substitutions.
Special Values
The following special values can be
entered for message and filter fields:
Message Field |
* |
When * is entered
as a message field, values from all message fields will be used to update
the object property. This is only allowed
for objects which display tabular data. |
Filter
Field Value |
* |
When * is entered
as a filter field value, data for all values in the specified filter field
will be used to update the object property. When "*" is entered, only the
literal comparative value will be used. These
are only allowed for objects which display tabular data. |
RTViewDs
Subject Fields
RTViewDs subject fields contain TIBCO
Rendezvous monitoring information. A sample display file using RTViewDs fields (rv_rvtrace_subject_tables.rtv)
can be found in your installation directory under demos\rvmonitor.
Several monitoring
metrics tables are available in the Subject field. If these do not appear in the
Subject field, do the following. In the
Display Builder, select
Tools>Options to open the Application
Options dialog.
Select
the TIBCO Rendezvous Monitoring tab, and enable Show Monitor Tables in
Data Dialog by selecting the checkbox.
RTViewDs.HostStatusTotal |
The latest data
for all hosts obtained from the TIBCO Rendezvous information message: _RV.INFO.SYSTEM.HOST.STATUS.
NOTE: If selected, the
Disable Cache Data option
will apply to this table. |
RTViewDs.HostStatusCurrent |
The same as
RTViewDs.HostStatusTotal however each numeric value is replaced with a delta
from the previous message. NOTE: If selected,
the Disable Cache Data
option will apply to this table. |
RTViewDs.HostStatusHistory |
A running
history of all the RTViewDs.HostStatusCurrent rows however it only sets a property on an
object when referenced for the first time. Used for trend graph history. |
RTViewDs.HostStatusHistory2 |
The same as
RTViewDs.HostStatusHistory, however it sets a property on an object every time a
new row is added. Used in history table. |
RTViewDs.ConfigServices |
The output from
tibrvcfg getServices method. To attach to this table, specify a host
using the filter in your data attachment. The Filter Field Name must be an HTTP
URL and the Filter Field Value must be the HTTP URL from which the host will get
configuration information.
NOTE: You must set the TIBRV_HOME
environment variable to your Rendezvous
installation directory (i.e. same as RV_ROOT
variable) in order to attach to this table. |
RTViewDs.ConfigClientTransports |
The output from
tibrvcfg getClientTransports method.To attach to this table, specify a host using the filter in your data attachment. The
Filter Field Name must
be an HTTP URL and the Filter Field Value must be the HTTP URL from which the host
will get configuration information.
NOTE: You must set the TIBRV_HOME
environment variable to your Rendezvous
installation directory (i.e. same as RV_ROOT
variable) in order to attach to this table. |
RTViewDs.MultiCast* |
The six tables
showing all output from
rvtrace: PacketSource, PacketDest, PacketTotal
SubjectSource, SubjectDest, SubjectTotal |
Message Fields
RTViewDs message fields contain message
tracking information. A sample display file using RTViewDs fields (rv_msgmetrics.rtv)
can be found in your installation directory under demos\dstutorial.
Several RTViewDs message fields are
available:
RTViewDS_count |
Number of messages
received for data attachment. |
RTViewDS_size |
Size
of last message received for data attachment. |
RTViewDS_subjectcount |
Number
of message subjects received for data attachment. |
RTViewDS_time |
Time
of last message received for data attachment. |
Select Columns
From the Attach to Data dialog you
can specify which message fields to display as columns in a table and in
what order they will appear. In order to populate the listing of available
message fields, you must first select a valid subject.
To bring up the Select Columns dialog,
click on the ellipse button in
the Message Field field (or right-click in the Message Field field and
click Select Columns). The dialog should contain a list of Available
Columns that you can add to your table.
To add a field, select an item from
the Available Columns list and click on the Add button. If the item you
require is not listed, type your selection into the Enter Column Name field.
Click the Remove button to delete an item previously added to the Selected
Columns list. You can control the order of fields in a table by arranging
the items in the Selected Columns list with the Move Up and Move Down buttons.
Validation colors
indicate whether selected message fields are valid. However, if even one
field selected is invalid the Message Field field in the Attach to TIBCO
Rendezvous Data dialog will register as an invalid entry.
If no data is available for a table
row within a selected column, the table cell will display one of the following
values: N/A, false, 0, or 0.0.
The following describes Attach to TIBCO
Rendezvous Data dialog commands:
Command |
Description |
OK |
Applies values and closes
the dialog. |
Apply |
Applies values without
closing the dialog. |
Reset |
Resets all fields to last
values applied. |
Clear |
Clears all fields. Detaches
object from data source (once Apply or OK is selected). |
Cancel |
Closes the dialog with
last values applied. |
|