Protocol Application Detection and Installation

The DocManager functions that open documents and file manager provide a callback parameter to be executed if no required protocol is installed on a client machine. If the protocol is not installed, the callback function is executed. In this callback, you will typically request a protocol application installation and will redirect to the installer download, depending on the client OS.

As soon as every OS requires its own installer, the IT Hit WebDAV Ajax Client library provides DocManager.GetInstallFileName() function that returns installer file name depending on OS on which the client code is executed. The WebDAV Ajax Library is provided with protocol applications for Windows, Max OS X and Linux, that are located in the /Plugins/ folder in the archive.

Below is typical callback implementation: 

ITHit.WebDAV.Client.DocManager.EditDocument("https://server/folder/file.ext", "/", protocolInstallCallback);
            
// Called if protocol handler is not installed
function protocolInstallCallback(message) {
      var installerFilePath = "/Plugins/" + ITHit.WebDAV.Client.DocManager.GetInstallFileName();
            
      if (confirm("This action requires a protocol installation. Select OK to download the protocol installer.")){
           window.open(installerFilePath);
      }
}

Web Browser Extensions

The WebDAV Ajax Library v4 is provided with Google Chrome and Safari web browser extensions that help detecting protocol application presence and make document opening reliable and fast. Web browser extensions are automatically installed during protocol application installation.

FireFox, Edge and IE do not require web browser extensions.

Important! After installing web browser extensions you must reload a web page.

Google Chrome Edit Document Opener Extension

The Edit Document Opener Google Chrome extension is installed automatically with Edit Document Opener protocol application on Windows, Mac OS X and Linux. It is required by protocol application and must be enabled if you are using Google Chrome.

Important! If Google Chrome Extension is manually uninstalled it will not be automatically reinstalled with protocol app installation. You must manually install the extension from Chrome Web Store. This is a Google Chrome limitation. In this case use the following link to install the extension: https://chrome.google.com/webstore/detail/it-hit-edit-document-open/cjjlbggljfhecdnkfdpajagmiidgengd

When opening Google Chrome first time after installation you will see a notification that a IT Hit Edit Document Opener extension was installed:

 Notification that a IT Hit Edit Document Opener Chrome extension was added.

 

Enable the IT Hit Edit Document Opener extension:

 Enable IT Hit Edit Document Opener Chrome extension.

 

If the Google Chrome extension is disabled or uninstalled for any reason, the protocol application would not function in Google Chrome. If the IT Hit Edit Document Opener protocol application can not be detected in Google Chrome and requesting installation, the first thing to do it to check that the extension is installed and enabled: 

 Check that IT Hit Edit Document Opener Chrome extension is installed and enabled.

Safari Edit Document Opener Extension

The Edit Document Opener Safari extension is installed automatically with Edit Document Opener protocol application on Mac OS X. It is required by protocol application and must be enabled if you are using Safari.

After the protocol application installation wizard completes, the Safari Preferences dialog will automatically open, offering Safari extension installation. Select "Trust" to install the extension: 

Safari Edit Document Opener extension

If the Safari extension is disabled or uninstalled for any reason, the protocol application would not function in Safari. If the IT Hit Edit Document Opener protocol application can not be detected in Safari and requesting installation, the first thing to do it to check that the extension is installed and enabled. You can find the extension in Safari preferences on Extensions tab: