Real Time Information Director User Documentation

RTID Extensibility
Hewlett-Packard Company 8 529618 - 001
• Analyze the information to be captured.
• Update your data model to hold this additional information.
• Determine if the inbound documents are delserted or upserted. This step is the
same as for a native document.
• Understand the mappings needed to store the information in the data store.
Basically, you need identify which elements in the document will be mapped to
which columns in the database.
Creating IDoc Metadata
Once you have the mapping information, follow these steps to create your metadata:
1. Create a new Java class in the package com.hp.rtsc.documents or a package of
your own. Your document definition must extend the BaseDocumentDefinition
class. It is conventional, but not required, to name the class after the IDoc name.
For example, if you are creating metadata for ORDERS05 IDoc, you name the
Java file “Orders05.java”. The call to the superclass constructor may specify an
UPSERT, as in
super(documentRecord, idocSegment, "UPSERT");
In most cases, no two document types have the same top-level tag. The one
exception to this rule is the case of variant documents, described in “Adding
Alternate Mappings for an IDoc,” later in this manual.
2. Using syntax described in the RTID Metadata Language module, create the Java
objects for the mappings that you have analyzed.
a. Create the document format metadata objects (IDocSegment,
RecordSegment, FieldElement, etc.)
b. Create the content metadata objects (DocumentRecord, RelatedRecords,
SplitRecords)
c. Create the Links objects needed to describe fields used to join two tables.
See the RTID Metadata Language module for syntax examples.
3. Compile the Java source files, as described in “Compiling Metadata.”
4. Test on your workstation, and then deploy the updated Java class files to the
RTID runtime environment. See “Deploying Metadata” for deployment steps.
To test inbound IDocs, use the Dispatch or Disassemble standalone program. To
test outbound IDocs, use the Dispatch standalone program. To test both inbound
and outbound IDocs, use the Reselect or Dispatch program. See “Testing the
Metadata” for more details.