Skip to main content
pdf?stylesheet=default
Blackboard Help

Mass Configuration for Windows

This topic provides instructions and information for running the Blackboard Drive for Mass Configuration (Mass Config) utility. The Mass Config is used to configure end users' Blackboard Drive installations. For example, the Mass Config can create a new Volume for the end user and specify what drive letter this Volume should use. It can also be used to set various options such as the size of the cache.

Blackboard Drive Configuration Files

When it starts, Blackboard Drive loads its internal configuration files. It next looks for and, if necessary, loads an administrator-configured file. This file is downloaded from a URL specified by administrator.

View and download admin-config-sample.xml. to use as the template for your admin-config.xml file. Either create a copy of the file and name it admin-config.xml, or create a new file named admin-config.xml.

When using the Auto-Update feature, the xdconfig_customer.xml calls out to the server's update-info.xml file, which contains versioning information for the admin-config.xml file. If the version information has been updated, the admin-config.xml file will be called, and the new values will be brought to the user's system via auto-update. The configuration file for Mass Config is named admin-config.xml. See the table in Description of Configurable Attributes for parameter settings and syntax.

Preventing a User from Overriding the Value

For some parameters, you may need to prevent a user from overriding it. This is done on a per attribute basis by the presence of the gen:locks="edit" attribute in the configuration file.

For example, to set the server to https://as91Oct14 and prevent the user from updating this value, the configuration file would include a definition like the following:

<server gen:locks="edit">
  <gen:value>https://as91Oct14</gen:value>
</server>

Description of Configurable Attributes

The following table provides the list of attributes that can be configured via the Mass Configuration utility, and provides details on the type of data and the possible and default values.

How to read the table:

  • The Name column lists how the item must be referenced in the configuration file.
  • The Description cell describes what the parameter is used for.
  • The Default Value is the value that is used if none is specified.

List of configurable attributes

Name cookiesPolicyURL
Description The value of this item is used as the URL to Privacy Center.
Type string
Default Value http://www.blackboard.com/privacy
Name disableCookiesPolicyInformationDisplay
Description The value of this item enables/disables displaying privacy information dialog containing cookies policy information at the startup. This dialog should be displayed on startup since new EU privacy law take effect in the EU on May 26, 2012 and it is related to the use of cookies. Users must receive detailed notice/info on cookies and their purpose.
Type boolean
Default Value false
Name massUpdateURL
Description The value of this item is used as the url of update-info xml. Should be specified (and possibly locked) on the customer level.
Type string
Default Value None
Lock Level None
Name massUpdateCurrentVersion
Description The value of this item is used by the auto-update feature to determine whether a new version of the configuration file needs to be retrieved from a mass-configuration server. When the massUpdateCurrentVersion in the config file on the remote mass-config server is higher that the massUpdateCurrentVersion in the local admin config, the remote config file is downloaded and applied.
Type string
Default Value 0
Example

<massUpdateCurrentVersion>
    <gen:value>10</gen:value>
</massUpdateCurrentVersion>

Name massUpdateTimeout
Description The value of this item is used by the auto-update feature to determine how many seconds Drive can wait for mass-configuration server during retrieving of configuration file. There are also fixed timeouts for establishing connection and downloading of file. Both are set to 10 seconds and cannot be changed. Value in this configuration item sets maximal accumulated value for both actions. Minimum value is 1 second.
Type integer
Default Value 10
Name disableSavingPassword
Description This value disables saving password in Drive. When it is set to True, all controls that provides saving of password will be hidden and password storage factory will return dummy password storage which does not save password and always returns null for password. null means password is not in the password storage.
Type boolean
Default Value False
Lock Level None
Name disableSavingUsername
Description This value disables saving of user name. When it is set to True text box in service edit dialog is disabled and all dialogs that offers user name don't display previously entered username. Username is actually stored in cache, but it can be eliminated by clearCacheOnServerDisconnect.
Type boolean
Default Value false
Lock Level Edition specific
Name forceUnmountOnEndSession
Description This parameter forces unmounting of the volumes that cannot be gracefully unmounted during system Log off, Restart or Shutdown. Note that it might cause the interruption of unfinished transfers, resulting in the data loss. The accompanying sign of this problem is never ending black screen appearance waiting for Blackboard Drive to exit, that results in a user’s necessity of choosing  Cancel or Force Log off/Shutdown/Restart button to leave the black screen. The parameter should be set to true only when customer experiences troubles with black screen on Windows Vista and later.

