| # | Name | Location | Type | Details | Index | Description |
|---|---|---|---|---|---|---|
| .01 | name(+) | 0;1 | FREE TEXT | B | This 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. | |
| .02 | message type | 0;2 | FREE TEXT | This field contains the name of a unique XML message type, e.g. gov.va.med.foundations.rpc.request. 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. | ||
| .03 | category | 0;3 | SET OF CODES | 1:REQUEST 2:RESPONSE 9:OTHER | 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. | |
| .04 | require authentication? | 0;4 | BOOLEAN | 0:NO 1:YES | 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. | |
| .05 | request handler | 0;5 | FREE TEXT | This 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. | ||
| .06 | cache request handler info | 0;6 | BOOLEAN | 0:NO 1:YES | AS | This 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. |
| .07 | proprietary indicator | 0;7 | FREE TEXT | D | This 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