Note on usage
Function: Display monitoring values of openFT operation
User group: FT user and FT administrator
Functional description
The ftshwm command allows you to output the current monitoring values from openFT operation. In order to do this, the FT administrator must have activated monitoring (ftmodo -mon=n command) and the asynchronous openFT server must be running.
Format
ftshwm -h |
[ -ty ]
[ -raw ]
[ -po=<polling interval 1..600> [ -pnr=<polling number 1..3600> ]]
[ -csv ]
[ <name 1..12> [... <name(100) 1..12> ]| @a]
Description
-h
Displays the command syntax on the screen. Entries after the -h are ignored.
-ty
The types and scaling factors are to be output in place of the monitoring values and metadata.
The metadata type can be *TIME (timestamp) or *STRING (text output of the chosen selection).
A monitoring value can have one of the following types:
INT, BOOL or PERCENT (integer, on/off value or percentage). In the case of integer values, the scaling factor may be specified in brackets: INT(<scaling factor>).
The scaling factor of a monitoring value is only significant for output in CSV format. In this case, it is the number by which the value shown must be divided in order to obtain the real value.
-raw must not be specified at the same time.
-raw
Monitoring values are to be output as unedited raw data. This option is intended to be used in conjunction with external programs for further processing. The option must not be specified in conjunction with -ty. Monitoring values of the object Duration are not output.
If the specification is not used, the data is output in print-edited form.
The section “Description of the monitoring values” contains a table with notes that show what values are output when the -raw option is specified or is not specified and how the values are to be interpreted depending on this option.
-po=polling interval
Data is to be output initially after the specified polling interval in seconds has elapsed and then repeated at this interval.
If you also specify -pnr, you can limit the number of times the data is output. If you specify -po without -pnr, output is repeated an unlimited number of times.
If repeated output has been started with the -po option (with or without -pnr), it can be cancelled by an interrupt signal. Output is also cancelled in the event of an error, when the asynchronous openFT is terminated, or when monitoring is terminated.
Possible values: 1 through 600.
-po not specified
The monitoring values are output immediately and once only.
-pnr=polling number
-pnr specifies the number of times data is output. -pnr can only be specified in conjunction with -po.
Possible values: 1 through 3600.
-csv
The information is to be output in CSV format. First, the short names of the monitoring values are output in one row as the field names. This is followed by a row containing the monitoring values or their types and scaling factors as decimal numbers.
You can limit the scope of the output by specifying individual monitoring values that are significant for you.
name [name ...] | @a
The specified monitoring value or, if -ty is specified, the type and scaling factor associated with the named value is to be output.
name must be one of the short names of the monitoring values as they appear in the CSV header. You can specify up to 100 names separated by blanks.
@a for name
All openFT monitoring values or the types and scaling factors of all openFT monitoring values are to be output.
name not specified
A predefined default set of monitoring values is output (see the section “Description of the monitoring values”).