The Force Log off/Shutdown/Restart button causes Blackboard Drive is terminated immediately without chance to do proper actions needed during the exit of the application, in contrast to proper exit, with an exception of mounted volumes, when the forceUnmountOnEndSession is set to true. Note that sometimes an application can hold the opened file, which can cause the volume cannot be unmounted. That might be also good reason for setting this option to true, but administrator should remember that the amount of data loss depends on good or bad decision of the user. For example, there might be a lot of files in the queue to save to the server from previous Drag & Drop action.
Type boolean
Default Value false
Lock Level None
Since Version 1.6 SP2;  Note: this option has no effect on Mac OS X
Name forceSecureRenegotiation
Description The item is associated with Transport Layer Security (TLS) Renegotiation Issue (see http://java.sun.com/javase/javaseforbusiness/docs/TLSReadme.html). A security vulnerability in all versions of the Transport Layer Security (TLS) protocol (including the older Secure Socket Layer (SSLv3)) can allow Man-In-The-Middle (MITM) type attacks where chosen plain text is injected as a prefix to a TLS connection. This vulnerability does not allow an attacker to decrypt or modify the intercepted network communication once the client and server have successfully negotiated a session between themselves. This security bug has been solved by interim fix that disables TLS/SSL renegotiation in the Java Secure Sockets Extension (JSSE) by default. This fix caused that client is not able to connect server which uses renegotiation. It can be easily solved by can be re-enabling renegotiations for Drive, but it will cause potential risk for MITM attacks. Most of current servers do not support this fix so for more user friendly behavior this config option for enabling/disabling renegotiation is set to enable renegotiation by default.
Type boolean
Default Value true
Lock Level None
Name notificationWindowPopupTime
Description This item defines lifetime of certain notification dialogs in seconds.
Type integer
Default Value 30
Lock Level None
Name mainVersion
Description The value of this item is used to denote the main version of the product. It should be in the format X.X where X is a number. This string is used as a prefix for revision number, when the full version of the application is assembled. This item should be changed and locked on EDITION level and is the same for all modules of Drive.
Type string
Default Value 1.0
Lock Level edition
Name moreInfoURL
Description This value contains URL for button "More Info" in About Dialog of Drive, which usualy opens company home page. The value differs for each edition.
Type string
Default Value None
Lock Level edition
Name isBuildTrial
Description True if the build is a trial, otherwise False.
Type string
Default Value None
Lock Level edition
Name helpPageURL
Description The URL of Drive help page.
Type string
Default Value Depends on edition
Lock Level edition
Name sharingLevel
Description The sharing level which should be used for this volume.
Possible values:
  • None
  • Light
  • Medium
  • Heavy

(or name of any new sharing level created by administrator).

Type string
Default Value Heavy
Example

<sharingLevel>
    <!This volume will have medium sharing-->

    <gen:value>Medium</gen:value>
</sharingLevel>

Name sharingLevelNone
Sharing Level name one
checkBeforeOpen false
autoLocks false
cachedListings true
refreshTimeout 60 min
itemOrder 0
guid Xythos;04:03:08 12:30:35 +0100;None
Name sharingLevelLight
Sharing Level name Light
checkBeforeOpen true
autoLocks true
cachedListings true
refreshTimeout 15 min
itemOrder 1
guid Xythos;04:03:08 12:30:36 +0100;Light
Name sharingLevelMedium
Sharing Level name Medium
checkBeforeOpen true
autoLocks true
cachedListings true
refreshTimeout 5 min
itemOrder 2
guid Xythos;04:03:08 12:30:37 +0100;Medium
Name sharingLevelHeavy
Sharing Level name Heavy
checkBeforeOpen true
autoLocks true
cachedListings true
refreshTimeout 1 min
itemOrder 3
guid Xythos;04:03:08 12:30:38 +0100;Heavy
Name name
Description The name of a volume. It is mandatory for a volume to have a unique name. The name must match the following regex pattern: [a-zA-Z_0-9]+[a-zA-Z_0-9-:\.]*
Type string
Default Value None
Lock Level None
Example

<name>
   <gen:value>xpHTTPS</gen:value>
</name>

Name checkBeforeOpen
Description Tells the Drive if a file should be checked for any recent change before open (by means of PROPFIND method). If the drive finds out that the file was changed on server and the content of the file in cache is stale, new download is issued.
Type boolean
Default Value false
Lock Level None
Name autoLocks
Description Tells the Drive if a file should be auto-locked during editing or not.
Type boolean
Default Value false
Lock Level None
Name cachedListings
Description If true and we have cached the content of the directory we do not do remote dirlist.
Type boolean
Default Value false
Lock Level None
Example

<cachedListings>
  <gen:value>true</gen:value>
</cachedListings>

Name refreshTimeout
Description Time in seconds since the last directory listing, after which is the cached directory listing or remote attributes considered out of date. Expiration of this timeout does not immediately trigger a request for a directory listing from the server - it only invalidates the cached listing, a new listing is retrieved only after any application requests it. It is treated as a preferred value, the Drive may not use this exact value.
Type integer
Default Value 0
Lock Level None
Example

<refreshTimeout>
   <gen:value>3600</gen:value>
</refreshTimeout>

Name checkBeforeOpenTimeout
Description Time in seconds. Tells Drive after how much minimum time should be performed checkBeforeOpen. In other words, if there is a file system operation asking for remote attributes of a file and cached information on such remote attributes is available, we do not make remote operation to verify the validity of the data, unless the data is older than the value of the checkBeforeOpenTimeout.
Type integer
Default Value 0
Lock Level None
Name itemOrder
Description This is the number giving the sharing level the order in the GUI list presented to user. It should reflect "heaviness" of the sharing level as much as possible. The least "checking" sharing level has the least number.
Type integer
Default Value 0
Lock Level None
Name DisableRemoteAttributesTab
Description Controls whether or not the RemoteAttributes tab is displayed.
Type boolean
Default Value false
Lock Level None
Name DisableRemoteAttributesAddition
Description Disables adding of new file or folder remote attributes (such as WebDAV properties) in properties dialog. Modification or deletion of existing attributes is unaffected.
Type boolean
Default Value false
Lock Level None
Name DisableRemoteAttributesModification
Description Disables modifying existing file or folder remote attributes (such as WebDav properties) values in the properties dialog box. Adding or deletion of attributes is unaffected.
Type boolean
Default Value false
Lock Level None
Name DisableRemoteAttributesDeletion
Description Disables deleting existing file or folder remote attributes (such as WebDAV properties) in the properties dialog. Adding or modification of attributes is unaffected.
Type boolean
Default Value false
Lock Level None
Name NegotiateSpnWithCanonicalName
Description The value determines whether Canonical Name is used for Service Principal Name when the Negotiate (SPNEGO) authentication protocol is used. Note that the Canonical Name is not an alias determined by a DNS CNAME record; however, it is the primary host name determined by a DNS A-Record which should be unique.
Type string with constraint.
The SPN contains the host-name taken from URL used for the connection to the WebDAV server.
TRUE - The SPN contains the Canonical Name which is returned by the DNS system for given host-name.
The value is set to be in parity with Internet Explorer setting: The value is read from registry key FEATURE_USE_CNAME_FOR_SPN_KB911149 as documented in Microsoft KB911149. If the setting for IE process is not equal to one, the TRUE value is set for this option. All the other cases are translated into the FALSE value. Note that CNAME refers to a DNS CNAME record, but not to Canonical Name, so the value FEATURE_USE_CNAME_FOR_SPN_KB911149 has to be negated when it is translated into NegotiateSpnWithCanonicalName value.
Default Value SYSTEM_DEFAULT
Lock Level None
Name NegotiateSpnWithPort
Description The value determines if Service Principal Name contains the port when non-default port is used in the URL when connecting to the WebDAV server. The SPN is needed when the Negotiate (SPNEGO) authentication protocol is used.
Type string with constraint.
The SPN contains the host-name taken from URL used for the connection to the WebDAV server.
TRUE - The SPN contains the Canonical Name which is returned by the DNS system for given host-name.
SYSTEM_DEFAULT - The value is set to be in parity with Internet Explorer setting: The value is read from registry key FEATURE_INCLUDE_PORT_IN_SPN_KB908209 as documented in Microsoft KB911149. If the setting for IE process is not equal to one, the TRUE value is set for this option. All the other cases are translated into the FALSE value.
Default Value SYSTEM_DEFAULT
Lock Level None
Name LookupContentServerRoot (added in version 1.7.17230)
Description When set to true, Drive will try to detect content server root (e.g. WebDAV server root) upon connection of a volume, rather than immediately connecting to the URL specified in the volume definition. The reason for searching the content root is that when multiple volumes are mounted to the server, they can share the cached representation of the server, so changes made in the content of one volume can be immediately reflected in the content of the other volume. This is the default behavior, however, in some specific server configurations like different authentication methods on respective server paths or mixed public/non-public content in server folders the Drive might have problems connecting or displaying all expected content, so this behavior can be disabled by setting the value to false.
A consequence of disabling this feature is that the synchronization of volumes mounted to the same server will only be done through the server, so changes to one volume will only be applied to another after the directory listing refresh timeout.
Type boolean
Default Value true
Lock Level none
Name HideDiscardButton (added in version 1.7 SP1)
Description When set to "true", the "Discard" button in the conflict resolution dialog is not shown.
Type boolean
Default Value false
Lock Level none
Name DisableContextMenu
Description Disables shell/finder context menu items.
Type boolean
Default Value false
Lock Level None
Name HideCopyUrlToClipboard
Description When set to 'true', the item "Copy URL to Clipboard" is not available in the context menu after right-clicking on a file.
Type boolean
Default Value false
Lock Level None
Name HideRefreshCachedData
Description When set to 'true', the item "Refresh Cached Data" is not available in the context menu after right-clicking on a file.
Type boolean
Default Value false
Lock Level None
Name disableIntellittach
Description Enables or disables the Create Intellittach feature.
Type boolean
Default Value false
Name disableSend
Description Enables or disables sending logs. User could only save logs to disk.
Type boolean
Default Value false
Lock Level none
Name DisableEmailCreation
Description Enables or disables the creating email when logs are uploaded.
Type boolean
Default Value false
Lock Level none
Name EmailRecipient
Description Comma separated list of email recipients.
Type string
Default Value Edition dependent
Lock Level none
Example

<xdConfig>
  <globalSettings>
     <Reporting>
      <EmailRecipient>
        <gen:value>support</gen:value>
      </EmailRecipient>
     </Reporting>
   </globalSettings>
<xdConfig>

Name UploadUrl
Description Report upload URL.
Type string
Default Value Edition dependent
Lock Level none
Example

<xdConfig>
  <globalSettings>
     <Reporting>
      <UploadURL>
        <gen:value>https
      </UploadURL>
     </Reporting>
   </globalSettings>
<xdConfig>

Name Password
Description User password if authentication is required.
Type string
Default Value null
Lock Level none
Name disableVersioning
Description Enables or disables the Create Versioning feature.
Type boolean
Default Value false
Name DisableVersioningStateChange
Description Defines if the options Enable Versioning and Disable Versioning on a file will be available to the user.
Type boolean
Default Value false
Lock Level None
Name DisableCheckoutStateChange
Description Defines if the options Check Out, Check In and Undo Check Out on a file will be available to the user.
Type boolean
Default Value false
Lock Level None
Name DisableManualLockStateChange
Description Defines if the options Lock and Unlock on a file will be available to a user.
Type boolean
Default Value false
Lock Level None
Name ConcurrentAccessPolicy
Description During a file open, a test is performed if the file is locked by someone else. This option defines what will happen when such lock is discovered. If the application which opens the file is not in the AlwaysNotifyList or NeverNotifyList and the file is opened only with the read access, then the file is opened normally without any notification. Also when the file is opened only for reading file attributes, it is opened normally without any notification.

ALLOW - The file will have only read-only attribute and will open normally.
WARNING - The file will have the read-only attribute, will open normally and a notification window will be displayed by whom the file is locked.
DENY - The open will fail with the access deny error and a notification window will be displayed by whom the file is locked.
Type enum
Default Value WARNING
Lock Level None
Name AlwaysNotifyList
Description When a file is locked by a different user and the file is opened by an application which process name is in this list, depending on the ConcurrentAccessPolicy setting a notification will be displayed even if the open is performed only with the read only access. You can add processes. For example, if you want to add application notepad++, because it's known to not keep file opened during editing, you can do it like this:

 <AlwaysNotifyList>
    <gen:newElement gen:guid="Notepad++" gen:val="notepad++.exe"/>
 </AlwaysNotifyList>

Type list
Default Value Notepad, Wordpad, Microsoft Excel, Microsoft Excel Compatibility Pack, Microsoft Word, Microsoft Word Compatibility Pack, Microsoft PowerPoint, Microsoft PowerPoint Compatibility Pack, Paint, Word Perfect, MS Office Publisher, MS Office Outlook, Visio, Visio 2000, Microsoft Project, Microsoft FrontPage, GVim, WinRAR, WinZip, Flash Professional
Lock Level None
Name NeverNotifyList
Description When a file is locked by a different user and the file is opened by an application which process name is in this list, a notification will never be displayed regardless the ConcurrentAccessPolicy setting and even if the file is opened with the write access. You can add processes. For example, if you want to add application notepad++, because it's known to not keep file opened during editing, you can do it like this:

 <NeverNotifyList>
    <gen:newElement gen:guid="Notepad++" gen:val="notepad++.exe"/>
 </NeverNotifyList>

Type list
Default Value Explorer, Total Commander, Total Commander 64, Salamander, Windows Commander, cmd.exe, ESET Smart Security, svchost.exe, Dropbox
Lock Level None
Name NotificationSuppressTime
Description No notification for the the same file and the same process will be displayed during the time interval defined by this value. This prevents displaying multiple identical notifications in a short time.
Type integer
Default Value 10
Lock Level None
Name userList
Description The template which creates all user settings is updated through
gen:updateListType.
Type string
Default Value None
Name updateListType
Description The template which creates all volumes is updated through gen:updateListType.
Type string
Default Value <gen:updateListType>
Name cookiesPolicyAccepted
Description The value of this item is used for displaying privacy information dialog containing cookies policy information at the startup for the user. If the value is "false" (default value) the dialog is displayed at the startup. If the cookie policy is accepted by clicking appropriate button in the cookies policy dialog the "True" value is stored to this item and dialog is never more shown for the user at the startup (till "True" value is presented in this item).
Type boolean
Default Value false
Lock Level None
Name logDirectory
Description It is the path to the directory where logs files are placed. For this path customization, you can use macros as described in Usage of macros in config
Type expstring
Example Windows Vista & 7 C:\Users\<username>\AppData\Local\logs\<Short Company name>\<Short Product name>\
Example Windows XP C:\Documents and Settings\<username>\Local Settings\Application Data\logs\<Short Company name>\<Short Product name>\
Default Value %TEMP%\logs\%SHORT_COMPANY_FOLDER%\%PRODUCT_FOLDER%\
Lock Level None
Name userCacheDir
Description It is the path to the directory where user cache files are placed. For this path customization, you can use macros as is described in Usage of macros in config
Type expstring
Default Value %LOCAL_APPLICATION_DATA%\%SHORT_COMPANY_FOLDER%\%PRODUCT_FOLDER%\cache
Example Windows Vista & Windows 7 C:\Users\<username>\AppData\Local\<Short Company name>\<Short Product name>\cache\
Example Windows XP C:\Documents and Settings\<username>\Local Settings\Application Data\<Short Company name>\<Short Product name>\cache\
Lock Level None
Name username
Description Name of a user used to authenticate against a remote server.
Type string
Default Value None
Lock Level None
Example

<username>
   <gen:value>testuser1</gen:value>
</username>

Name serverTimeDifferenceWarning
Description This value specifies the tolerance for difference of time between server and client machine. If time lag is higher than this value, info message box will be displayed to the user. Time is set in seconds
Type integer
Default Value 300
Lock Level None
Name activityNotificationSettings
Description This list of values sets how notification window is displayed. There are two types of dialogs:
  - One displays progress bar of uploaded/downloaded file. This is called Slow operations
  - Second is displayed when a lot of small operations are detected. It shows an indeterminate progress bar. This is called Fast operations.
Structure - slowOperations
    - notificationDelay
    - showNotification
- fastOperations
    - sampleInterval
    - operationCount
    - showNotification
    - dismissExpirationTime
Type - slowOperations
    - notificationDelay : integer
    - showNotification : boolean
- fastOperations
    - sampleInterval :integer
    - operationCount : integer
    - showNotification: boolean
    - dismissExpirationTime: integer
Default Value - slowOperations
    - notificationDelay : 5
    - showNotification : true
- fastOperations
    - sampleInterval :3
    - operationCount : 10
    - showNotification: true
    - dismissExpirationTime: 30
Lock Level None
Name trayIconSettings
Description Tray icon settings section:
  - showIconVisibilityTip: Enables/disable tip, that suggests user to set Tray icon to always visible
  - iconVisibilityTipTime: Tray icon tip visible time (seconds)
Structure  - showIconVisibilityTip
  - iconVisibilityTipTime
Type - showIconVisibilityTip : boolean
 - iconVisibilityTipTime : integer
Default Value - showIconVisibilityTip : true
 - iconVisibilityTipTime : 30
Lock Level None
Name showConflictDiscardConfirmation
Description When set to 'True', a confirmation dialog is shown when the user clicks the Discard button on the conflict resolution dialog. This confirmation dialog warns user that continuing will discard current file version, potentially resulting in a data loss, and provides him option to change mind.
Type boolean
Default Value true
Lock Level None
Name confirmDisconnect
Description When set to True, a confirmation dialog is shown when a user clicks the Disconnect button on the ConnectionPanel. This confirmation dialog warns users that they will disconnect the volume and provides the option to cancel the action.
Type boolean
Default Value true
Lock Level None
Name disableIntellilinkOpen
Description Setting this option to True disables opening Intellilinks using Drive
Type boolean
Default Value false
Lock Level None
Name IntellittachType
Description Defines the default Intellittach type. The default type is selected in the Create Intellittach dialog by default.
Possible values include LINK - create links by default and TICKET - create tickets by default.
Type string
Default Value Ticket
Name ShowIntellittachDialog
Description Disables or enables the Create Intellittach dialog. When set to false, the dialog is not displayed and the link or ticket is created according to default values.
Type boolean
Default Value true
Name IntellittachUploadVolumeGUID (added in version 1.7 SP2)
Description If user tries to create an Intellilink on a local file, this file must be uploaded to the Drive volume first. Volume with this GUID will be used to store local files. Files will be uploaded into folder defined by IntellittachUploadVolumeDirectory
Type string
Default Value empty string
Lock Level None
Name IntellittachUploadVolumeDirectory (added in version 1.7 SP2)
Description If a user tries to create an Intellilink on a local file, this file must be uploaded to the drive volume first. Files will be uploaded into this directory on volume (if) defined by IntellittachUploadVolumeGUID
Type string
Default Value empty string
Lock Level None
Name ReadOnly
Description Defines the ticket privilege
False = Read & Write
True = Read Only
Type boolean
Default Value true
Lock Level None
Name Timeout
Description Defines the number of time units for the ticket lifetime defined in the TimeoutUnit. Value 0 means that the timeout is set to infinite.
Type integer
Default Value 30
Lock Level None
Name TimeoutUnit
Description The timeout unit for ticket lifetime. The number of units is defined in Timeout
Possible values include:
  • Minutes
  • Hours
  • Days
  • Weeks
  • Years
Type string
Default Value Days
Lock Level None
Name PasswordProtected 
Description If set to true, the "Password Enable this Ticket" checkbox on the Ticket Options dialog is checked by default and tickets are created with a password from the "Ticket Password" text field. When this value is set to true and PasswordProtectedChangeAllowed is set to false, the user is not allowed to create a ticket without a password.
Type boolean
Default Value false
Lock Level None
Name PasswordProtectedChangeAllowed
Description When set to true, a status of the check box indicating usage of password in the dialog for creating a ticket is changeable.
Type boolean
Default Value true
Lock Level None
Example

<intellittachsettings>
  <ticket>
    <passwordprotected>
      <value>True</value>
    </passwordprotected>
    <passwordprotectedchangeallowed>
      <value>False</value>
    </passwordprotectedchangeallowed>
  </ticket>
</intellittachsettings>

Name proxyList
Description List of user proxies. By default the list contains only one MainProxy only. Currently Blackboard Drive is able to operate with one proxy and does not give a user chance to maintain more of them. This is likely to change in future releases.
Type  
Default Value <gen:updateElement gen:templateguid="Xythos;15:03:08 14:14:46 +0100;MainProxy">
Name MainProxy
Description Currently Blackboard Drive is able to operate only with one proxy and does not give user chance to maintain more of them. The setting of this main proxy ("MainProxy") is created according to "proxySettings (template)" and contains following items:
  • proxyUsage
  • proxyServer
  • proxyPort
  • proxyUsername
  • proxyPassword
Guide Xythos;15:03:08 14:14:46 +0100;MainProxy
Type proxySettings (template)
Values
  • proxyUsage - "DONT_USE_PROXY", not locked
  • proxyServer - "", not locked
  • proxyPort - 8080, not locked
  • proxyUsername - "", not locked
  • proxyPassword - "", not locked
Name proxyUsage
Description Possible values:
  • DONT_USE_PROXY(default)
  • USE_PROXY
  • AUTO_DETECT

To force proxy usage by a user, add attributes gen:locks="edit".

Type enum
Default Value DONT_USE_PROXY
Lock Level None
Name proxyServer
Description The url of proxy server without port.
Type string
Default Value None
Name proxyPort
Description The port of proxy server. It has to be from the correct port range.
Type integer
Default Value 8080
Lock Level None
Name proxyUsername
Description User name for authentication
Type string
Default Value None
Lock Level None
Name proxyPassword
Description Proxy password for authentication
This setting can be used when it's necessary to set the proxy password through the massconfig. Passwords entered by the user are not stored in the massconfig, they are always stored into the local password storage.
  • If there is a password in the massconfig and there is no password in the password storage, the massconfig password will be used
  • If there is a password in the massconfig and there is a password in the password storage, the password from the password storage will be used
  • If there is a password in the massconfig and this password is locked and there is a password in the password storage, the massconfig password will be used
  • If there is no password in the massconfig and there is a password in the password storage, the password from the password storage will be used
Type string
Default Value None
Lock Level None
Name volumeList
Description List of all users' volumes.
Type list
Default Value None
Name name
Description The name of volume. For volume, it is mandatory to have its unique name
The name must match with the following regex pattern: [a-zA-Z_0-9]+[a-zA-Z_0-9-:\.]*
Type string
Default Value None
Lock Level None
Name defaultMountPoint
Description The place in the system where should be this volume mounted. It must be a letter and colon (for example, "F:").
If the value of defaultMountPoint is not valid or is empty, Drive uses the first available (unused) drive letter as mountPoint
Type string
Default Value None
Lock Level None
Name server
Description The url of server where the volume should be connected. It must be valid url.
Type string
Default Value None
Lock Level None
Example <server gen:locks="edit">    <!-- The server can not be changed in this volume due to edit lock -->
   <gen:value>https://xp:444</gen:value>
</server>
Name serverUrlCustomerConstraint
Description The server volume constraint where the volume should be connected. Represented as regular expression.
Type string
Default Value None
Lock Level None
Example

<server>
   <gen:constraintData gen:name="serverUrlCustomerConstraint">
   <gen:value>.*as91sp14\.com.*</gen:value>
   </gen:constraintData>
</server>

Name username
Description Name of the user used to authenticate against remote server
Type string
Default Value None
Lock Level None
Name password
Description Volume password for authentication.
This setting can be used when it's necessary to set the volume password through the massconfig. Passwords entered by the user are not stored in the massconfig, they are always stored into the local password storage.
  1. If there is a password in the massconfig and there is no password in the password storage, the massconfig password will be used.
  2. If there is a password in the massconfig and there is a password in the password storage, the password from the password storage will be used.
  3. If there is a password in the massconfig and this password is locked and there is a password in the password storage, the massconfig password will be used.
  4.  If there is no password in the massconfig and there is a password in the password storage, the password from the password storage will be used.
Type string
Default Value None
Lock Level None
Name bypassProxy
Description If True, the proxy will not be used for the connection of this volume to remote server (even if otherwise the proxy is used).
Type boolean
Default Value false
Lock Level None
Name autoConnectAfterStart
Description Tells the Drive if this volume should be automatically connected after start.
Possible values: DISCONNECTED - default value, the volume stays disconnected; ONLINE - the volume will be connected.
Type enum
Default Value DISCONNECTED
Lock Level None
Example <autoConnectAfterStart gen:val="DISCONNECTED"/>
Name openFileManagerUponConnection
Description If True, the default file manager window will be opened immediately after volume connection.
Type boolean
Default Value false
Lock Level None
Example

<openFileManagerUponConnection>
   <gen:value>True</gen:value>
</openFileManagerUponConnection>

Name sharingLevel
Description The sharing level which should be used for this volume. Possible values are names of sharing levels from the sharingLevelList.
Possible values: None, Light, Medium, Heavy (or name of any new sharing level created by administrator)
Type boolean
Default Value false
Lock Level None
Name preventShellFilePreview
Description When set to True the metadata and icons associated with files are not downloaded nor displayed in file managers like Windows Explorer.
Type boolean
Default Value false
Lock Level None
Name PreventShellFolderPreview
Description When set to true the metadata and icons associated with folders are not downloaded nor displayed in file managers like Windows Explorer.
Type boolean
Default Value false
Lock Level None
Name language
Description Language to use. The value must be one of the ISO language codes
Type string
Default Value en
Lock Level None
Name country
Description One of the country ISO codes
Type string
Default Value US
Lock Level None
Name appsThatKeepFileClosedWhileEditing
Description A list of process names, which does not keep file opened during editing. The list helps to decide for example when to auto-unlock the opened file - such file cannot be unlocked after last fs close, but we have to wait for closing the whole application.
You can add processes which are known to behave as described. For example, if you want to add notepad++ application, because it is known it does not keep file opened during editing, you can do it like this:

<appsThatKeepFileClosedWhileEditing>
   <gen:newElement gen:guid="notepad+.exe" gen:val="notepad+.exe"/>
</appsThatKeepFileClosedWhileEditing>

Type list
Default Value notepad.exe, wordpad.exe
Lock Level None
Example

<appsThatKeepFileClosedWhileEditing>
   <!-- Add additional processes -->
   <gen:newElement gen:guid="NameOfProcess">
      <gen:value>NameOfProcess</gen:value>
   </gen:newElement>
   <!-- You can delete any of the predefined processes Preview and Numbers from the appsThatKeepFileClosedWhileEditing list by using the prefix "guid:" and the delimiter "|" -->
   <!-- guid:Preview|guid:Numbers -->
</appsThatKeepFileClosedWhileEditing>

Name manualLockTimeout
Description Timeout for manual lock. Note, that the server has right to override this value. In seconds.
Type longnum
Default Value 86400
Lock Level None
Name directoryItemCountLimit (added in 1.7 SP1)
Description Limit the number of items displayed in a single folder listing. Note: The limit is applied on the list of items directly received from the server. Another system/configuration specific filtering may remove additional items, so user sees less items than given limit in actual folder. Example of such file is ".DS_Store".
Type integer
Default Value 0 (=unlimited)
Lock Level None
Name ignoreFileManagerDBFile
Description When this value is set to True, the file manager's cache file is not created, read or written to. The name of the cachefile to ignore can be set using fileManagerDBFile config item for example, the file named Thumbs.db
Type boolean
Default Value true
Lock Level None
Name FileManagerDBFile
Description The name of a file manager's file which is ignored by the Drive when the other config item ignoreFileManagerDBFile is set to True.
Type string
Default Value Thumbs.db
Lock Level None
Name lockTimeout
Description Time in seconds, after which the autolock on a file on the server expires. The value is sent to the server when locking a file. Note that WebDAV server may not respect this value and may use its own preferred value.
Type longnum
Default Value 900
Lock Level Edition
Example <lockTimeout> <gen:value>900</gen:value> </lockTimeout>
Name refreshPeriod
Description The time in seconds after which the autolock is refreshed if a document is still opened.
Type longnum
Default Value 300
Lock Level None
Example <refreshPeriod> <gen:value>300</gen:value> </refreshPeriod>
Name unblockFileAfterAppCloseTimeout
Description The time after which the file is considered to be really closed, measured since closure of the application used to edit the file.
Type longnum
Default Value 3
Lock Level None
Name normalUnlockDelay
Description The time after which the file is considered to be really closed. Measured since the close which makes the open count on the file equal zero. Applicable only to the processes not listed in appsThatKeepFileClosed list. For example, after this timeout file is auto-unlocked.
Type longnum
Default Value 5
Lock Level None
Name neverLockList
Description A list of names of such processes, which will not autolock a file even if they open the file for writing. You can add new processes. For example, if you want to add the file manager servant salamander, you can do it like this:

<neverLockList>
    <gen:newElement gen:guid="salamand.exe" gen:val="salamand.exe"/>
</neverLockList>

Type list
Default Value explorer.exe, totalcmd.exe
Lock Level None
Example

<neverLockList>
    <!-- you can add and delete applications as in appsThatKeepFileClosedWhileEditing -->
    <gen:newElement gen:val="NameOfProcess" gen:guid="NameOfProcess"/>
    <!-- <gen:delListedElements>guid:Finder</gen:delListedElements> -->
</neverLockList>

Name alwaysLockList
Description A list of names of processes, for which autolocking will be invoked even when the file is opened just for read.

You can add processes. For example, if you want to add application notepad++, because its known to does not keep file opened during editing, you can do it like this:

<alwaysLockList>
   <gen:newElement gen:guid="notepad+

Type list
Default Value notepad.exe, wordpad.exe, powerpnt.exe, ppcnvcom.exe
Name connectTimeout
Description How long will Drive wait for server response on initial volume connect. In seconds.
Type integer
Default Value 10
Lock Level None
Example <connectTimeout> <gen:value>20</gen:value> </connectTimeout>
Name localConnectivityRecoveryTimeout
Description The timeout determines the maximum period for which the HTTP request might be postponed in case the local connectivity was lost. The local connectivity can be lost after resuming the computer from sleep mode or while switching between networks like Wi-Fi to Wi-Fi, Wi-Fi to Ethernet or Ethernet to Wi-Fi. Note that accidentally Java can cache negative DNS request for some period (by default 10 seconds: see the property sun.net.inetaddr.negative.ttl in java.security file) so this interval should be also taken into account.
Type integer
Default Value 30
Lock Level None
Since Version 1.6 SP2
Name defaultMethodTimeout
Description Defines default socket timeout for methods (SO_TIMEOUT), which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets. A timeout value of zero is interpreted as an infinite timeout. If this parameter is not set, operations will not time out (infinite timeout).

This value will be applied to all methods except those which have their explicit values listed in MethodTimeoutsList.
In seconds.

Example of setting default method timeout to 100 seconds

...
<defaultMethodTimeout>
   <gen:value>100</gen:value>
</defaultMethodTimeout>
...

Type integer
Default Value 30
Name name
Description Method name (for example, DELETE, PROPFIND)
Type string
Default Value None
Lock Level None
Name timeout
Description The value of timeout for this method. In seconds
defaultMethodTimeout is used if timeout for particular method is not set
Type integer
Default Value 0
Lock Level None
Name PROPFIND
Description The record of timeout for PROPFIND method. Defines the socket timeout for PROPFIND methods (SO_TIMEOUT), which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets. A timeout value of zero is interpreted as an infinite timeout.
If this parameter is not set, defaultMethodTimeout is used
Type integer
Default Value 40
Lock Level None
Lock Level

<span class="code"><gen:updateElement gen:templateguid="Xythos;06:10:09 07:26:40 +0100;PROPFIND">
   <timeout gen:val="100"/>
</gen:updateElement>

Name DELETE
Description The record of timeout for DELETE method. Defines the socket timeout for DELETE methods (SO_TIMEOUT), which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets. A timeout value of zero is interpreted as an infinite timeout.
If this parameter is not set, defaultMethodTimeout is used
Type integer
Default Value 45
Lock Level None
Example

<gen:updateElement gen:templateguid="Xythos;06:10:09 07:28:30 +0100;DELETE">
   <timeout gen:val="100"/>
</gen:updateElement>

Name responseSizeLimit  (added in 1.7 SP1)
Description Limit the size of incoming server response in bytes. This setting allows to avoid processing of large PROPFINDs/dirlists containing tens of thousands of items, which may consume a lot of memory on the client.
Type longnum
Default Value 0 (=unlimited)
Lock Level None
Example

<dirmansettings>
  <protocolsettings>
    <webdav>
      <responsesizelimit>
        <value>0</value>
      </responsesizelimit>
    </webdav>
  </protocolsettings>
</dirmansettings>

Name cachedFileRetentionTime
Description Sets retention time for cached file
The retention time is the time before which newly downloaded/cached file can not be deleted during cache pruning. In minutes
Type integer
Default Value 15
Lock Level None
Name pruningMinimalTimeout
Description Minimal time after which XD cache pruning is started after previous pruning. In minutes.
Type string
Default Value 15
Lock Level None
Example <pruningMinimalTimeout><gen:value>15</gen:value></pruningMinimalTimeout>
Name cacheSize
Description Maximum cache size in megabytes (MB). The cache size can be temporarily greater than the value set here - for example, due to working with a large file, which size is greater than the cacheSize. Note that the small cache size (which often leads to cache pruning) may result in very bad user experience.
Type integer
Default Value <cacheSize gen:val="512"/>
Name clearCacheOnServerDisconnect
Description If set to True, the cache from a server is cleared after disconnection from the server.
Type boolean
Default Value false
Lock Level None
Example <cacheSize><gen:value>1024</gen:value></cacheSize>
Name alwaysLocalFilesList
Description List of regular expressions. If a filename matches one of the expressions in this list, the file is considered local (is not uploaded).

You can add new regular expressions:

<alwaysLocalFilesList>
    <gen:newElement gen:guid="mytmp" gen:val=".*\.mytmp"/>
</alwaysLocalFilesList>

Type list
Default Value There are 2 default values: "(\.[^\.]*|\.\..+))", "\.DS_Store" and "\.appdisk"
Name alwaysLocalDirectoriesList
Description List of regular expressions. If a directory name matches one of the expressions in this list, the directory is considered local (as well as its content). You can add new regular expressionss:
You can add new regular expressions:

<alwaysLocalDirectoriesList>
   <gen:newElement gen:guid="mytmp" gen:val=".*\.mytmpdir"/>
</alwaysLocalDirectoriesList>

Type list
Default Value
  • \.TemporaryItems
  • \.Trashes
  • \.fseventsd
Lock Level None
Name className
Description The full name of a class which implements com.xythos.client.drive.fs.filters.AppFilter interface.
For example "com.xythos.client.drive.fs.filters.AppFilterGeneric"
Type string
Default Value None
Lock Level None
Name OS
Description The OS for which should be the filter used if it is active (isActive is True)
Possible values:
  • Mac - will be used only when running Mac
  • Win - will be used only when running Win
  • General - will be used on every system
Type enum
Default Value None
Lock Level None
Name isActive
Description If True, this application filter will be used
Type boolean
Default Value true
Lock Level None
Name checkBeforeOpenTimeout
Description Filter can change the checkBeforeOpenTimeout otherwise gained from sharing level settings. In this way, different checkBeforeOpenTimeout for different applications and scenarios can be used
Time in milliseconds
Type integer
Default Value None
Lock Level None
Name uploadEmptyFile
Description If True, this filter will make sure no zero-length file will be uploaded when such file is created by scenario where this filter is involved
Type boolean
Default Value true
Lock Level None
Name delayedUploadTime
Description The time for which should be upload of a file delayed. It is common that editors create temporary files which are created and immediately deleted. If the time between creation and deletion of such file is lesser than the value of delayedUploadTime, no remote operation is issued
Time in milliseconds
Type integer
Default Value 0
Lock Level None
Name enabledApplications
Description List of applications for which the filter is enabled. If enabledApplications is defined then the filter will be used just with these apps. If disabledApplications is defined then the filter will be used for all applications excluding these. You can add the processes:

<disabledApplications>
    <gen:newElement gen:guid="notepad.exe" gen:val="notepad.exe"/>
</disabledApplications>

Type list
Default Value None
Lock Level None
Example

<gen:updateElement gen:templateguid="Xythos;10:11:10 11:34:00 +0100;WinGeneric">
   <ensabledApplications>
     <gen:newElement gen:val="NameOfProcess" gen:guid="NameOfProcess"/>
     <!-- <gen:delListedElements>guid:Explorer</gen:delListedElements> -->
   </enabledApplications>
</gen:updateElement>

Name disabledApplications
Description List of applications for which the filter is disabled. If enabledApplications is defined then the filter will be used
just with these apps. If disabledApplications is defined then the filter will be used for all applications excluding these.

You can add processes:

<disabledApplications>
     <gen:newElement gen:guid="notepad.exe" gen:val="notepad.exe"/>

Type list
Default Value None
Lock Level None
Name applicationDescription
Description Description of applications for which the filter should be applied
Type string
Default Value None
Lock Level None
Name tempFileRegexPatterns
Description List of regular expressions. If the lower case version of a file name matches a regex from this list, the file is considered to be a temporary file. Note that if a regex contains concrete alphabet characters they must be in the lower case like in the example below.
For example the modification of regex ".*\.TMP" or ".*\.Tmp" from the example below would not work for us.
Type string
Default Value None
Lock Level None
Example

<tempFileRegexPatterns>
     <gen:newElement gen:guid="tempFile-*.tmp" gen:val=".*\.tmp"/>
</tempFileRegexPatterns>

Name SuppressShellInfoTip
Description It suppresses Window Explorer's default behavior when the user hovers the mouse over a folder. InfoTip is not shown.
Type boolean
Default Value true
Name userDataDir
Description The location which will be used for data storing during disaster recovery. The default location is user home. For this path customization, you can use macros as is described in Usage of macros in config
Type expstring
Default Value %USER_HOME%
Example Windows Vista & Windows 7 C:\Users\<username>\
Example Windows XP C:\Documents and Settings\<username>\
Lock Level None