Description of the SoftGrid Client 3.x registry entries

View products that this article applies to.

SUMMARY

Microsoft SoftGrid Client 3.x stores its configuration in the registry. You can gather some useful information about the client if you understand the format of data in the registry. You can also configure many client actions by changing registry entries. This article lists all the SoftGrid client registry keys and explains their uses.

Back to the top

MORE INFORMATION

SoftGrid Client 3.x registry entries

Configuration key location

HKEY_LOCAL_MACHINE\SOFTWARE\Softricity\SoftGrid Client\CurrentVersion\Configuration

Configuration key values

Collapse this tableExpand this table

Name	Type	Data (Examples)	Description
ProductName	String	SoftGrid for Terminal Servers	Do not modify.
ClientVersion	String	3.x.x.xxx	Do not modify.
GUID	String		A unique ID generated during installation that is sent to the server to identify the client.
Drivers	String	Sftfs.sys	If present, the name of the driver that caused a stop error last time the core was starting. Can be deleted to let sftlist to start if you have fixed the stop error.
InstallPath	String	C:\Softricity	Where the SoftGrid client is installed. Do not modify.
LogFileName	String	C:\Softricity\sftlog.txt	Client log file. Can be modified to change the log file location. You must restart the sftlist service.
LogModuleMask	Binary	FFFF03F03FFF1D1E	Controls which modules write to the log file. Set to FFF... (16 Fs) for all modules.
LogMinSeverity	DWORD	3	Controls which messages are written to the log. 1-5 are valid. 1 is fatal errors only, 2 is errors and fatal errors, etc. 5 is verbose, meaning everything gets written to the log.
LogContextFlags	DWORD	00000207	Do not modify this.
AlwaysRun	DWORD	0 or 1	Set under HKCU to determine whether the tray will run at startup and stay running after the last app shuts down (1) or only run when applications are in use (0).
RegisterTypes	DWORD	0 or 1	Whether file types should automatically be registered with Windows. Use Options Dialog to modify.
OSDCache	String	C:\Softricity\OSD Cache	Where the OSD files are cached. Should not be modified.
UserDataDirectory	String	C:\SoftGridData\%UserName%	Path where the SoftGrid Client stores user specific data. Can include environment variables. Note that this is set once per machine, not per user. Therefore, include a variable that makes it per user.
GlobalDataDirectory	String	C:\Documents and Settings\All Users\Documents\	Path where the SoftGrid Client stores global SoftGrid data, including caches for OSD files, icon files, shortcut information, and SystemGuard resources (such as .ini files). Available in 3.0 SP2 and above.
IconCache	String	C:\Softricity\Icon Cache	Where icons are cached. Should not be modified.
Shortcuts	String	C:\Softricity\shortcuts.dat	Path to the file where published shortcuts can be tracked and deleted when applications are removed. Can be moved and modified when the sftlist is stopped.
AllowCrashes	DWORD	0 or 1	0 by default. When a crash occurs: 0 - the SoftGrid client continues operation even when a crash occurs 1 - Allow crashes to occur, a debug dr watson log will be created
KillHungThreads	DWORD	300	Time in seconds that the client should wait before it kills a thread it thinks has stopped responding. 0xFFFFFFFF means never kill, 0 means kill immediately. Do not modify.
MaxClientWorkerThreads	DWORD	32	Maximum number of worker threads the client will allow in its thread pool. You must restart sftlist if you change this. Do not modify.
InitialClientWorkerThreads	DWORD	8	Initial number of worker threads the client will create in its thread pool. You must restart sftlist for this to take effect. Do not modify.
CoreInternalTimeout	DWORD	15	Timeout in seconds for internal IPC requests between core and front-end. Do not modify.
CoreShortTimeout	DWORD	30	Timeout in seconds for IPC requests between the core and front-end that are typically quick (such as retrieving a program name. Do not modify.
CoreMediumTimeout	DWORD	60	Timeout in seconds for IPC requests between the core and front-end that may take a short time to finish. For example, shutting down an program. Do not modify.
CoreLongTimeout	DWORD	120	Timeout in seconds for IPC requests between the core and front-end that may take a long time to finish. For example, updating from a MIME server). Do not modify.
DCCSeamlessTimeout	DWORD	30	In a seamless session, time in seconds that the DCC (Desktop Configuration Control) process will remain open after the last application closes.
DCCInitialSeamlessTimeout	DWORD	30	In a seamless session, time in seconds the DCC (Desktop Configuration Control) process will remain open when there are no applications. This refers to instances when a front-end component starts DCC because a program is about to be launched.
DCCInitTimeout	DWORD	60	Controls how long the client core will wait for the DCC to initialize before stopping requests to connect front-end components or to do a MIME update. Defaults to 60 seconds. Cannot be set below 10 seconds.
MonitorNetworkActivity	DWORD	0 or 1	Turn the SoftGrid system tray icon network activity light on (1) or off (0).
TrayErrorDisplayDelay	DWORD	30	Time in seconds that the SoftGrid system tray will display error messages like "Launch failed".
TraySuccessDisplayDelay	DWORD	10	Time in seconds that the SoftGrid system tray will display success messages like "Word launched" or "Excel shut down". If 0, those messages will be suppressed.
AppListSharedTimeout	DWORD	15	Timeout for acquiring a commonly-used internal resource. Do not modify.
AppListExclusiveTimeout	DWORD	30	Timeout for acquiring a commonly-used internal resource. Do not modify.
DefaultSuiteCombineTime	DWORD	10	If COMBINEAPPS is not in an OSD file, this value is used to indicate how soon after open a program can shut down and not generate any error messages when another application in the same suite is running.
SerializedSuiteLaunchTimeout	DWORD	10	How long the client will wait as it tries to serialize program starts in the same suite. If the client times out, the program start will continue, but it will not be serialized.
PublishShortcutsToDesktop	DWORD	0 or 1	Automatically publish shortcuts to the user's desktop (if under HKCU) or to each user's desktop (if under HKLM) if set to 1.
PublishShortcutsToStartMenu	DWORD	0 or 1	Automatically publish shortcuts to the user's Start menu (if under HKCU) or to each user's start menu (if under HKLM) if set to 1.
ScriptTimeout	DWORD	300	Default timeout in seconds for scripts in .osd file if WAIT=TRUE. Can specify per-script timeouts with TIMEOUT instead of WAIT. 0 means wait forever.
DumpPath	String	C:\Softricity\Dumps	Default path to create minidumps when exceptions occur.
DumpPathSizeLimit	DWORD	1000	Default maximum size in megabytes of which the total space used by the minidumps that are created.
LaunchRecordLogPath	String	C:\Softricity\usage.txt	If set in the registry (HKLM or HKCU), SFTTray will write to this log when program start, shut down, fail to launch, and then enter and exit disconnected mode. If a path is not specified in the registry, no logging occurs. Only applies to SP2 and beyond.
LaunchRecordMask	DWORD	0x1A (26) would produce log messages for launch errors and MDO activity. 0x1F (31) logs everything. 0x0 (0) logs nothing.	Can control which of the 5 events are logged: 1 for launches, 2 for launch errors, 4 for shutdowns, 8 for entering disconnected mode, and 16 for reconnecting to a server. Add any combination of those numbers to turn on the respective messages. 0 turns everything off; 0xFFFFFFFF turns everything on. Defaults to 0xFFFFFFFF if not in registry. Only applies to SP2 and beyond.
LaunchRecordWriteTimeout	DWORD	3000	Specifies in milliseconds how long the tray will wait when trying to write to the launch record log in if another process is using it. Defaults to 3000 ms. Only applies to SP2 and beyond.
ImportSearchPath	String	d:\files\;C:\documents and settings\user1\SFTs	A semi-colon delimited list of up to 5 directories to search for portable SFT files before bothering to prompt the user to select a directory. Trailing back slash in paths is optional. Not present by default. Must be set manually. Applies to version 3.1
Unspecified	String	D:\SFTs\	The last location the user browsed to while locating an SFT for package import. Set automatically if the SFT is found successfully. Used on successive imports in attempt to automatically locate SFTs. Applies to version 3.1
Patch Level	String	Hotfix 100	String value representing the Hotfix release applied to the system. Applies to version 3.1
LastMiniDumpLogged	Binary		Contains a binary timestamp indicating the time on the last minidump the client mentioned in the message it logs when it starts up. Do not modify. Applies to version 3.1
AllowDisconnectedOperation	DWORD	0 or 1	Determines if the client is allowed to go in to Minimal Disconnected Operation (MDO) mode: 0 - No 1 - Yes
DOTimeoutMinutes	DWORD	0x78 (120 minutes)	Allows the client to run applications in Minimal Disconnected Operation (MDO) for the amount of minutes specified. Maximum time is 45 days (0x278D0)

