The msghma.dtd file defines the grammar for all the constructs used in an microagent XML configuration file. With this file included, the XML configuration file can be syntax checked using any validating XML parser.
The top level element, TIBHAWK_AMI describes transport parameters and tracing attributes that can applied to all microagents. Some of the attributes can be redefined for an individual method in the
method element.
You can specify different transport parameters for each method as attributes of the
method element. The attributes of the
method element take precedence over those specified by the
microagent or
TIBHAWK_AMI elements.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
IMPLIED. Can be used to identify the version of this XML file. It must be in the form of <major>.<minor>.<update>, for example, 1.1.0.
|
ami_rvd_service ami_rvd_network ami_rvd_daemon
|
|
IMPLIED. These attributes together configure the TIBCO Rendezvous parameters for creating an TIBCO Rendezvous transport for the communication with the TIBCO Hawk agent.
These attributes are maintained for backward compatibility only and is not used.
|
|
|
|
|
|
IMPLIED. These attributes together configure the TIBCO Rendezvous parameters for creating a TIBCO Rendezvous transport.
|
|
|
|
These attributes together configure the TIBCO EMS parameters for creating a TIBCO EMS transport.
|
|
|
|
When specifying values for attributes ssl_verify_hostname and ssl_verify_host, valid values are enabled and disabled.
When specifying values for attributes for ssl_trace and ssl_debug_trace, valid values are true and false.
|
|
|
|
IMPLIED. These attributes together form an RVCM (TIBCO Rendezvous Certified Message) transport. All methods in this microagent that use RVCM will use this RVCM transport.
cmName is the RVCM reusable name which represents a persistent correspondent.
If cmLedgerName is specified, it must be a valid file name. The cmLedgerName attribute is ignored if cmName is not specified.
|
|
|
|
IMPLIED. One of: ERROR, WARN or INFO. Specifies the lowest level of TIBCO Rendezvous advisory messages to be tracked by the microagent.
For example, if WARN is specified, then all WARN or ERROR advisory messages are tracked by this microagent.
The default value WARN. If an advisory message not tracked by the microagent is received, it will be sent to the microagent standard output if of class WARN or ERROR and discarded if of class INFO.
|
|
|
|
IMPLIED. Either true or false. Specifies whether a tracked advisory message will be sent to the TIBCO HAWK Agent as an unsolicited message.
The default is false, which means tracked advisory messages are logged to the adapter's log file.
|
|
|
|
|
|
|
|
IMPLIED. These attributes together define TIBCO Rendezvous fault tolerance parameters. The default values are:
These attributes are maintained for backward compatibility only and are not used.
|
|
|
|
IMPLIED. These attributes together specify the tracing parameters. If not defined, tracing is sent to stdout.
traceFileMaxNumber. Maximum number of roll over trace files to be maintained.
|
If a method has parameters, the method must have at least one input or constant parameter. If a method has a return value, it must have at least one output parameter.
|
|
|
|
|
|
|
|
|
|
|
IMPLIED. Help text describing the method. Each help attribute is paired with a name attribute. If not defined, the name attribute value is used as the help text.
|
|
|
|
IMPLIED. If a method returns more than one row of information, the index attribute must be specified with the name of the output parameter which can uniquely identify each row.
If multiple output parameters are required to uniquely identify a row (that is, a composite index), the index attribute must be specified with parameter names separated by commas.
|
|
|
|
IMPLIED. Specifies the subject to subscribe or to publish. For a subscription subject, the subject name segments may contain "*", and the last segment may be ">".
The attribute is required if the first input parameter is not named Subject or if the method publishes RVCM messages.
|
|
|
|
IMPLIED. The timeout attribute is meaningful (and required) only for RPC methods. If the timeout interval expires and no reply is received, the first return timeout parameter is set to true.
Note that the thread executing the RPC is blocked while waiting for the reply. If a microagent expects multiple simultaneous RPC calls, the maxThreads attribute for the microagent must be adjusted higher accordingly.
|
|
|
|
IMPLIED The heartbeatInterval attribute (in seconds) is meaningful only for publisher methods. If this heartbeatInterval attribute exists, in additional to the normal behavior, at every heartbeat interval, a message is published. Note that this kind of method can not have inputParameters; only constantParameter's can be used.
|
|
|
|
For subscriber and RPC methods (with handlerType SU and RPC respectively) the specified fields must have a one to one correspondence with the method’s return (output) parameters.
For publisher methods (with handlerType P and RPC respectively), the message publish subject and all fields must be specified in the message.
|
|
|
|
IMPLIED. If set to true, the method is an RVCM publisher or subscriber. If not specified, RVCM is not used.
|
|
|
|
IMPLIED. Only meaningful if the useCM attribute is set to true and the method handlerType value is P (is a publisher method). The cmListenerList attribute specifies a list of cmName names in the form:
|
For methods with handlerType SU,
P, or
RPC, if the first
inputParameter is named
Subject, it is used as the subject for subscription or publish. (Note: In this case, the
subject attribute for the method should not be defined.) This allows subjects to be specified at runtime.
For each parameter, you can define either one or more acceptable choices in a valueChoices element, or one or more legal choices in a
legalValueChoices element. If one of these elements is included in the parameter definition, users can select method argument values from a dropdown list in TIBCO Hawk Display. If neither is included, the corresponding method argument is represented by an editable field.
|
|
|
|
|
|
|
|
|
|
|
IMPLIED. Help text describing the input parameter. Each help attribute is paired with a name attribute. If not defined, the name attribute value is used as the help text.
|
|
|
|
BOOL, F32, F64, I8, I16, I32, I64, U8, U16, U32, STRING, XML
|
|
|
|
IMPLIED. Must be in the form of F1[.F2[...[.FN]]] where F1 - FN are the message field names in each nested level.
If the fieldName attribute is not specified, it is assumed to be the same as the name attribute.
|
|
|
|
IMPLIED. Specifies a pattern to convert string data to a desired form. The pattern syntax is based on the java.text.MessageFormat class specification.
For example, a pattern {0, number} KB could be used to convert a string 123 KB to a number 123 (not a string). If the pattern in the example is {0} KB, a string of 123 is extracted.
Note that only the first argument placeholder (that is, {0..} ) is used to extract the value for the parameter and others are ignored.
|
The valueChoices element defines some acceptable values for an
inputParameter element. These values are included in the dropdown list for method arguments in TIBCO Hawk Display. Users can also type a value not in the list. This element is optional, and can only be used if the
legalValueChoices element is not specified
The legalValueChoices element defines the only possible values that can be specified in an
inputParameter method. This element is optional, and can only be used if
valueChoices is not specified. Use this element to limit users to specific values, which are included in the dropdown list for method arguments in TIBCO Hawk Display. Users can only specify values included in the list.
Constant parameters are not exposed to the TIBCO Hawk Agent or TIBCO Hawk Display. Constant parameter values are passed to the msghma method internally. This type of parameters are used when some fixed constant values need to be passed to msghma methods.
For subscriber methods (with method handlerType SU or
DS), there are three special outputParameter names:
For RPC methods (with method handlerType RPC), there is a special
outputParameter with the name
Timeout and type
BOOL. It is required and must be the first
outputParameter. It is used to indicate whether a timeout has occurred while waiting for the reply.
