Purpose of the program
The ayfie Document Handler is a native ayfie utility for Windows used for opening search result links. It extends the functionality of the search results page.
While ayfie offers a solution that lets users "download a copy" of the searched document, this is not optimal for users who want to start working on their documents right away. The Document Handler solves this problem. It enables the web client to communicate with end user desktops to open files directly in the user's native application.
Architecture Overview
When the user clicks a Document Handler link (“vw:”) on the ayfie search page, the browser will look in the Windows registry for the application registered to handle this URI scheme. This is supported by the most common web browsers (e.g. Internet Explorer, Firefox and Chrome). The ayfie Document Handler executable will then be launched, with the entire URI as input to the executable.
The Document Handler will then parse the input parameters and check if it’s the first instance of the program in memory. If it’s not (i.e. another Document Handler instance is already running), it will ask the first instance to handle the request, and the second instance will then exit.
The Document Handler will then process the request. It will load the corresponding plugin (e.g. Exchange protocol handler plugin to handle opening items from Exchange). The plugin will then try to open up the specified item.
You can read more about custom protocol handlers at http://msdn.microsoft.com/en-us/library/aa767914(v=vs.85).aspx
Changes made to the system
File-system
Version | Default installation destination |
Single User | c:\Users\<User>\AppData\Local\Apps\Locator DocumentHandler |
Multi User | c:\Program Files (x86)\Virtual Works\Locator DocumentHandler |
File | Description |
log4net.dll | 3rd party component used for logging |
log.config | Configuration file for logging |
InstallLogging.config | Configuration file for logging |
Via.SDK.ConnectorPlugins.dll | Locator platform assembly |
Via.Client.Components.Core.dll | Locator platform assembly |
Via.Utility.dll | Locator platform assembly |
Via.Application.DocumentHandler.exe | The main executable |
Via.Application.DocumentHandler.exe.config | Application configuration file |
Via.DocumentHandler.Service.exe | Document Handler service – only installed for multi-user version of Document Handler. |
AutomaticUpdater.dll | 3rd party component used for automatic updates |
wyUpdate.exe | 3rd party component used for automatic updates |
client.wyc | 3rd party component used for automatic updates |
OFFICE.DLL | Microsoft Office Core Primary Interop assembly |
| Via.Alfresco.ProtocolHandler.Plugin.dll | Plugin to handle documents from Alfresco |
Via.Domino.ProtocolHandler.Plugin.dll | Plugin to handle documents from IBM Domino |
| Via.EdocsDM.ProtocolHandler.Plugin.dll | Plugin to handle documents from eDOCS DM |
Via.Exchange.ProtocolHandler.Plugin.dll | Plugin to handle documents from Microsoft Exchange |
Via.FileServer.ProtocolHandler.Plugin.dll | Plugin to handle documents from a fileserver |
| Via.LoboDMS.ProtocolHandler.Plugin | Plugin to handle documents from LoboDMS |
| Via.WorkSite.ProtocolHandler.Plugin | Plugin to handle documents from WorkSite |
In addition, we install Microsoft .NET Framework v4.0 for Document Handler v2.1 and older, and v4.5 for for Document Handler v2.2 and newer – if you use the single user executable (not the MSI’s).
Windows Registry
Key | Description |
Vw | The VirtualWorks protocol that we register – vw for short. |
ViaWorksDocumentHandler | Used to automatically run Document Handler when Windows starts |
Single User Version
Key | Path |
Vw | HKEY_CURRENT_USER\Software\Classes |
ViaWorksDocumentHandler | HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run
|
Multi User Version
Key | Path |
Vw | HKEY_CLASSES_ROOT |
ViaWorksDocumentHandler | HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Run |
Windows Services
To avoid complications, such as having a “port-listening-process” for each terminal server user logged in, and to ensure proper functioning, the Document Handler Multi User version installs a Windows service named “ayfie DocumentHandler Service”, running under the Local System account.
werwer
Resources used
...