This administrator guide provides instructions and information for running the Blackboard Drive for Mass Configuration (Mass Config) utility. The Mass Config is used for configuration of Blackboard Drive installations for the end users. 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 other options such as cache size.
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 section (below) 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://as91sp6 and prevent the user from updating this value, the configuration file would include a definition like the following:
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.
|Description||This version number must be present, and match the version number in the massUpdateCurrentVersion in update-info.xml. This file and update-info.xml must always be in sync with the version information.|
|Description||The template which creates all user settings is updated through gen:updateListType.|
|Description||The location where cache data will be stored - absolute path. The default location is ~//Library/Application/Support/Blackboard/Drive/cache.|
|Default Value||<userCacheDir gen:val="/Users/jsmith/test/mycachedir"/>|
|Description||The location which will be used for data storing during disaster recovery. The default location is user home.|
|Default Value||<userDataDir gen:val="/Users/jsmith/test/mydatadir"/>|
|Description||List of user proxies. By default the list contains only one main proxy 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.|
|Default Value||<gen:updateElement gen:templateguid="Xythos;15:03:08 14:14:46 +0100;MainProxy">|
|Description||This value decides if this proxy will be used or not. Possible values are:
DONT_USE_PROXY - no proxy will be used
USE_PROXY - use this proxy with its settings
AUTO_DETECT - auto-detect the proxy (from system) and use just username and pwd.
|Description||The URL of proxy server without port.|
|Description||The port of proxy server. It has to be from the correct port range.|
|Default Value||The default proxy port value is 8080 and typically does not need to be modified.|
|Description||List of all users' volumes.|
|Description||The template which creates all volumes is updated through gen:updateListType.|
|Description||Name of a user used to authenticate against remote server.|
|Description||The url of server where the volume should be connected. It must be valid URL.|
|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-:\.]*
|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).|
|Description||Tells the Drive if this volume should be automatically connected after start.
DISCONNECTED - default value, the volume stays disconnected
ONLINE - the volume will be connected.
|Default Value||<autoConnectAfterStart gen:val="DISCONNECTED"/>|
|Description||If true, the default file manager window will be opened immediately after volume connection.|
|Description||Timeout for autolock in seconds.|
|Default Value||<lockTimeout> <gen:value>900</gen:value>|
|Description||The time in seconds after which the autolock is refreshed if a document is still opened.|
|Default Value||<refreshPeriod> <gen:value>3</gen:value>|
|Description||The time after which the file is considered to be really closed, measured since closure of the application used to edit the file.|
|Default Value||<refreshPeriod> <gen:value>3</gen:value>|
|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.|
|Description||A list of process names, which does not keep file opened during editing. The list helps to decide e.g. 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:
|Default Value||Mac - TextEdit, Preview, Pages, Keynote, Numbers|
|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:
|Default Value||Mac - Finder, quicklookd, Preview, mv, cp|
|Description||A list of names of processes, for which autolocking will be invoked even if the file is opened only for read. You can add processes. For example if you want to add application Notepad++, because it is known it does not keep file opened during editing, you can do it like this:
|Default Value||Mac - TextEdit, Microsoft Word, Microsoft Excel, Microsoft PowerP, Pages, Keynote, Numbers|
|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 which are not listed in appsThatKeepFileClosed list.For example, after this timeout file is auto-unlocked.|
|Default Value||<normalUnlockDelay> <gen:value>5</gen:value>|
|Description||A list of process names for which the filter will not be applied.
You can add the processess:
|Default Value||Is empty|
|Description||How long will Drive wait for server response on initial volume connect. In seconds.|
|Default Value||<connectTimeout> <gen:value>10</gen:value>|
|Description||How long will Drive wait for server response on a method. This value will be applied to all methods except those which have their explicit values listed in MethodTimeoutsList. In seconds.|
|Default Value||<defaultMethodTimeout> <gen:value>30</gen:value>|
|Description||Minimal time after which XD cache pruning is started after previous prunning In minutes.|
|Default Value||<pruningMinimalTimeout gen:val="15"/>|
|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.|
|Default Value||<cacheSize gen:val="512"/>|
|Description||If set to true, the cache from a server is cleared after disconnection from the server.|
|Description||List of regular expressions. If a filename matches one of the expressions in this list, the file is considered to be local (is not uploaded).
You can add new regular expressions:
|Default Value||"(\.[^\.]*|\.\..+))" and "\.DS_Store"
|Description||This item defines lifetime of certain notification dialogs in seconds.|
|Description||The URL of Blackboard Drive help page.|
|Default Value||Depends on edition.|
|Description||Tells Blackboard Drive if a file should be checked for any recent change before open (by means of PROPFIND method). If Blackboard Drive finds out that the file was changed on server and the file contents in cache is stale, new download is issued.|
|Default Value||Depends on edition.|
|Description||If true and directory contents was cached, remote dirlist is not done.|
|Description||Time in miliseconds. Tells Blackboard Drive after how much time is cached dirlist or remote attributes considered out of date. The Drive does not need to honor this value. It serves as a hint.|
|Description||Disables adding of new file or folder remote attributes (for example, WebDAV properties) in Properties dialog. Modification or deletion of existing attributes is unaffected.|
|Description||Disables modifying existing file or folder remote attributes (for example, WebDav properties) values in Properties dialog. Adding or deletion of attributes is unaffected.|
|Description||Disables deleting existing file or folder remote attributes (for example, WebDAV properties) in Properties dialog. Adding or modification of attributes is unaffected.|
|Description||Allows to setup java system property java.security.auth.login.config for SPNEGO/KerberosV5 (Negotiate/KerberosV5) HTTP authentication. The value determines the location of login config file. The file must contain the configuration section named as com.xythos.client.http.auth.mac.NegotiateScheme. This file is not installed by XD for Mac Installer. This file is supposed to be distributed to the client machines by an administrator through 3-rd party tool or manually. Blackboard Drive for Mac has to be restarted to accept the file that has just been placed. This is Mac OS X platform specific option.|
|Description||Allows to setup java system property java.security.krb5.conf for SPNEGO/KerberosV5 (Negotiate/KerberosV5) HTTP authentication. The value determines the location of kerberos V5 config file. The file contains Kerberos configuration. The information includes mapping between domains and realms and Key Distribution Center host name for each realm. This file is not installed by XD for Mac Installer. This file is supposed to be distributed to the client machines by an administrator through third-party tool (for example, Apple Remote Desktop) or manually. Blackboard Drive for Mac has to be restarted to accept the file that has just been placed. This is Mac OS X platform specific option.|