Remote
Configuration 
This documentation provides instructions and information for running the portal drive remote configuration (Remote Config) utility. The Remote Config is used to configure the user’s portal drive installations. For example, the Remote Config can create a new service for the user and specify what drive letter this service should use. It can also be used to set various options such as the size of the cache.
Portal Drive Configuration Files
When it is started, the portal drive software loads its internal configuration files. It next loads the values that exist in the registry. Finally, it looks for and, if necessary, loads an administrator-configured file. This file is downloaded from a URL specified by an administrator.
The <AutoupdateURL> item defines where the portal drive software should look for:
· New versions
· Configuration files
Information for how to get the configuration file is contained within an XML file that is available at the URL specified by <AutoupdateURL>. For more information on the content of this XML file, see Auto Update.
How to use the configuration file
The configuration file is an XML file. The first line in the file must be <?xml version="1.0" ?> and the rest of the file is enclosed in a <wfc-config> tag. Each attribute that needs to be set must be defined in its own <item> tag in the configuration file.
For example, to set the cache size to 512MB and to start Windows Explorer upon connection, a complete configuration file could look like:
<?xml version="1.0" ?>
<wfc-config>
<item>
<name>CacheSize</name>
<value>512</value>
</item>
<item>
<name>StartExplorer</name>
<value>1</value>
</item>
</wfc-config>
Preventing a user from overriding the value
For some parameters there may be a need to prevent a user from overriding it. This is done on a per attribute basis by the presence of the <locked/> tag in the configuration file.
For example, to set the cache size to 512MB and prevent the user from updating this value, the configuration file would include a definition like:
<item>
<name>CacheSize</name>
<value>512</value>
<locked/>
</item>
Currently, locked fields are not reflected in the portal drive user interface. This means that a user can override a value by changing its value on the screen; however, if the value was declared as being locked, then the user's change will not be used.
Description of Configurable Attributes
The table below provides the list of attributes that can be configured via the Remote Configuration utility, and provides details on the type of data and the possible and default values.
How to read the table:
· Name is how the item must be referenced in the configuration file.
· Description describes what the parameter is used for.
· Type in registry indicates how this item is stored in the registry. This will be either DWORD for numbers, String for text values or Binary for dates and times. This is for informational purposes only and cannot be changed.
· Applies to describes whether this parameter applies to all users (Computer) or just the current user (User). This is for informational purposes only and can not be changed.
· Possible values describe what values are acceptable.
· Default value is the value that is used if none is specified.
General Settings
Name |
Attributes |
CacheSize |
Description: The size of the file cache Type in registry: DWORD Applies to: Computer Possible values: Number, e.g. 100 Default value: 32
|
ClearCacheUponDisconnect |
Description: controls if the cache is cleared when a drive is disconnected Type in registry: DWORD Applies to: User Possible values: 0 (Disabled), 1 (Enabled) Default value: 0
|
AutoupdateURL |
Description: URL to the XML file where to check for updated versions of the software and configuration files Type in registry: String Applies to: Computer Possible values: HTTP URL Default value: <blank>
|
UserName |
Description: the username of the user; this is used for lock identification Type in registry: String Applies to: User Possible values: String for the username Default value: the username that is used to establish the connection
|
I18Nlanguage |
Description: language the client should be started in Type in registry: String Applies to: User Possible values: en-US (English), de (German), ja (Japanese), fr (French), cs (Czech) Default value: the language selected during portal drive installation
|
StartExplorer |
Description: controls if upon connecting a Windows Explorer window is displayed Type in registry: DWORD Applies to: User Possible values: 0 (Disabled), 1 (Enabled) Default value: 1
|
ShowExtraTab |
Description: controls if the Advanced tab is displayed or not Type in registry: DWORD Applies to: User Possible values: 0 (Disabled), 1 (Enabled) Default value: 1
|
ExtraOptions |
Description: controls logging options in the Advanced tab Type in registry: DWORD Applies to: User Possible values: a combination of values; useful ones are: 1 (Log HTTP only), 3 (Log HTTP + Directory Listings), 9 (Log HTTP + Monitor Messages), b (hex) (Log HTTP + Directory Listings + Monitor Messages) Default value: 9
|
AlwaysLockList |
Description: List of applications which the auto-lock-upon-opening feature applies Type in registry: String Applies to: User Possible values: The name of the .exe processes, separated by semi-colons Default value: notepad;wordpad;winword;excel;winproj;powerpnt
|
NeverLockList |
Description: List of applications which the auto-lock-upon-opening feature does not apply Type in registry: String Applies to: User Possible values: The name of the .exe processes, separated by semi-colons Default value: explorer;wincmd32;totalcmd;outlook;cmd;ntvdm;
|
UnlockByAppLockList |
Description: List of applications which are unlocked when the application's process has terminated Type in registry: String Applies to: User Possible values: The name of the .exe processes, separated by semi-colons Default value: notepad;wordpad;photoed;uedit32
|
SyncOnConnect |
Description: Controls whether a drive should synchronize upon connecting Type in registry: DWORD Applies to: User Possible values: 0, 1 Default value: 1
|
SyncOnDisconnect |
Description: Controls whether a drive should synchronize upon disconnecting Type in registry: DWORD Applies to: User Possible values: 0, 1 Default value: 0
|
Service Settings
To define a service, use the format below for each service you want to define.
<item>
<type>service</type>
<name>Documents</name>
<hostname>myserver.mycompany.com</hostname>
<port>1234</port>
<secure>1</secure>
<server-directory>/irj/servlet/prt/portal/prtroot/com.sap.km.cm.docs/
documents</server-directory>
<drive-letter>k</drive-letter>
<sharing-level>3</sharing-level>
</item>
Service Settings
Name |
Attributes |
type |
Description: defines the type of item this is Possible values: Must be service
|
name |
Description: name of the service Possible values: Any string, e.g. my files account
|
hostname |
Description: hostname of the server, e.g. myserver.mycompany.com Possible values: A string name representing the host name
|
port |
Description: port number to connect to on the server Possible values: A number representing the port number. If not specified, defaults to 80 or 443 depending on the value of secure
|
secure |
Description: determines if http or https should be used Possible values: 0 (use http), 1 (use https)
|
server-directory |
Description: server directory to mount Possible values: a string representing a directory path, e.g. /irj/servlet/prt/portal/prtroot/com.sap.km.cm.docs/
The portal drive uses the #U notation as a variable username. Therefore, if you are creating default services for many users, you can use #U to indicate where the user name would get substituted in the URL. For example, you can map every user’s Personal Documents folder to a drive letter with the following path: /irj/servlet/prt/portal/prtroot/com.sap.km.cm.docs/
|
drive-letter |
Description: drive letter to use for this service Possible values: any letter from D-Z; if it is not available, or if no letter is specified, the first letter available will be used.
|
sharing-level |
Description: sharing level to use for this service Possible values: 0 (None), 1 (Low), 2 (Medium), 3 (High)
|