Running a Command-Line Utility
The majority of utilities provided by CygNet Software can be run either as a utility application or from a command-line interface, whereas some CygNet utilities can be run only from the command-line interface.
Note: For utility applications, running the utility using a command line does not provide version management. See Version Management Overview for more information, or see the specific utility application topic.
CygNet utilities that can be run only from a command window include the following. See SCADA Utilities for more information.
- ARS Modify Service Utility
- CAPRI To DAT
- Connect ARS
- DAT To CAPRI
- Database Copy
- Database Delete Queue
- Database Dump
- Database Unlock
- DBS Restore Backup
- DBS TxLog Management
- File Check ESE
- Gateway Client
- Meter Database Fix
- OPC Sync
- Point Configuration Manager
- ReIndex ESE
- ReReg
- RSM Control Service
- RSM Get File
- Set Point
- Thread Timer
Running a Utility from a Command Prompt Window
Use the following procedure to run any CygNet utility from a command window.
To Run a Command-Line Utility
- Open a Command Prompt window.
- On the Start menu, click Run to access the Run dialog box.
- In the Open text box, type Cmd and then click OK to access the command window.
- Designate the path.
- If necessary, change the drive by typing the drive letter, for example, C:\ and press Enter.
- Type cd\ and then press Enter to change to the root directory.
- For a utility application, type the path, for example, CygNet\Utilities\FmsToolbox and then press Enter to launch the application.
- Change to the CygNet Services or Utilities folder to run the utility. Because some utilities write files to the folder from which they are run, if you run the utility from one of these two folders, you will know where to look for the generated files.
Designating Paths
Depending upon where you run the utility, you may have to specify the path either to the utility or to the data files.
For example, if you run the utility ReindexESE from the Utilities folder, you will have to include the path to the data files:
|
C:\CygNet\Utilities> REINDEXESE c=C:\CygNet\Services\MSS\Mss.cfg |
If you run it from the service folder, you will have to include the path to the utility.
|
C:\CygNet\Services\MSS> C:\CygNet\Utilities\ReindexESE |
Other utilities require the Site.Service or other information. In such cases, a path is not required.
|
ConnectARS MYSITE.ARS 192.164.1.1 |
Command-Line Parameters
Use the following standard command-line parameters to control log file creation.
|
/MAX_LOG_FILES:<maximum_number_of_log_files>
/MAX_LOG_LINES:<maximum_number_of_log_file_lines>
/MAX_LOG_SIZE:<maximum_size_of_log_file> |
The log file is written to the current working directory.
The following standard command-line logging level parameters can also be used to define log file content.
|
/LOG_ALL
/LOG_NONE
/LOG_CONTROL
/LOG_EXCEPTIONS
/LOG_WARNING
/LOG_PROG_STAT
/LOG_MIN_TRACE
/LOG_MAX_TRACE
/LOG_ENTER_EXIT
/LOG_STATISTICS
/LOG_PROFILE_MIN
/LOG_PROFILE_MAX |
Note: These options apply to most clients, services, and utilities. All options may not apply to all usages.
See Service Log Settings and Client Log Settings for more information about applicable logging options.
