Note on usage
Function: Starting an openFT-Script request
User group: FT user
Functional description
The ftscript command checks the specified script file and executes the statements it includes. The script file must contain a valid XML document which corresponds to the schema for the openFT-Script interface. It must also be possible to read the file using the caller's ID. The maximum number of users who may be owner of openFT-Script requests is 1024. This includes requests that are terminated but not yet deleted.
If errors occur during verification then the script file is not started and the errors are output at stderr.
If the script file starts correctly then the following message is output at stderr:
ftscript: started successfully. Id: ftscript id
Information about the openFT-Script request is stored in the internal openFT user memory during execution and through to expiry of the retention period. As a consequence, users can view the output ftscript id in order to obtain information about the status and success of the operation.
ftscript is restartable, i.e. the processing of the openFT-Script request is ensured even after a system failure.
Format
ftscript -h |
[ -t ]
<Ftscript file name>
Description
-h
Outputs the command syntax on screen. Any specifications after -h are ignored.
-t
Diagnostic information (a trace) is created.
Ftscript file name
Name of the script file which contains the XML statements for the openFT-Script request that is to be run.