Quark XML Author 9.0 - System Admin Guide

Application Configuration: XpressUpdates

Overview

Xpress Updates is a mechanism for pushing Quark XML Author software and configuration updates to existing Quark XML Author clients. Xpress Updates may update any Quark XML Author file except for the XpressAddIn.dll, including configuration files, starter documents, and XAS files.

Xpress Updates is loaded when Word is started, but before the Quark XML Author Add-in is loaded. Xpress Updates checks a manifest document located on a server. This manifest document contains information about files that are available for download. If the local files have an earlier timestamp than the available files, the user is notified that updates are available and prompted to download them. If the user selects Yes, the files are downloaded and Quark XML Author is loaded. If the user selects No, Quark XML Author is loaded without the new files being downloaded.

Note that the user must have write permission to the XML Author directory. If the user does not have write permission to the XML Author directory, the update operation will fail.

Xpress Updates does not provide end user control over the update mechanism. While the user may ignore or cancel an update through the dialog box, the user may not disable the update mechanism once the administrator has configured it. Nor may the user enable the update mechanism if the administrator disables it.

XpressUpdate.xml

XpressUpdate.xml is the configuration file for Xpress Updates, and is located in the XML Author application folder. It should be configured before building the client installation. Otherwise, the file would need to be copied manually to each client.

The file has the following structure:

<XpressUpdate xmlns="urn:invision:XpressUpdate">
  <ManifestLocation></ManifestLocation>
  <Credentials username="" password="" domain="">Windows</Credentials>
  <LogFile logging="true">XpressUpdateLog.txt</LogFile>
</XpressUpdate>

 

Each node is defined below.

ManifestLocation: The URL pointing to the manifest file that contains the file update information.

Credentials: Used during authentication on the update server. If the node contents specify Windows, the user’s Windows credentials are used. If the node contents specify Supplied, the values of the username, password, and domain attributes are used.

LogFile: If set to true, logging is turned on, and the node content specifies the name of the log file. If set to false, logging is turned off. The log file is located in the XML Author application folder.

Manifest.xml

Manifest.xml is the document returned by the server, and contains information about the files that are available to be updated. The file has the following structure:

<XpressUpdateManifest xmlns="urn:invision:XpressUpdateManifest">
  <FileRepository>http://localhost/XpressUpdates</FileRepository>
  <Files>
    <File name="file1" location="" dateTime="1/27/2005 10:33 PM"/>
    <File name="file2" location="" dateTime="1/27/2005 10:33 PM"/>
  </Files>
</XpressUpdateManifest>

 

The FileRepository node content specifies the location of the files available for download. Each File node in the Files element specifies the name, location, and timestamp for one available file. The File node attributes are defined below.

name: The name of the file that is available to be downloaded.

location: The path relative to the client application folder where the file will be downloaded to. For example, if the file will be downloaded to the \XML Author\quark\stylesheets directory, this value would be quark\stylesheets. If this attribute is omitted or left empty, the file is copied to the XML Author application folder.

dateTime: The timestamp to which current files are compared. If the existing file is older than the timestamp, it is replaced.

Dialogs

Xpress Updates uses two dialogs to allow the user to monitor update status as well as cancel updates if necessary. The first dialog informs the user that updates are being checked. This dialog will only be displayed if more than 3 seconds elapse before the manifest document is returned from the server. The dialog will automatically close when the manifest is finally retrieved. The user may click the Cancel button if the retrieval fails or takes too long.

The second dialog displays the files that are being downloaded and their status (Downloading, Complete, or Error). The dialog remains open until the user clicks the OK button. The user may click the Cancel button at any time to abort file downloading.