umsgutil.exe

Command line interface for the Message API Utility.

umsgutil.exe/dnp=NetworkPath {/dst=Destination} /mid=MessageID /msg=MessageData {/asn=AssignmentFile}

Parameters

  • NetworkPath—network connector string that identifies a Uniface Router and, partially, the target application. This takes the form:

    { HostId }{+PortNumber} |UserName

    • HostId—host name or IP address where the Uniface Router is running. If omitted, the default is localhost ( the current machine). The format of HostID determines the TCP protocol version to be used. For more information, see Host Identification for TCP/IP and TLS.

    • PortNumber—port number on which the Uniface Router is listening. If omitted, the default value is 13001.

    • UserName—user name under which the target application is running

  • Destination—destination. The name of the target application and component in the form:

    SymbolicName:{InstanceName}

    • SymbolicName—application identifier of the target application under which it registered with the Uniface Router.

    • InstanceName—name of a component instance in that application

  • MessageID—message identifier for the message. It must contain at least one non-blank character. Trailing blanks are ignored. The maximum length of msgId is given in the table below.

  • MessageData—data of the message.

  • AssignmentFile—assignment file containing the TLS profiles to be used, and/or the use of IPv6.

Description

The umsgutil.exe executable is the command line interface to the Message API Utility. It uses the functionality provided by the following DLLs, which must be in the same location as umsgutil.exe itself:

  • ucall.dll
  • ulib.dll
  • urtl.dll
  • yrtl.dll

The message is sent to the Uniface Router using the same format as the postmessage Proc statement.

The umsgutil.exe) which is provided on MS Windows platforms in the Uniface bin directory. Normally, this program takes the command line arguments /dnp=Destination, /mid=MessageId and /msg=MessageData. For example: 

bin\umsgutil /dnp="TCP:hostname.domain.com+13001|TheUser||UST:COMPONENT" /mid=MsgIdTCP /msg="This mësságe was sent over TCP"

This syntax corresponds closely to the syntax used with postmessage ProcScript statement.

If you want to make use of TLS or IPv6, you must also specify the /asn=AssignmentFile parameter.

Note the selective use of double quotes to prevent the command interpreter from interpreting and breaking up the parameters.

For compatibility, umsgutil.exe also has the /dst= parameter. When you use this parameter, the last part of the Destination parameter, the SymbolicName:InstanceName, is specified separately with /dst and omitted from the /dnp parameter. The pipe ( | ) symbols that separate them are then also omitted. The previous example could then be run from the command line as follows:

bin\umsgutil /dnp="TCP:hostname.domain.com+13001|TheUser" /dst="UST:COMPONENT:" /mid=MsgIdTCP /msg="This mësságe was sent over TCP"

Related Topics