Attach
to RTVAgent Data
NOTE: The RTVAgent data
source may not be licensed in your RTView installation.
From the Object Properties
window you can access the Attach to RTVAgent Data dialog, which is used to
connect objects to tabular data sent from remote agent applications. The valueTable property of an
object, typically a
Cache object, will be attached to a data table received from the agent.
NOTE: The
AgentName column in that table should be specified in the
indexColumnNames property of the
Cache object.
|
 |
To bring up the Attach to
RTVAgent Data dialog, right-click on the Property Name from the Object Properties
window and select Attach to Data>RTVAgent. The Attach to RTVAgent Data dialog provides several drop down menus that
allow you to specify information. The
Agent Class drop down menu lists the
agent class names of all of agents that have connected to the RTVAgent adapter.
Drop down menus for Table Name, Column(s) and
Filter Column populate based on the selected agent Class. If the item you
require is not listed, type your selection into the field. For information on
enabling a connection,
see
Application Options.
NOTE: The Attach to RTVAgent Data dialog will
only display agents currently connected and publishing data.
Agent Class |
The
class name of the agent from which you
want content. Choose either a class name or RTViewDs.
You must enable a connection on the
RTVAgent Options tab of the Application
Options dialog. NOTE: Since multiple
agents can
have the same class name,
data attachments will receive information from all agents with the specified
Agent
Class and Table Name. |
Table Name |
Name of the table. NOTE: The agent assigns a name to
the table when it sends it to the RTVAgent data adapter. |
Column(s) |
Select which column(s) to display. To bring up the
Select Columns dialog,
click on the ellipse button in
the Column(s) field (or right-click in the Column(s) field and choose Select
Columns). The dialog should contain a list of Available Columns that
you can add to your table. |
Filter Rows |
Check box to indicate whether
or not to filter the
RTVAgent data. |
Filter Column |
Name of the column to use
as a filter. Multiple column names should be entered as a semicolon (;) delimited list (i.e.
col1;col2;col 3). If your column name contains a space or a semicolon, then the
entire name must be enclosed in single quotes. |
Filter Value |
Value that the Filter Column must equal.
Multiple filter values should be entered as a nested list, where values for a
given column are separated by commas within a semicolon (;) delimited list (i.e.
val1,val2;val3,val4;val5,val6). If your filter value contains a space or a
semicolon, then the entire value must be enclosed in single quotes.
When * is entered
as a filter field value, data for all values in the specified filter column
will be used to update the object property. When "*" is entered, only the
literal comparative value will be used. |
Data Server |
Select to read data through your configured Data
Server and not directly from the RTVAgent 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.
|
When an object property is
attached to data, the Property Name and Value in the Object Properties
window will be displayed in green. This indicates that editing this value
from the Object Properties window is no longer possible. Once a property has
been attached to data, it receives continuous updates.
To remove the
data attachment, and resume editing capability 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 entered into the dialog is validated against
data received from agents.
The following describes the significance of
the Attach to RTVAgent Data validation colors:
|
Blue |
Unknown |
Cannot validate entry. |
|
White |
Valid state |
Entry is valid. |
|
Red |
Invalid state |
Incomplete or invalid
entry. |
*If an agent is validated as Unknown,
RTView will attempt to read it when you click OK or Apply.
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
name such as $table is used
instead of a specific table name. Later when the display is running, this
generic value is defined by the actual name of a specific table, such as
SalesTable. 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.
RTViewDs
There is a predefined agent Class named
RTViewDs that defines a single table named Agents. The
RTViewDs.agents table contains a row for each agent that is currently connected.
The columns in the table are as follows:
RTViewDs |
Agents (RTViewDs.agents) |
Column Available |
Description |
|
AgentName |
Name of agent. |
AgentClass |
Class name of
agent. |
LastReceiveTime |
Time that a data
table was most recently received from the agent. |
TotalRowsReceived |
Cumulative count of table
rows received from the agent. |
ClientID |
Unique number
assigned to the agent connection. |
Select Table Columns
From the Attach to RTVAgent Data dialog
you can specify which table columns to display and in what order they will
appear. In order to populate the listing of available columns, you must
first select a valid agent Class source and Table Name.
To bring up the Select Columns dialog,
click on the ellipse button in
the Column(s) field (or right-click in the Column(s) field and choose Select
Columns). The dialog should contain a list of Available Columns that
you can add to your table.
To add a column, 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 columns 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 columns are valid. However, if even one column
selected is invalid, the Column(s) field in the Attach to RTVAgent Data dialog
will register as an invalid entry. NOTE: Invalid columns will not update.
If no data is available for a table
row within a selected column, the table cell will display one the following
values: N/A, false, 0, or 0.0.
The following describes the Attach
to RTVAgent 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. |
|