Configuration File Parameter Descriptions

This topic provides information on the configuration file parameters. It includes which files include the parameters, which sections of those files, the default values, and description.

AbsoluteRating

Files: Server

Section: [FilerAccessMonitor]

Default: AbsoluteRating = yes

Description: Specifies whether or not to rate the speed to file server (from either the client or server) according to the absolute access time to the iCDB database folder.

Used for both the “Connection speed to File Server” and the “iCDB server connection speed to project filer” diagnostics. See Table 1 for more information.

AcceptNewConnection_USec

Files: Server, Launcher, ServerManager, ServerMonitor

Section: [Timeouts]

Default: AcceptNewConnection_USec = 10000

Description: An internal switch for debugging.

ActivateDeactivate

Files: ProjectBackup

Section: [Permissions]

Default: ActivateDeactivate = no

Description: Specifies whether or not the client has permission to toggle the Enable backups check box in the Backup Settings Dialog Box.

Active

Files: Server and ServerMonitor

Section: [FilerAccessMonitor], [SystemMemoryMonitor], and [EventLog]

Default: active = yes

Description: An internal switch for debugging.

Address

Files: Server, Launcher, ServerManager, ServerMonitor

Section: [Network]

Default: No default

Description: Network address (either the machine name or IP) used to listen for incoming TCP/IP client connections.

AutoBackupSupport

Files: Server

Section: [System]

Default: AutoBackupSupport = yes

Description: Toggles auto-backup functionality. When disabled, no auto-backups are created. See the topic, iCDB Project Backup, for more information.

AvgEventSize

Files: Server

Section: [EventLog]

Default: AvgEventSize = 400

Description: An internal switch for debugging.

BackupsSettings

Files: ProjectBackup

Section: [Permissions]

Default: BackupsSettings = yes

Description: Specifies whether or not the user on the client machine can access the Backup Settings Dialog Box to make changes to the Backup settings.

BetweenCheckProjectAccess_MSec

Files: Server

Section: [Times]

Default: BetweenCheckProjectAccess_MSec = 1000

Description: Time interval (in milliseconds) between checking server address file access. Detects network connection issues with the project file server. If you have slow file servers, consider increasing this time.

BetweenCheckStats_MSec

Files: Server

Section: [Times]

Default: BetweenCheckStats_MSec = 100

Description: An internal switch for debugging.

BetweenCheckStorageSave_MSec

Files: Server

Section: [Times]

Default: BetweenCheckStorageSave_MSec = 1000

Description: Used to change the frequency (specified in milliseconds) of the check storage save procedure.

BetweenDuplicatedCommands_USec

Files: Server, Launcher, ServerManager, ServerMonitor

Section: [Times]

Default: BetweenDuplicatedCommands_USec = 100000

Description: An internal switch for debugging.

BetweenPingReceive_Sec

Files: Server

Section: [Timeouts]

Default: BetweenPingReceive_Sec = 10

Description: Used to set the timeout (specified in seconds) while determining if the connection with a client exists.

BetweenPingSend_Sec

Files: Server, Client, ServerManager, ServerMonitor

Section: [Time]

Default: BetweenPingSend_Sec = 5 (For Server and Client)

