NetEx EFT213 Reference Manual Rel 5.4

Error Message FormattingNetEx/eFT messages consist of the following components:SEVERITYFACILITYCODETEXTA single character severity level indicator. Possible values are:IWEFInformationWarningErrorFatalThe facility or subsystem name generating the message. This will generally be some versionof the following:UAUAxxxSISIxxxMUXMUXxxxNETEXopsysNetEx/eFT host independent message.NetEx/eFT host dependent message where xxx represents the product numberof the host generating the error (e.g. EFT263, EFT213, etc.)NetEx/eFT Service Initiator (SI) host-independent message.NetEx/eFT Service Initiator (SI) host-dependent message.NetEx/eFT Multiplex Server (MUX) host-independent message.NetEx/eFT Multiplex Server (MUX) host-dependent message.A NETEX generated error.An operating system specific error where OpSys is replaced by the operatingsystem name generating the error.The unique error or message code.The single line message text describing the error code.The format of a message display is controlled by the OUTPUT command qualifier FORMAT. Specific componentsof a NetEx/eFT message are extracted using the string function msg() (described in the section on“String Functions”). The default message format can be displayed as:eFT> show output formateFT: FORmat ....... {msg("text")} ({msg("facility")}-{msg("code")}).With this format defined, a simple “Invalid command” error would generate the following:eFT> badcommandeFT: Invalid command ‘badcommand’ (UA-4708).The user can modify the message format simply by changing the value of the FORMAT qualifier of theOUTPUT command. The value can be any string so long as it includes some reference to string substitutionwhen it gets interpreted. That is when OUTPUT FORMAT is defined, it must disable string substitution usingthe {} syntax. An invalid FORMAT specification will result in NetEx/eFT returning the value to its original,default value. This is done to make sure error messages are properly displayed in the event that theywere inadvertently shut off.The following example modifies the error message format to print only the error severity, facility, and code.Note the use of {}eFT> set output format {} {msg("severity")}:{msg("facility")}-{msg("code")}With this message format, the same “Invalid command” error would generate the following display:eFT> badcommandeFT: W:UA-4708Page 102 Advanced Local User’s Guide REF-eFT213-R5.4-08