Real Time Information Director User Documentation

RTID Message Format and Programmatic Interfaces
Hewlett-Packard Company 2 529618 - 002
This document describes the message format and programmatic interfaces for access to
the Real Time Information Director (also known as RTID or Director).
Director XML Message Format
You don’t have to write a client for access to the Director. You can use a JMS client,
such as the JMS adapter of an Integration Server, to submit and retrieve XML documents.
To be processed correctly by the Director, the format of an XML document must match
that of a document definition present in the configuration. For information about writing
document definitions consistent with the message formats of your solution, see the RTID
Metadata Language module.
Documents processed by the Director can be insert or update documents or queries.
Native Document Format
An insert or update document can be either an SAP IDoc in XML format, or what we
call a native XML document. What makes a native XML document native is that it’s
structure (the naming and hierarchy of segments and elements) matches the structure (the
naming and hierarchy of tables and columns) in the data store.
The format of an SAP IDoc in XML format is exhaustively described in documentation
available from SAP. These pages discuss the format of a native XML document.
The Director can receive native documents as input or deliver them to clients in response
to queries or subscriptions.
When the Director receives a native document for insertion into the data store, it inserts
the data, then returns a response that contains a query document for use in retrieving the
same data. The query document is distinguished by the suffix _R in its name. Thus,
whenever an inbound PersonalData document is processed, the Director returns an XML
response of type PersonalData_R, allowing the PersonalData document to be retrieved at
a later time. The response can also include error messages, as described in “Director
Exceptions,” and statistical information, as described in “Director Statistics.”
When a document needs to be assembled for delivery to client, the Director generates the
XML tags automatically:
• The top tag is the name of the document, as specified in the document definition.
• All tags below this are the names of tables or fields in the database.
• Data elements are delimited by tags with the name of the field.