This file contains the message type definitions used by the VistALink request manager. Each message type is associated with a request handler. The request manager uses TCP/IP input stream information to lookup entries by 'message type' or 'proprietary format indicator'. Once an entry has been found, the request manager can execute the correct request handler methods for the incoming request stream. Information contained in the entries of this file allow the request manager to dynamically determine which request handler to load and execute.
.01name(+)0;1FREE TEXTBThis field contains a unique and keyed human readable name for the message type. It is also recommended that the name be prefixed with namespace characters.
.02message type0;2FREE TEXTThis field contains the name of a unique XML message type, e.g. This field is a keyed field and is used by the VistALink request manager during SAX parsing to look up the correct request handler for an incoming request.
.03category0;3SET OF CODES1:REQUEST
This field allows for the categorization of the message type. The field is not currently used in business logic and exists to allow for filtering and sorting during reporting. Currently, there are only two categories: request and response. 'Other' is also available but is not used at this time.
.04require authentication?0;4BOOLEAN0:NO
This field indicates whether or not a request of the message type requires the user to be authenticated by VistALink security before the request handler for the type can be executed. System and security message types do not need authentication since they involve processing at a higher level like heartbeat messages and messages establishing authentication. On the other hand, RPC-type messages would require authentication before the RPC request handler is executed.
.05request handler0;5FREE TEXTThis field contains the name of the M routine that implements the request handler interface methods (tags). Currently, those methods are the following: CALLBACK(CB) :: Logic that sets the SAX callbacks for the message type in CB parameter. These callbacks are executed during the SAX XML parsing. This method is required. READER(XOBUF,XOBDATA) :: Stream reader logic called when the incoming request is in proprietary format. XOBUF :: characters already read from stream XOBDATA :: where to store parsed request information or reference to such information. This method is optional. REQHDLR(XOBDATA) :: Logic called to process request information stored in XOBDATA after XML parsing or proprietary parsing has completed. This method is required.
.06cache request handler info0;6BOOLEAN0:NO
ASThis field indicates whether runtime information for the message type should be cached as part of the initial connection logic of the request manager. Caching -- storing in a local array -- only the information needed for request handling can benefit performance for those message types that are executed often, like RPC requests.
.07proprietary indicator0;7FREE TEXTDThis unique valued field is used during the processing of the first read of a new request stream. If this proprietary indicator is present then the READER method of the request handler routine is called. No SAX XML parsing is performed if this READER method is executed. See also: REQUEST HANDLER field.

Not Referenced