Real Time Information Director User Documentation

RTID Metadata Language
Hewlett-Packard Company 13 529618-002
DocumentRecord
The DocumentRecord object identifies the parent record of the document. This is the
object you’ll pass to the superclass constructor.
The DocumentRecord has four possible parameters:
• The name of the primary table of the document (tableName). You must specify
either this parameter or an enriched record, as described shortly.
• An array of related records. Use RelatedRecords[] to specify multiple records or
RelatedRecords to specify just one related record. If you omit this parameter, the
document populates only the primary record.
• An enrichment. Enrichments are ways of enhancing inbound or outbound data.
Options are discussed under the heading “Enriching the Data,” later in this
document. This parameter is optional.
• An enriched record. You can specify this parameter instead of a table name and
an enrichment. An enriched record results from the application of an enrichment
to an existing record. For more information about enrichments and enriched
records, see “Enriching the Data,” later in this document.
The keys of the primary table determine, directly or indirectly, which records are related
to the document.
For DocumentRecord class constructors, see the Javadoc for DocumentRecord.
RequestRecord
In one circumstance, you don’t specifically define a DocumentRecord. This is when a
query response doesn’t just read back a previously inserted row but synthesizes
information from various locations or extracts information selectively from the database.
(If all a query does is read back a previously inserted row, you don’t need a separate
document definition for the query response.)
The RequestRecord class defines the top record to be returned by query. (RequestRecord
extends DocumentRecord and is used in place of DocumentRecord in this case.) In the
first parameter, you specify the keys to use to retrieve the requested information; the
query document itself must specify these values in a record called KEYS. In the second
parameter, you use the RelatedRecords class to describe the contents of the query
response.