Example D: Reconfiguring RSCM server and client ports

Scenario: The IT department informs you that another tool needs port 9000 and they have asked you to configure the RSCM service for another port. In addition, they noticed that the default configuration uses port range 10000 - 10100 and requested that you change the values to fit within the range 9100 and 9200. They would also like you to reduce the number of ports to meet your actual need so they could block the ports that are not being used. You estimate that you would never have more than ten active projects, so you've agreed to configure the environment for a maximum of ten ports.

To change the configuration, modify the configuration files Server.cfg, Launcher.cfg, ServerMonitor.cfg and ServerManager.cfg as described below.

Note:

You should close all client programs (PADS Designer, PADS Layout, iCDB Server Manager and iCDB Server Monitor) and stop all RSCM Server services before you modify the configuration files.

These files are under the %WDIR%\iCDB folder. If your WDIR variable has more than one path in it, then you need to modify the files in the first directory listed in the path.

You only need to modify the Server, Launcher, and ServerManager and ServerMonitor configuration files to change the port values.

You need to distribute the configuration files to all users who will access the design. The Launcher configuration file is only required on systems that run an RSCM Service.

All projects that use the RSCM Servers must have their project files updated with the new server name:portnum values. Change them with a text editor by modifying the value for the key DedicatedServerName in each project file.

Make a copy of each iCDB directory prior to making the edits. Once you've made the edits and verified the functionality, you should then backup the modified iCDB directories. Doing this will allow you to switch back quickly to a working configuration and to recover if there is a loss of the information in the files you just edited.

Here are the specific modifications you need to make to the configuration files:

Server.cfg Configuration File (on the RSCM Server)

This configuration file is in %WDIR%\iCDB\Server\Server.cfg. Make a backup before editing it. The entries marked in red are the changes you need to make to reduce the port range to 10 ports. You must also remove the comment character (;). The text comments are optional but recommended.

[Network] 
; PortRange = 10000,10100 
; ServerManagerUDPPort = 10000 
; ServerUDPPort = 10000 
; 
; 5/12/2011 - KF 
; Changed the port values to fit with the range of 9100 - 9200. 
; Changed default port range to limit the number of open projects to 10 
; 
PortRange = 9100,9200 
ServerManagerUDPPort = 9100 
ServerUDPPort = 9100

Be sure the check with your IT department to make sure you the new ports are available. If you change the PortRange, you must also change the Launcher, Server Manager, and Server Monitor UDP ports to match.

Launcher.cfg Configuration File (on the RSCM Server only)

The Launcher.cfg file runs only on machines that run the RSCM Service. The configuration file for the server is in %WDIR%\iCDB\Launcher\Launcher.cfg.

If the file does not exist and the WDIR location isn't writable, the RSCM Service uses the default values. Make sure a copy of this file exists in your local, writeable WDIR. Edit the parameters in red to match those in red under the Server.cfg section above. They must match:

[Network] 
; LauncherUDPPort = 10000 
; ServerManagerUDPPort = 10000 
; Port = 9000 
; 
; 5/12/2011 - KF 
; Changed the default RSCM Server port  
; Changed the UDP port values to match the new port numbers in Server.cfg 
; 
LauncherUDPPort = 9100 
ServerManagerUDPPort = 9100 
Port = 9001

If you changed the PortRange in the Server.cfg file, you must also change the Launcher, Server Manager, and Server Monitor UDP ports to match the first port number in the range.

Note:

Changing the default RSCM Server port (Port = 9001 in this example) requires a change in the PADS Designer/PADS project file. You have to append the new port number to the machine name. When you used the default port (9000) this was not required. For example, RSCM Server name was ‘server1’ and you change the port to 9001, then the name you use to define the RSCM Server must be ‘server1:9001’. You must update your project files accordingly or the attempts to connect to the RSCM Server will fail.

ServerManager.cfg Configuration File (on the client system)

The ServerManager.cfg file contains the configuration settings for the Server Manager. It is in %WDIR%\iCDB\ServerManager. The contents of this file appear in the Settings section of each server’s information tree grouped according to the header that appears in the file.

[Network] 
;LauncherUDPPort = 10000 
;ServerManagerUDPPort = 10000 
;PortRange = 10000,10100 
;ServerUDPPort = 10000 
; 
; 5/12/2011 - KF 
; Changed the UDP port and port range values to match Server.cfg 
;  
LauncherUDPPort = 9100 
ServerManagerUDPPort = 9100 
PortRange = 9100,9110 
ServerUDPPort = 9100

ServerMonitor.cfg Configuration File (on the client system)

The ServerMonitor.cfg file contains the configuration settings for the Server Monitor. It is in %WDIR%\iCDB\ServerMonitor. The contents of this file appear in the Settings section of each server's information tree grouped according to the same headers as appears in the file.

[Network] 
;LauncherUDPPort = 10000 
;ServerManagerUDPPort = 10000 
;PortRange = 10000,10100 
;ServerUDPPort = 10000 
; 
; 5/12/2011 - KF 
; Changed the UDP port and port range values to match Server.cfg 
;  
LauncherUDPPort = 9100 
ServerManagerUDPPort = 9100 
PortRange = 9100,9110 
ServerUDPPort = 9100

Restarting RSCM Services

Once you have made all the changes to the configuration files, you must restart all RSCM Services and test by opening projects and observing the port number changes with Server Manager.