Network key

The Network key controls a variety of network-related parameters. This key is primarily used by the network transport agent.

Network key location

HKEY_LOCAL_MACHINE\SOFTWARE\Softricity\SoftGrid Client\CurrentVersion\Network

Network key values

Collapse this tableExpand this table

Name	Type	Data (Examples)	Description
Bandwidth	DWORD	0x10	Tell the server whether connecting is over a modem or LAN so it can optimize stream rate. Configure in Options Dialog. This value only applies to version 3.0 of the SoftGrid Client. This value should not be modified in version 3.1 or in later versions of the SoftGrid Client.
Protocol	DWORD	0x8	Default protocol to use (TCP vs SSL). Configure in Options Dialog
HTTPProxyName	String	proxy.softricity.int	Name of a proxy server. Configure in Options Dialog
HTTPProxyPort	DWORD	8080	Port on the proxy server to use. Configure in Options Dialog
HTTPUseProxy	DWORD	0 or 1	Whether to use the HTTP proxy. Configure in Options Dialog
RTSPProxyName	String	proxy.softricity.int	Name of RTSP proxy server. Configure in Options Dialog
RTSPProxyPort	DWORD	5054	Port on RTSP proxy server to use. Configure in Options Dialog
RTSPUseProxy	DWORD	0 or 1	Whether to use an RTSP proxy server. Configure in Options Dialog
ReadTimeout	DWORD	30	Read timeout for network transactions, in seconds. Do not modify.
WriteTimeout	DWORD	30	Write timeout for network transactions, in seconds. Do not modify.
ConnectTimeout	DWORD	30	Connect timeout for network transactions, in seconds. Do not modify.
HTTPRetryLimit	DWORD	3	How many times to retry an HTTP transaction before giving up.
RTSPRetryLimit	DWORD	3	How many times to retry an RTSP transaction before giving up.
ReestablishmentRetries	DWORD	3	How many times to try to reestablish a dropped session.
ReestablishmentInterval	DWORD	15	How long to wait between tries to reestablish a dropped session, in seconds.

