What are the Windows batch files delivered with ProTop, and what do they do?

Here is a list of the batch files delivered with ProTop for Windows, a short description, and links to other documentation.

NOTE: Files that end with "(x)" are source scripts that can be overwritten during an update to ProTop.  Copy the source script to the file name without the "x".  That file is safe to customize as ProTop will not overwrite it.

bat file Description
99rb.bat

An example Custom Application Monitoring batch file.

addpath.bat

Adds the given folder to the %PATH% environment variable if not already there.

admin.bat(x)

Example of commands to be "run as admin".
aipurge.bat(x) You can use this script to purge your archive AI files so they do not fill the disk.
aipurge.bat(x.tom) A variation of aipurge.batx above.
build.bat(x) See Dump & Load Scripts (^d).
colors..bat ProTop RT command key "0" saves colors here. See Color Picker (0) for more info.
dbanalys.bat Produces the all-important database analysis used by ProTop.
dbmonitor.bat Installed as a Windows service during installation.  It runs the ProTop scheduler and (re)starts agents for resources defined in etc\dblist.cfg.
dbupd.bat(x) Needed commands to bring an untuned database "up to snuff."
dumpsql.bat(x) Dumps SQL Views and Grants. Companion to loadsql.batx below.
enableai.bat(x) The full command to enable AI online and start an AI writer for the database.
foreachdb.bat Used by the Scheduler to run commands for active databases.

getdbpath.bat

Shows the physical location of the database for the resource friendlyName provided.

hc.bat

Automated Health Check using a friendlyName.

hcz.bat

Automated Health Check using a database name.

idxcompact.*.bat

Produced by hc.bat or by running the "^r" command key in ProTop RT.

lincoln.bat

An example Custom Application Monitoring batch file.

loadsql.bat(x)

Contains sqlexp commands to load SQL views and grants. Companion to dumpsql.batx above.

localenv.bat(x)

Localized environment variables. 

logrotate.bat

See Database Log Archiving and Filtering for more information.

mailx.bat

Email command line using blat.exe used by the "@" command in ProTop RT.

maintenance.bat

See Stopping ProTop ...

mkproenv.bat

Creates a proenv desktop icon/shortcut.

mkscut.bat

Creates a protop desktop shortcut. Edit the shortcut's properties to add the friendly name and change the shortcut name.

nssm_edit.bat

Can be used to edit the properties of the ProTop3 DB Monitor service.

nssm_setup.bat

You can use this to install the ProTop3 DB Monitor service manually.

otrx.bat

If it exists, it is the script run by the "script"  action for the otrx alert definition in etc\alert.*.cfg. See Automated Script Responses for more information.

portalenv.bat

Contains portal-related environment variables.

protop.bat

ProTop Real Time (RT).

protopenv.bat

Sets up most of the environment variables used by ProTop.

pt3inst.bat(x)

Stub for creating the complete pt3inst.bat that lives in %PROTOP%.

pt3upd.bat

Updates the currently installed version of ProTop to the latest or the version you name as the only input parameter.

pt3win.bat

Give this batch file a db or friendly name to start a Windows GUI ProTop session. 

restart.bat

Forces a restart of ProTop processes by removing the tmp\*.flg files.

restartrepl.bat(x)

Execute this script to restart the replication server without binding the server to your login session, which will quit when you log out. It creates, runs, and deletes a service to make this happen.

sendalert.bat

See Send Custom Alerts for more information.

syncdblist.bat

Synchronizes etc\dblist.cfg with resources for this site on the ProTop Portal.

syncio.bat

Please take a look at syncio for more information.

xaiw.bat(x)

Like restartrepl.bat above, it starts an AI Writer not bound to your login, so it continues to run when you log out.

zipenv.bat(x)

Please take a look at User Experience for more information.

zippyng.bat

Please take a look at User Experience for more information.

zOldTRXDetails.batx

This script is run when the zOldTRXDetails alert enhancer runs. Please take a look at Alert Configuration for more details.