Commands

list

List all sequences. By default, the list appears as plain text in the command-line tool. The list indicates which sequences, if any, are running in backfill mode or are scheduled in real-time mode.

You can use the --all (or --a) option to view additional columns in the list that provide details for the latest run of the sequence.

You can use the --format [csv | json | text] (or --f [csv | json | text]) option to change the format of the list. The --format csv option outputs the list as comma-separated values (CSV). The --format json option outputs the list as JSON objects. The --format text option outputs the list as plain text.

You can use the --output filepath (or --o filepath) option to create or overwrite the specified output file with a list of all sequences instead of outputting the list in the command-line tool. The list command cannot create folders, so the containing folder in the file path must already exist to successfully use this command with this option.

You can use the --format and --output options at the same time.

You must use the --all option to use the --format or --output option.

See Examples for the rts list command for more information.

run

Run the given sequence one time in the configured script host; start the script host if it's not started already. The sequence runs synchronously while you wait.

See Examples for the rts run command for more information.

start

Start the AVEVA Real-Time System (RTS) server if it's not already running.

If you have configured RTS to run as a service, you should use the --as-service option. Otherwise, RTS runs as a process. You must have administrator privileges to use the --as-service option.

See Examples for the rts start command for more information.

stop

Stop the RTS server if it's running.

This command works even when RTS is running as a service, but in this case, you must have administrator privileges to successfully run the command.

You can use the --force option to force the RTS processes to shut down, including the AVEVA Process Simulation processes and all processes in the current user session with the RTS-associated names. You can use the --all-sessions option with the --force option to shut down all RTS-associated processes that running on the computer regardless of the user session. This option requires that you have administrator privileges.

If you want to shut down only a specific AVEVA Process Simulation instance, you can use the --instance-name option and specify the instance name (which is the same as the ScriptHost name). This option shuts down only the associated ScriptHost and AVEVA Process Simulation server processes, not the RTS Server and WebUI processes. This is especially useful if you don't want to restart the entire system. If you specify the instance name as *, the command stops all running AVEVA Process Simulation instances.

See Examples for the rts stop command for more information.

restart

Restart the RTS server.

start-backfill

Starts a backfill run for a sequence.

See Examples for the rts start-backfill command for more information.

stop-backfill

Stops a backfill run for a sequence.

See Examples for the rts stop-backfill command for more information.

reset-backfill

Resets a backfill run for a sequence.

See Examples for the rts reset-backfill command for more information.

start-sch

Start the scheduled run in the given sequence.

See Examples for the rts start-sch command for more information.

stop-sch

Stop the scheduled run in the given sequence.

See Examples for the rts stop-sch command for more information.

install-service

Install RTS as a service.

See Example for the rts install-service command for more information.

uninstall-service

Uninstall RTS that was installed as a service.

status

Status of the RTS processes for diagnostics.

sc-create

Create a new AVEVA Process Simulation instance.

sc-delete

Delete an AVEVA Process Simulation instance.

sc-list

List all AVEVA Process Simulation instances.

start-sc-ui

Starts the SimCentral Client UI. Not supported with RTS as a service.

See Examples for the rts start-sc-ui command for more information.

log-db

Includes subcommands to import, export, and purge the Logging database (rts.db).

See Examples for the rts log-db command for more information.