BetweenPingSend_Sec = 10 (For ServerManager and ServerMonitor

Description: Used to change the frequency (specified in seconds) of sending PING commands to clients.

BetweenReceive_Sec

Files: Client, ServerManager, ServerMonitor

Section: [Timeouts]

Default: BetweenReceive_Sec = 30

Description: Sets the timeout between two successive commands (including PINGs) received from the server. After this timeout the client assumes server problems have occurred.

BetweenServerTouchAddressFile_MSec

Files: Client

Section: [Times]

Default: BetweenServerTouchAddressFile_MSec = 250

Description: An internal switch for debugging.

BetweenSnapshotSaveCommand_Sec

Files: Client

Description: No longer used.

BetweenStorageSave_Sec

Files: Server

Section: [Times]

Default: BetweenStorageSave_Sec = 5

Description: Used to change the timeout (specified in seconds) of when changed files will be flushed to the disk.

ChangeServerConfiguration

Files: ServerManager

Section: [Permissions]

Default: ChangeServerConfiguration = yes

Description: Specifies whether or not the user of the local machine has permission to change the server configuration in Server Manager.

CheckingServerRootPathAccess

Files: Client, Launcher, ServerManager

Section: [Timeouts]

Default: CheckingServerRootPathAccess = 20000

Description: Specifies a period of time (in milliseconds) that the client tries to check if the server has write permission to the server's root directory in a project.

CheckInterval_MSec

Files: Server, ServerMonitor

Section: In Server, appears in both [FilerAccessMonitor] and [SystemMemoryMonitor]

In ServerMonitor, appears in [FilerAccessMonitor]

Default: In [FilerAccessMonitor], default is CheckInterval_MSec = 1000

In [SystemMemoryMonitor], default is CheckInterval_MSec = 300

Description: Sets the frequency of sending “file stat” commands to test the access time between the iCDB client and File Server or between the iCDB Server and File Server.

Used for both the “Connection speed to File Server” and the “iCDB server connection speed to project filer” diagnostics. See Table 1 for more information.

CleanUp

Files: ProjectBackup

Section: [Permissions]

Default: CleanUp = yes

Description: Specifies whether or not this client has permission to run Project > Clean up. The menu item is grayed out if no.

ClientAliveSleep_MSec

Files: Client

Section: [Times]

Default: ClientAliveSleep_MSec = 500

Description: An internal switch for debugging.

ClientManagerMainLoopSleep_MSec

Files: Server

Section: [Times]

Default: ClientManagerMainLoopSleep_MSec = 100

Description: An internal switch for debugging.

ClientOffline_Sec

Files: Server

Section: [Timeouts]

Default: ClientOffline_Sec = 600

Description: Used to control the time (in seconds) after which an offline client (disconnected improperly) will be removed from server client list.

ConsDefLoaderActive

Files: Server, Client

Section: [Plugins]

Default: ConsDefLoaderActive = yes

Description: Enable/disable the constraint definition loader plug-in.

ConsDefLoaderFileName

Files: Server, Client

Section: [Plugins]

Default: ConsDefLoaderFileName = ConsDefLoader70.dll

Description: Specifies the file name of the library used for this plug-in.

ConsDefLoaderName

Files: Server, Client

Section: [Plugins]

Default: ConsDefLoaderName = ConsDefLoader70

Description: Specifies the name of the plug-in; this appears in the log file.

CreateSupportPackage

Files: ProjectBackup

Section: [Permissions]

Default: CreateSupportPackage = yes

Description: Specifies whether or not this client has permission to run Project > Create support package. The menu item is grayed out if no.

CreatingServerProperties_MSec

Files: Server, Client

Section: [Timeouts]

Default: CreatingServerProperties_MSec = 20000

Description: Timeout (in milliseconds) for creating server address file. In the event of a slow project file server, you can increase this time.

CriticalAccessFactor

Files: Server, ServerMonitor

Section: [FilerAccessMonitor]

Default: CriticalAccessFactor = 100

Description: Sets the threshold that prompts a warning when the calculated access time to the File Server exceeds this time and RelativeRating is enabled.

Used for both the “Connection speed to File Server” and the “iCDB server connection speed to project filer” diagnostics. See Categories of Diagnostics for more information.

CriticalAccessTime_USec

Files: Server, ServerMonitor

Section: [FilerAccessMonitor]

Default: CriticalAccessTime_USec = 30000

Description: Sets the threshold that prompts a warning when the calculated access time to the File Server exceeds this time and AbsoluteRating is enabled.

Used for both the “Connection speed to File Server” and the “iCDB server connection speed to project filer” diagnostics. See Table 1 for more information.

CriticalPingTime_USec

Files: ServerMonitor

Section: [ServerMonitor]

Default: CriticalPingTime_USec = 200000

Description: Sets the threshold that prompts a warning when the calculated access time from the iCDB Client to the iCDB Server exceeds this time.

Used for the “Connection speed to iCDB Server” diagnostic. See Categories of Diagnostics for more information.

DatabaseAutoRepairSupport

Files: Server

Section: [System]

Default: DatabaseAutoRepairSupport = yes

Description: If the database loses connection with the file server, then the next server session will try to repair the database. If this is disabled, the server will not try to repair the database on the next session.

DBCheckAfterUpgradeOnlyAsWarning

Files: Server, Client

Section: [System]

Default: DBCheckAfterUpgradeOnlyAsWarning = no

Description: Specifies to treat all errors found during iCDB internal database check as warnings.

DBCheckLogFilesArchiveSizeLimit_MB

Files: Server

Section: [Logging]

Default: DBCheckLogFilesArchiveSizeLimit_MB = 5

Description: Specifies the maximum size for check log files.

DBCheckLogFilesSizeLimit_MB

Files: Server

Section: [Logging]

Default: DBCheckLogFilesSizeLimit_MB = 10

Description: Specifies the maximum size for the log file when the Server checks the database.

DBCheckOnShutdown

Files: Server

Section: [System]

Default: DBCheckOnShutdown = no

Description: Specifies whether or not to run iCDB internal database check on every server shutdown.

DBCheckOnStartup

Files: Server

Section: [System]

Default: DBCheckOnStartup = no

Description: Specifies whether or not to run iCDB internal database check on every server startup.

DBCheckOnUpgrade

Files: Server, Client

Section: [System]

Default: DBCheckOnUpgrade = yes

Description: Specifies whether or not to run iCDB internal database check after every iCDB database upgrade.

DBDefragmentOnShutdown

Files: Server

Section: [System]

Default: DBDefragmentOnShutdown = yes

Description: Specifies whether or not to defragment the iCDB database file (if needed at all) on server shutdown. iCDB database file defragmentation helps provide optimal performance.

DBInternalBackupFilesArchiveSizeLimit_MB

Files: Server

Section: [System]

Default: DBInternalBackupFilesArchiveSizeLimit_MB = 100

Description: Specifies the maximum size for the database’s internal backup files.

DBRestoreLogFilesArchiveSizeLimit_MB

Files: Server

Section: [Logging]

Default: DBRestoreLogFilesArchiveSizeLimit_MB = 5

Description: Specifies the maximum size for restore log files.

DBRestoreLogFilesSizeLimit_MB

Files: Server

Section: [Logging]

Default: DBRestoreLogFilesArchiveSizeLimit_MB = 10

Description: Specifies the maximum size for the Server's restore log files.

DBSavepointWarningNumber

Files: Server

Section: [System]

Default: DBSavepointWarningNumber = 200

Description: Specifies threshold at which the Server Monitor issues a warning that the number of save points exceeds this threshold. Toggle this feature in the Server Monitor’s Settings section. See Database rollback size.

DBSynchronousIO

Files: Server

Section: [System]

Default: DBSynchronousIO = yes

Description: Specifies whether the database is open for synchronous I/O.

DBUpgradeLogFilesArchiveSizeLimit_MB

Files: Server

Section: [Logging]

Default: DBUpgradeLogFilesArchiveSizeLimit_MB = 10

Description: Specifies the maximum size for upgrade log files.

DBUpgradeLogFilesSizeLimit_MB

Files: Server

Section: [Logging]

Default: DBUpgradeLogFilesSizeLimit_MB = 20

Description: Specifies the maximum size for the Server's upgrade log files.

DebugMode

Files: Server, Client, Launcher, ServerManager, ServerMonitor

Section: [System]

Default: DebugMode = no

Description: Enables/disables debug mode.

DefragmentDatabase

Files: ServerManager

Section: [Permissions]

Default: DefragmentDatabase = yes

Description: Specifies whether or not the users of the local machine have permission to defragment the database from Server Manager.

DiagCheckDatabase

Files: ServerManager

Section: [Permissions]

Default: DiagCheckDatabase = yes

Description: Specifies whether or not the users of the local machine have permission to check the database from Server Manager (Server Manager: Tools > Diagnostics > Check database).

DiagPorts

Files: ServerManager

Section: [Permissions]

Default: DiagPorts = yes

Description: Specifies whether or not the users of the local machine have permission to run the ports diagnostic in Server Manager (Server Manager: Tools > Diagnostics > Ports).

DiagPortRange

Files: ProjectBackup

Section: [Network]

Default: DiagPortRange = 10000,10100

Description: Specifies the range of network TCP/IP port numbers that the Server Monitor listens to for incoming connections.

DiagRSCM

Files: ServerManager

Section: [Permissions]

Default: DiagRSCM = yes

Description: Specifies whether or not the users of the local machine have permission to run the RSCM diagnostic in Server Manager (Server Manager: Tools > Diagnostics > RSCM).

DisconnectClient

Files: ServerManager

Section: [Permissions]

Default: DisconnectClient = yes

Description: Specifies whether or not the users of the local machine have permission to disconnect a client in Server Manager.

ENetGenActive

Files: Server

Section: [Plugins]

Default: ENetGenActive = yes

Description: Enables/disables this plugin.

ENetGenFileName

Files: Server

Section: [Plugins]

Default: ENetGenFileName = ENetGen70.dll

Description: Specifies the name of the file name of the library used for this plug-in

ENetGenName

Files: Server

Section: [Plugins]

Default: ENetGenName = yes

Description: Specifies the name of the plug-in; this appears in the log file.

EventPollingMode

Files: Server

Section: [System]

Default: EventPollingMode = auto

Description: An internal switch for debugging.

ExecuteMainLoopSleep_MSec

Files: Client

Section: [Times]

Default: ExecuteMainLoopSleep_MSec = 1

Description: Specifies the name of the plug-in; this appears in the log file.

Expire_Days

Files: Server, Client, Launcher, ProjectBackup, ServerManager, ServerMonitor

Section: [Logging]

Default: Expire_Days = 7

Description: Sets the time (in days) after which the server log files will be deleted. The creation date of the file is used for the comparison. If the value is set to 0, the server log files are never deleted.

FileCreationMargin_Sec

Files: Server, Client, Launcher, ServerManager, ServerMonitor

Section: [Times]

Default: FileCreationMargin_Sec = 1

Description: Maximum allowed time difference (in seconds) between the system time on the server machine and file creation time on the file server when saving the server address file. In event of a slow file server (or incorrect real time clock settings) you can increase this time.

ForcedExpireCount

Files: Server, Client, Launcher, ProjectBackup, ServerManager, ServerMonitor

Section: [Logging]

Default: ForcedExpireCount = 100

Description: Sets the maximum number of log files even if they have not reached the number of days specified in Expire_Days.

InitReceiveCommand_Sec

Files: Server, Launcher, ServerManager, ServerMonitor

Section: [Timeouts]

Default: InitReceiveCommand_Sec = 10

Description: Sets the timeout (in seconds) for determining that a failure occurred when receiving an initialization command from a client.

InWDIR

Files: Launcher

Section: [Logging]

Default: InWDIR = yes

Description: For Linux/UNIX only. If set to “yes,” the logging information is stored in WDIR instead of the system logs. (Windows stores the logging information in WDIR by default.)

KillServer

Files: ServerManager

Section: [Permissions]

Default: KillServer = no

Description: Specifies whether or not the users of the local machine have permission to kill a server in Server Manager.

LauncherAddress

Files: Client

Section: [System]

Default: No default

Description: Overrides RSCM address settings for all opened projects. This forces clients to use the one specified.

LauncherUDPPort

Files: Launcher, ServerManager, ServerMonitor

Section: [Network]

Default: LauncherUDPPort = 10000

Description: Specifies the network UDP port number used by the Remote Server Configuration Manager.

Level

Files: Server, Client, Launcher, ProjectBackup, ServerManager, ServerMonitor

Section: [Logging]

Default: Level = 1

Description: In general, the higher log level provides more information. Each level provides the information provided by the lower levels plus new information. Specifically, the levels provide the following information:

0 - Logs all errors
1 - (Default) Level 0 information plus the following:
- Logs all errors and warnings.
- Monitors key iCDB activity.
2 - Level 1 information plus the following:
- Monitors iCDB threads lifetime.
- Monitors each client connection status on the server.
- Detailed information about rejected client connections.
- Monitors plug-in lifetime on the server.
3 - Level 2 information plus the following:
- Monitors iCDB infrastructure objects lifetime.
- Information about rejected LOCKs by the iCDB Server.
- Information about removing a snapshot from memory cache by the iCDB Server.
- Information about begin/commit/rollback of each transaction on the client.
- Information about found drive mapping.
4 - Level 3 information plus the following:
- Detailed information about client session status.
- Detailed information about iCDB threads finish.
- Monitors notify command queue on the client.
- Monitors notify commands on the client.
- Monitors client commands on the server.
5 - Level 4 information plus the following:
- Detailed information about each client command.
- Detailed information about each server command.
- Detailed information about each event on the client.
- Monitors client connection process to the server.
- Monitors snapshot memory cache on the server.
6 - Level 5 information plus the following:
- Monitors iCDB physical storage file operations.
- Monitors notify waiting queue on the client.
- Monitors snapshot reference counting on the server.
- Detailed information about access rights to project path by the Server Manager.
7 - Level 6 information plus the following:
- Monitors network package sending on the server.

LogFilesWarningSize_MB

Files: Server

Port

Files: Launcher

Section: [Network]

Default: Port = 9000

Description: Specifies the network TCP/IP port number on which the RSCM process listens for incoming client connections.

PortRange

Files: Server, ServerManager, ServerMonitor

Section: [Network]

Default: PortRange = 10000, 10100

Description: Specifies the range of network TCP/IP port numbers allowed within which the server process can listen for incoming client connections.

ProxyManagerMainLoopSleep_MSec

Files: Launcher

Section: [Times]

Default: ProxyManagerMainLoopSleep_MSec = 100

Description: An internal switch for debugging.

ProxyMode

Files: Launcher

Section: [System]

Default: ProxyMode = no

Description: Specifies whether or not RSCM should work in proxy mode. In this mode all client/server connections are made through RSCM TCP/IP port, so clients do not need direct access to server port range. ProxyMode does degrade overall performance.

ReadingServerProperties_MSec

Files: Server, Client, Launcher, ServerManager, ServerMonitor

Section: [Timeouts]

Default: ReadingServerProperties_MSec = 10000

Description: Timeout (in milliseconds) for reading server address file. In the event of a slow project file server, you can increase this time.

Receive_Sec

Files: Client

Section: [Timeouts]

Default: Receive_Sec = 3600

Description: Sets the timeout for receiving a single command from the server.

ReceiveBroadcast_USec

Files: Server, ServerManager, ServerMonitor

Section: [Timeouts]

Default: ReceiveBroadcast_USec = 10000

Description: An internal switch for debugging.

ReceiveCommand_USec

Files: Server, Client, Launcher, ServerManager, ServerMonitor

Section: [Timeouts]

Default: ReceiveCommand_USec = 10000

Description: An internal switch for debugging.

ReceiveWaitForOnLineSleep_MSec

Files: Client

Section: [Times]

Default: ReceiveWaitForOnLineSleep_MSec = 10

Description: An internal switch for debugging.

RefreshAppName_MSec

Files: ServerMonitor

Section: [Times]

Default: RefreshAppName_MSec = 1000

Description: An internal switch for debugging.

RelativeRating

Files: Server, ServerMonitor

Files: ServerManager, ProjectBackup

Section: [Permissions]

Default: SendMessage = yes

Description: Specifies whether or not the users of the local machine have permission to send messages in Server Manager (Server Manager: Tools > Send message) or ProjectBackup (ProjectBackup: Connected Clients Window > Send message to connected clients icon

ServerAliveWait_MSec

Files: Client, Launcher, ServerManager, ServerMonitor

Section: [Times]

Default: ServerAliveWait_MSec = 30000

Description: Specifies the waiting time between starting the server and being ready to accept client connections.

ServerAliveWaitStep_MSec

Files: Client

Section: [Times]

Default: ServerAliveWaitStep_MSec = 100

Description: An internal switch for debugging.

ServerAutoClose_Sec

Files: Server

Section: [Timeouts]

Default: ServerAutoClose_Sec = 1

Description: Specifies the timeout (in seconds) after which the server starts the closing procedure when there are no clients left.

ServerAutoCloseWithoutAnyClientEver_Sec

Files: Server

Section: [Timeouts]

Default: ServerAutoCloseWithoutAnyClientEver_Sec = 10

Description: Specifies the timeout (in seconds) after which the server starts the closing procedure after no clients are found.

ServerConnectionCheck_Sec

Files: Client

Section: [Timeouts]

Default: ServerConnectionCheck_Sec = 10

Description: Time interval (in seconds) for checking network connection between client and server for user activity.

ServerLogFilesArchiveSizeLimit_MB

Files: Server

Section: [Logging]

Default: ServerLogFilesArchiveSizeLimit_MB = 50

Description: Specifies the maximum size for server log files.

ServerManagerSupport

Files: Server, Launcher

Section: [System]

Default: ServerManagerSupport = yes

Description: Specifies whether or not the server supports iCDB Server Manager functionality.

ServerManagerUDPPort

Files: Server, Launcher, ServerManager, ServerMonitor

Section: [Network]

Default: ServerManagerUDPPort = 10000

Description: Specifies the network UDP port number for the iCDB Server Manager.

ServerMonitorSupport

Files: Server, Client, Launcher

Section: [System]

Default: ServerMonitorSupport = yes

Description: Specifies whether or not the server supports iCDB Server Monitor functionality

ServerPath

Files: Client, Launcher, ServerManager, ServerMonitor

Section: [System]

Default: No default

Description: Specifies the pathname to the server if it is in a non-standard directory.

ServerPermanentLogFilesArchiveSizeLimit_MB

Files: Server

Section: [Logging]

Default: ServerPermanentLogFilesArchiveSizeLimit_MB = 1

Description: Specifies the maximum size for the server’s permanent log files.

ServerPermanentLogFilesSizeLimit_MB

Files: Server

Section: [Logging]

Default: ServerPermanentLogFilesSizeLimit_MB = 2

Description: Specifies the maximum size for the Server's permanent log files.

ServerUDPPort

Files: Server, ServerManager, ServerMonitor

Section: [Network]

Default: ServerUDPPort = 10000

Description: Specifies the network UDP port number for the iCDB Server.

SetBackupPersistent

Files: ProjectBackup

Section: [Permissions]

Default: SetBackupPersistent = yes

Description: Specifies whether or not this client has permission to set a backup as Persistent with Backup > Persistent. The menu item is grayed out if no.

ShutdownServer

Files: ServerManager

Section: [Permissions]

Default: ShutdownServer = yes

Description: Specifies whether or not the users of the local machine have permission to shut down a server in Server Manager (Server Manager: Tools > Shutdown server).

SingleUserMode

Files: Server

Section: [System]

Default: SingleUserMode = auto

Description: An internal switch for debugging.

Description: By default (SingleUserMode = auto) concurrent design requires you to specify an RSCM Server for a project.

Setting this entry to “yes” disregards any RSCM Server settings and disallows concurrent design. Only one user at a time can open the project.

Setting this entry to “no” allows all clients (even from different machines) to connect to a project concurrently, and it ignores any RSCM server settings for the project (the project’s iCDB Server runs on the local machine that first opens the project).

You should not change this setting from the default value except in rare cases where you have a clear and specific reason for doing so or you are instructed to do so by your Mentor Graphics customer support representative. You should always use an RSCM Server for concurrent design.

Arguments: [yes/no/auto]

SlowAccessFactor

Files: Server, ServerMonitor

Section: [FilerAccessMonitor]

Default: SlowAccessFactor = 10

Description: Sets the threshold that prompts an error when the calculated access time to the File Server exceeds this time and RelativeRating is enabled.

Used for both the “Connection speed to File Server” and the “iCDB server connection speed to project filer” diagnostics. See Table 1 for more information.

SlowAccessTime_USec

Files: Server, ServerMonitor

Section: [FilerAccessMonitor]

Default: SlowAccessTime_USec = 10000

Description: Sets the threshold that prompts an error when the calculated access time to the File Server exceeds this time and AbsoluteRating is enabled.

Used for both the “Connection speed to File Server” and the “iCDB server connection speed to project filer” diagnostics. See Table 1 for more information.

SlowPingTime_USec

Files: ServerMonitor

Section: [ServerMonitor]

Default: SlowPingTime_USec = 100000

Description: Sets the threshold that prompts an error when the calculated access time from the iCDB Client to the iCDB Server exceeds this time.

Used for the “Connection speed to iCDB Server” diagnostic. See Categories of Diagnostics for more information.

StableMargin_Percentage

Files: Server, ServerMonitor

Used for the “Server Memory” diagnostic. See Table 1 for more information.