Laserfiche WebLink
Getting Started TSTool Documentation <br />Getting Started - 26 <br /> <br />The Help…About TSTool menu item displays the program version number, for use in troubleshooting <br />and support. I nformation about the software and system can be di splayed from the version dialog, to help <br />with roubleshooting. <br /> <br />The Help…View Documentation menu item s display the PDF documentation using the default PDF <br />viewer. <br /> <br />The Help…View Training Materials menu item opens a file system browser to the location of the training <br />materials. Training materials are organized by topic and provide working examples. <br /> <br />The Help…Import Configuration menu item is used to import an old TSTool configuration file into a <br />new software installation. It may be necessary to manually cop y configuration old files, in particular for <br />data store configuration. TSTool configuration files are saved in the system folder under the TSTool <br />installation. <br /> <br />3.12 Batch Mode Execution <br /> <br />The TSTool interface provides immediate feedback on whether command s are properly defined and input <br />data are available. However, once a command file has been defined, it may be appropriate to process the <br />commands in “headless mode”, without the graphical user interface. To do so, run TSTool on the <br />command line as follow s: <br /> <br />[PathToTSTool]tstool –commands commands.TSTool [parameters] <br /> <br />There are a number of potential issues that may impact command line execution: <br /> <br />• If the folder containing the TSTool executable (tstool.exe on Windows and tstool on <br />*NIX) is in the PATH envir onment variable, then no leading path is needed. However, because <br />different versions of TSTool may be installed on the system, specifying the leading path to the <br />executable may be appropriate. <br />• On Windows, entering the TSTool command line in a Command Prom pt window causes the <br />prompt to be immediately returned, even though TSTool is still running. This can be <br />disconcerting in particular because it may be difficult to know when TSTool has finished <br />processing the command file . Placing the command in a batch file (*.bat ) can help. <br />• TSTool has the concept of “working directory”, which is the root location to which relative paths <br />are referenced. Normally this is the location of the command file once opened. However, when <br />running TSTool in batch mode, there are a number of folders involved: the location of the <br />TSTool executable, the location from which TSTool is run, and the location of the command file. <br />These multiple locations can make it difficult to troubleshoot. One option is to use absolute paths <br />in the TSTool command line for the executable and the command file so it is very clear where the <br />TSTool executable and command file are located. These paths can be coded into a batch file <br />(*.bat on Windows, or shell script on *NIX). <br />• TSTool can be run in headless mode and still create graph windows (e.g., when TSTool supports <br />the functionality of another application). Make sure to evaluate whether the –nomaingui <br />parameter is needed in addition to –commands . <br />• The TSTool default log file under the logs folder of the installation is used when TSTool first <br />starts up. If a StartLog() command is used in the command file, it will be used when the <br />command file is run. Refer to the appropriate log file when troubleshooting. <br /> <br />52