File system key

The values that are the AppFS key control the file system parameters for SoftGrid.

File system key location

HKEY_LOCAL_MACHINE\SOFTWARE\Softricity\SoftGrid Client\CurrentVersion\AppFS

File system key values

Collapse this tableExpand this table

Name	Type	Data (Examples)	Description
FileSize	DWORD	500	Maximum size in megabytes of file system cache file. If changing in registry, must set State to 0 and reboot.
FileName	String	C:\Softricity\sftfs.fsd	Location of file system cache file. If changing in registry, must either leave size the same and reboot, or set State to 0 and reboot.
CSRSectorSize	DWORD	512	Do not modify.
STRSectorSize	DWORD	4096	Do not modify.
DriveLetter	String	Q:	Drive where SoftGrid file system will be mounted.
State	DWORD	0x100	State of file system. Set to 0 and reboot to completely clear FS cache.
FileSystemStorage	String	C:\Profiles\Joe\SG	Path for symlinks, set under HKCU. Do not modify (use data directory under Configuration to change).
GlobalFileSystemStorage	String	C:\Softricity\GlobalFS	Path for global FS data. Do not modify.
UniqueId	DWORD	7	Unique ID number for each user, set under HKCU, matches what is under the User key. Do not modify.
MaxPercentToLockInCache	DWORD	90	Restricts more than the specified percentage of the "FileSystem cache file" from being locked. Do not modify.

Permissions key

The Permissions key lets you enable and disable some actions for non-administrative users. Notice that this is not a secure system. If users can edit their own registries, they can give themselves any of these permissions. This key is primarily designed to stop users from making mistakes. For example, this key is designed to prevent users from accidentally unloading programs. This key is not designed to help secure any part of the SoftGrid Client.

The Permission Key settings control all interfaces that enable the named actions. This includes the Options Dialog, SFTTray, and SFTMime. These settings do not affect administrators.

Permissions key location

HKEY_LOCAL_MACHINE\SOFTWARE\Softricity\SoftGrid Client\CurrentVersion\Permissions

Permissions key values

Collapse this tableExpand this table

Name	Type	Data (Examples)	Description
RemoveApp	DWORD	0	Does not allow a user to remove personal settings, shortcuts, file type associations, and symbolic links.
		1	Allows user to remove personal settings, shortcuts, file type associations, and symbolic links (and not completely remove the application from cache for all users). This is the default for Terminal Servers and Windows Desktops.
RemoveAppComplete	DWORD	0	Does not allow a user to completely remove an application from cache. Applies to version 3.1
		1	Allows a user to completely remove an application from cache.
LoadApp	DWORD	0	Does not allow a user to load an application. This is the default for Terminal Servers.
		1	Allows a user to load an application. This is the default for Windows Desktops.
UnloadApp	DWORD	0	Does not allow a user to unload an application.
		1	Allows a user to unload an application.
LockApp	DWORD	0	Does not allow a user to lock and unlock an application. This is the default for Terminal Servers.
		1	Allows a user to lock and unlock an application. This is the default for Windows Desktops.
ManageTypes	DWORD	0	Does not allow a user to add, edit, and remove file type associations for that User alone. This is the default for Terminal Servers.
		1	Allows a user to add, edit, and remove file type associations for that user only and not globally. This is the default for Windows Desktops.
RefreshServer	DWORD	0	Does not allow a user to trigger a refresh of MIME settings. This is the default for Terminal Servers.
		1	Allows a user to trigger a refresh of MIME settings. This is the default for Windows Desktops.
ImportApp	DWORD	0	Does not allow a user to import applications into cache. Applies to version 3.1
		1	Allows a user to import applications into cache.