Note on usage
Function: Displaying openFT-Script requests
User group: FT user and FT administrator
Functional description
Outputs information about the status of a user's openFT-Script requests. You can also specify a ftscriptid in order to select a specific openFT-Script request.
Format
ftshws -h |
[ -csv]
[ -t]
[ -v]
[ -st=[W]|[R]|[T]|[F]|[I]|[C]|[X] ]
[ -u=<user ID> | @a ]
[<ftscriptid>]
Description
-h
Outputs the command syntax on screen. Any specifications after -h are ignored.
-csv
The information is output in CSV format. If you do not specify -csv then the information
is output in table format.
-t
The openFT-Script requests are displayed sorted on generation time, beginning with
the last request.
By default, the requests are displayed in alphabetical order.
-v
Diagnostic information is also output (verbose).
If -v is specified then, in the case of openFT-Script requests which terminate with an
error, the cause of the error is output in a second line after the tabular information.
In CSV format, the -v option is ignored.
-st=[W][R][T][F][I][C][X]
displays openFT-Script requests with the specified status, see Sta field below.
You can specify multiple statuses one after the other, e.g. -st=WRT.
-u=user ID | @a
User ID for which openFT-Script requests are output or under which the specified request is searched for.
Only administrators may specify a user ID or @a (all user IDs).
The default value is the calling party's user ID.
ftscriptid
Identification of the openFT-Script request. This is output if the openFT-Script request is started via an ftscript command.
You can use the wildcard symbols ? and * in der ftscriptid. This outputs all openFT-Script requests that match the wildcard pattern.
?
is interpreted as any single character.
*
is interpreted as any number of characters.
If you use wildcards, enclose the ftscriptid specification in single quotes so that the wildcard symbols are not interpreted by the shell.
By default, if you do not specify ftscriptid, all the user's openFT-Script requests are displayed.
Output in table format
The processing level of the openFT-Script requests is displayed in four columns:
User
User ID under which the request was started.
Ftscriptid
Unique identification of the request. The identification is returned by the ftscript command.
Sta
Indicates the processing status, where:
W (waiting) | The request has not yet been started. |
R (running) | The request has been started but has not yet been terminated. |
T (terminated) | The request has been terminated without errors. |
F (failure) | The request has been terminated with errors. |
I (interrupted) | The request was interrupted, e.g. due to a system crash. |
C (cancelled) | The request was cancelled with an ftcans command. |
X (cancelling) | The request is currently being cancelled due to an ftcans command. |
FtscriptFileName
Path name of the script file.
If the status F and the -v option are specified then the cause of the error is output in clear text in another column.