Try OpenEdge Now
skip to main content
Progress Application Server for OpenEdge Configuration
TCMAN Reference : Server actions : Register an instance for tracking (register)

Register an instance for tracking (register)


Register an instance for tracking purposes.
Instances are automatically registered for tracking when you execute a create action. You use the register action to restart tracking on instances after tracking was stopped.
A typical use for unregistering and then re-registering an instance is to make configuration changes when moving instances from one location (core server) to another. The register action enables tracking and also updates the value of CATALINA_HOME in all of the executable scripts in the instance's /bin directory to refer to the new core server.

Syntax register alias_name instance_path


Specify a meaningful name for the instance. The alias name must be unique in the instances file.
Specify the OS file system path to where the instance exists. This value will be expanded into a fully qualified OS directory path and will be verified to exist.


Track test1, which is an alias for the instance /psc/acme1:
/psc/pashome/bin/ register test1 /psc/acme1


When you register an instance for tracking or create a new instance with the create command, an entry is created in the core Progress Application Server’s $CATALINA_HOME/conf/instances.[unix|windows] file.
The instances.[unix|windows] file is a simple text file, which can be manually edited (with care) in the event that it becomes out of date. The format for entries is:
instance_name = base_path
An instances.unix file uses Unix OS file path syntax (forward slashes), and an file uses Windows OS file path syntax (backslashes) to specify base_path.
Also note that in an instances file:
*Any line starting with a pound-sign ( # ) is a comment line.
*Blank lines are skipped.
*Instance names cannot contain spaces or any of the following characters: "[ . # | ] $ ? + = { / , }"