The following scripts are available when used from an initialized command window. We recommend that all scripts be executed from your project directory. The scripts can be executed from a Windows Command Prompt or UNIX terminal window. On Windows, you can type the commands as described in the following section; on UNIX systems you must add .sh to each command. For example, rundata.sh. These instructions assume that a POSIX-compliant shell is used (for example, bash, ksh, or sh).
Note: On some systems sh might not be POSIX-compliant.
|
Script Name |
Description |
|
dos2unix.sh |
Converts a text file from a DOS format to a Unix format. This script takes one argument, a filename, and replaces the original file with the converted version. This script is not available as .bat script. Location: rtvapm/common/bin |
|
my_alert_actions.bat |
Sample script to define actions for alerts. Location: rtvapm/common/bin |
|
rtvapm_init.bat |
Initializes a command window. Format: rtvapm_init.bat Location: |
|
rtvapm_ports.bat |
Outputs a list with all ports in the RTView EM installation. Format: rtvapmports.bat > [outputFile] outputFile – Text file name. Location: rtvapm/common/bin |
|
rtvapm_user_init.bat |
Initializes a user command window. Format: rtvapm_user_init.bat Location: |
|
runa.bat |
Executes RTView Analyzer to extract the function chain of the chosen cache definition file. It returns a .pdf file with a graph of the function chain of all caches in the file. The two scripts have the same functionality. Format: runa.bat [cacheDefFile].rtv cacheDefFile - Cache definition file name. Location: rtvapm/common/bin |
|
runb.bat |
Starts the Display Builder. The two scripts have the same functionality. Format: runb.bat [-ds] [-bg] -ds - To use the currently running Data Server. -bg - Runs the Display Builder as a background process. Location: rtvapm/common/bin |
|
|
-listversions Lists the versions of each RTView jar in the classpath. Example: runb -listversions Once the viewer has started fully, you should see versions for all “gmsj*.jar” and "rtvapm_*.jar” files. Output should resemble the following excerpt: VERSION INFORMATION: gmsjrtview: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjmodels: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjrtvreport: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjext: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_tbemon: TBE 2.1.0.0 ALPHA, 11 March 2015 (TBE 2.1.0.0 ALPHA, 11 March 2015) rtvapm_gfmon: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_emsmon: EMM 6.4.0.0 ALPHA, 11 March 2015 (EMM 6.4.0.0 ALPHA, 11 March 2015) |
|
Starts the Data Server. We recommend that you use the start_rtv.bat script. Format: rundata [-properties]:[Property File Name] -properties - specifies to apply a specific property file. Property File Name - the name of the properties file to apply. Location: rtvapm/common/bin Example: rundata -properties:mysystem.properties |
|
|
|
-listversions Lists the versions of each RTView jar in the classpath. Example: rundata -listversions Once the viewer has started fully, you should see versions for all “gmsj*.jar” and "rtvapm_*.jar” files. Output should resemble the following excerpt: VERSION INFORMATION: gmsjrtview: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjmodels: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjrtvreport: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjext: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_tbemon: TBE 2.1.0.0 ALPHA, 11 March 2015 (TBE 2.1.0.0 ALPHA, 11 March 2015) rtvapm_gfmon: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_emsmon: EMM 6.4.0.0 ALPHA, 11 March 2015 (EMM 6.4.0.0 ALPHA, 11 March 2015) |
|
Starts the HSQLDB database. We recommend that you use the start_rtv.bat script. Location: rtvapm/common/bin |
|
|
Starts the Display Server. We recommend that you use the start_rtv.bat script. Location: rtvapm/common/bin |
|
|
|
-listversions Lists the versions of each RTView jar in the classpath. Example: rundisp -listversions Once the viewer has started fully, you should see versions for all “gmsj*.jar” and "rtvapm_*.jar” files. Output should resemble the following excerpt: VERSION INFORMATION: gmsjrtview: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjmodels: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjrtvreport: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjext: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_tbemon: TBE 2.1.0.0 ALPHA, 11 March 2015 (TBE 2.1.0.0 ALPHA, 11 March 2015) rtvapm_gfmon: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_emsmon: EMM 6.4.0.0 ALPHA, 11 March 2015 (EMM 6.4.0.0 ALPHA, 11 March 2015) |
|
Starts the Historian. We recommend that you use the start_rtv.bat script. Location: rtvapm/common/bin |
|
|
|
-listversions Lists the versions of each RTView jar in the classpath. Example: runhist -listversions Once the viewer has started fully, you should see versions for all “gmsj*.jar” and "rtvapm_*.jar” files. Output should resemble the following excerpt: VERSION INFORMATION: gmsjrtview: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjmodels: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjrtvreport: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjext: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_tbemon: TBE 2.1.0.0 ALPHA, 11 March 2015 (TBE 2.1.0.0 ALPHA, 11 March 2015) rtvapm_gfmon: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_emsmon: EMM 6.4.0.0 ALPHA, 11 March 2015 (EMM 6.4.0.0 ALPHA, 11 March 2015) |
|
Starts the Display Viewer. We recommend that you use the start_rtv.bat script. Location: rtvapm/common/bin |
|
|
-listversions Lists the versions of each RTView jar in the classpath. Example: runv -listversions Once the viewer has started fully, you should see versions for all “gmsj*.jar” and "rtvapm_*.jar” files. Output should resemble the following excerpt: VERSION INFORMATION: gmsjrtview: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjmodels: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjrtvreport: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjext: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_tbemon: TBE 2.1.0.0 ALPHA, 11 March 2015 (TBE 2.1.0.0 ALPHA, 11 March 2015) rtvapm_gfmon: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_emsmon: EMM 6.4.0.0 ALPHA, 11 March 2015 (EMM 6.4.0.0 ALPHA, 11 March 2015) |
|
|
Starts processes in an RTView EM configuration as specified in the rtvservers.dat configuration file. For details about rtvservers.dat, see rtvservers.dat . An RTView EM configuration might include a Data Server, a Display Server or Viewer, an Historian and a Central Server Database. start_rtv only attempts to start processes it detects are not running. The action can be applied to all RTView EM configurations, a single RTView EM configuration or a single process in an RTView EM configuration. If the Display Viewer is started using the start_rtv script, the Viewer cannot be stopped using the stop_rtv script. You can stop the Viewer by closing its window. To use additional arguments you must either specify a configuration (to apply the argument to all servers in a configuration) or all (to apply the argument to all configurations). –console (or –c) - Start the processes with a command window (which is useful for testing). When used without arguments, this script returns usage information and a list of available configurations. For example, start_rtv returns: Usage: start_rtv config or 'all' [server or 'all'] [args...]
Available configs: default dataserver historian displayserver database sender dataserver Location: rtvapm/common/bin |
|
|
|
all Starts all RTView EM configurations specified in the rtvservers.dat file. all applies the action to all RTView EM configurations specified in the rtvservers.dat file (and corresponding servers or clients specified in each configuration). NOTE: When multiple configurations are specified in the rtvservers.dat file and they have different project settings directory locations, the all argument processes all the configurations. However, if the configurations have the same project settings directory locations, the all argument processes only the first configuration as the others are considered alternative configurations. Example: start_rtv.bat all |
|
|
[Configuration Name] Starts a single RTView EM configuration specified in the rtvservers.dat file: start_rtv.bat [Configuration Name] Configuration Name is the RTView EM configuration name specified in the rtvservers.dat file. The action applies to all servers or clients specified in the configuration. Example: start_rtv.bat web_deployment |
|
|
[Server Name] Starts a single process in an RTView EM configuration specified in the rtvservers.dat file: start_rtv.bat [Configuration Name] [Server Name] Server Name is the name of a server or client member in the configuration. For example, dataserver, displayserver, historian and database. The action applies only to that server or client in the configuration. Example: start_rtv.bat web_deployment dataserver |
|
|
-listversions Lists the versions of each RTView jar in the classpath. Example: start_rtv all all -listversions Once the viewer has started fully, you should see versions for all “gmsj*.jar” and "rtvapm_*.jar” files. Output should resemble the following excerpt: VERSION INFORMATION: gmsjrtview: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjmodels: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjrtvreport: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) gmsjext: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_tbemon: TBE 2.1.0.0 ALPHA, 11 March 2015 (TBE 2.1.0.0 ALPHA, 11 March 2015) rtvapm_gfmon: APM 2.1.0.0 ALPHA, 11 March 2015 (APM 2.1.0.0 ALPHA, 11 March 2015) rtvapm_emsmon: EMM 6.4.0.0 ALPHA, 11 March 2015 (EMM 6.4.0.0 ALPHA, 11 March 2015) |
|
Returns the status of all RTView EM configurations specified in the rtvservers.dat configuration file. For details about rtvservers.dat, see rtvservers.dat . This action uses defined JMX ports. An RTView EM configuration might include a Data Server, a Display Server or Viewer, an Historian and a Central Server Database. status_rtv only attempts to start processes it detects are not running. The action can be applied to all RTView EM configurations, a single RTView EM configuration or a single process in an RTView EM configuration. To use additional arguments you must either specify a configuration (to apply the argument to all servers in a configuration) or all (to apply the argument to all configurations). –console (or –c) - Start the processes with a command window (which is useful for testing). This command returns status information upon execution. For example: Status default: dataserver: Running PID 4696 Uptime 000:00:01:47 CPU 00:00:02 Heap 0.7% Clients 2 displayserver: Running PID 6340 Uptime 000:00:01:45 CPU 00:00:01 Heap 1.0% Displays 0 historian: Running PID 6108 Uptime 000:00:01:42 CPU 00:00:01 Heap 1.3% Connected true database: Running PID 6848 Uptime 000:00:01:39 CPU 00:00:00 Heap 0.4% In the above example, note that the Data Server reports two clients, the Display Server and the Historian. Both the Display Server and the Historian were started with the –ds argument, which connects them to the Data Server. Note also that the Historian reports that it is connected to the database. In the following example, status_rtv reports that a configured port is in use but the process using the port does not appear to belong to RTView EM: dataserver: Data port xxx in use by PID yyy displayserver: JMX port xxx in use by PID yyy When used without arguments, returns usage information and a list of available configurations. For example, status_rtv returns: Usage: status_rtv config [server] or 'all'
Available configs: default Location rtvapm/common/bin |
|
|
|
all Returns the status of all RTView EM configurations specified in the rtvservers.dat file. NOTE: When multiple configurations are specified in the rtvservers.dat file and they have different project settings directory locations, the all argument processes all the configurations. However, if the configurations have the same project settings directory locations, the all argument processes only the first configuration as the others are considered alternative configurations. Example: status_rtv.bat all |
|
|
[Configuration Name] Returns the status of a single RTView EM configuration specified in the rtvservers.dat file: status_rtv.bat [Configuration Name] Configuration Name is the RTView EM configuration name specified in the rtvservers.dat file. The action applies to all servers or clients specified in the configuration. Example: status_rtv.bat web_deployment |
|
|
[Server Name] Returns the status of a single process in an RTView EM configuration specified in the rtvservers.dat file: status_rtv.bat [Configuration Name] [Server Name] Server Name is the name of a server or client member in the configuration. For example, dataserver, displayserver, historian and database. The action applies only to that server or client in the configuration. Example: status_rtv.bat web_deployment dataserver |
|
Stops processes in an RTView EM configuration as specified in the rtvservers.dat configuration file. For details about rtvservers.dat, see rtvservers.dat . This action uses defined JMX ports. An RTView EM configuration might include a Data Server, a Display Server or Viewer, an Historian and a Central Server Database. stop_rtv only attempts to start processes it detects are not running. The action can be applied to all RTView EM configurations, a single RTView EM configuration or a single process in an RTView EM configuration. To use additional arguments you must either specify a configuration (to apply the argument to all servers in a configuration) or all (to apply the argument to all configurations). –console (or –c) - Start the processes with a command window (which is useful for testing). If the Display Viewer is started using the start_rtv script, the Viewer cannot be stopped using the stop_rtv script. You can stop the Viewer by closing its window. NOTE: The HSQLDB server (if used) runs with a command window on Windows and cannot be stopped using the stop_rtv command. You can stop the HSQLDB server by typing Ctrl-C in its command window. This command returns status information upon execution. For example: Stop default: dataserver: Stopped PID 4696 via JMX port 3368 If no JMX port is configured the stop_rtv command reports the following: dataserver: No JMX port configured; must kill PID xxx by system command. If the port is in use but the PID is not available (HP-UX, some Linux systems) then the stop_rtv and status_rtv command will report the PID as “???”, for example: dataserver: Running PID ??? Uptime 000:00:00:37 CPU 00:00:01 Heap 1.3% Clients 1 dataserver: Stopped PID ??? via JMX port 3368 NOTE: On Windows the HSQLDB server (if used) runs with a command window and cannot be stopped via the stop_rtv command. To stop the HSQLDB server, execute Ctrl+C in its command window. –console (or –c) - Start the processes with a command window (which is useful for testing). When used without arguments, returns usage information and a list of available configurations. For example, stop_rtv returns: Usage: stop_rtv config [server] or 'all' Available configs: default Location: rtvapm/common/bin |
|
|
|
all Stops all RTView EM configurations specified in the rtvservers.dat file. all applies the action to all RTView EM configurations specified in the rtvservers.dat file (and corresponding servers or clients specified in each configuration). NOTE: When multiple configurations are specified in the rtvservers.dat file and they have different project settings directory locations, the all argument processes all the configurations. However, if the configurations have the same project settings directory locations, the all argument processes only the first configuration as the others are considered alternative configurations. Example: stop_rtv.bat all |
|
|
[Configuration Name] Stops a single RTView EM configuration specified in the rtvservers.dat file: stop_rtv.bat [Configuration Name] Configuration Name is the RTView EM configuration name specified in the rtvservers.dat file. The action applies to all servers or clients specified in the configuration. Example: stop_rtv.bat web_deployment |
|
|
[Server Name] Stops a single process in an RTView EM configuration specified in the rtvservers.dat file: stop_rtv.bat [Configuration Name] [Server Name] Server Name is the name of a server or client member in the configuration. For example, dataserver, displayserver, historian and database. The action applies only to that server or client in the configuration. Example: stop_rtv.bat web_deployment dataserver |
|
update_wars.bat |
Script to regenerate war files when the configuration of the Solution Package has changed. Location: rtvapm/<package_name>/projects/sample |