|
21 | 21 | <p>To run the example, you will need both IT Hit WebDAV Client Library for .NET license and IT Hit User File System Engine for .NET License. You can download <span>a trial licenses in the <a title="Download" href="https://www.webdavsystem.com/client/download/">IT Hit WebDAV Client Library product download area</a> and in <a title="Download" href="https://www.userfilesystem.com/download/">IT Hit User File System </a></span><a title="Download" href="https://www.userfilesystem.com/download/">product download area</a>. Note that this sample is fully functional with a trial license and does not have any limitations. The trial licenses are valid for one month will stop working after this. You can check the expiration date inside the license file. Download the licenses file and specify their content in the <span>WebDAVClientLicense and <span>UserFileSystemLicense</span></span> fields respectively in <span class="code">appsettings.json</span> file.</p> |
22 | 22 | <p>You can also run the sample without explicitly specifying a license for 5 days. In this case, the Engine will automatically request the trial licenses from the IT Hit website https://www.userfilesystem.com. Make sure it is accessible via firewalls if any. After 5 days the Engine will stop working. To extend the trial period you will need to download trial licenses and specify them in <span class="code">appsettings.json</span></p> |
23 | 23 | <h2>Running the Sample</h2> |
24 | | -<p>To run the sample open the project in Visual Studio and run the project in a debug mode. In the debug mode this sample provides additional support for the development and testing convenience. When starting in the debug mode, it will automatically create a folder in which the virtual file system will reside, register the user file system with the platform and then open an instance of Windows File Manager with a mounted file system as well as will launch a default web browser navigating to the WebDAV server url specified in your <span class="code">appsettings.json</span>.</p> |
| 24 | +<p>To run the sample open the project in Visual Studio and run the project in a debug mode. In the debug mode this sample provides additional support for the development and testing convenience. When starting in the debug mode, it will automatically create a folder in which the virtual file system will reside, register the user file system with the platform and then open an instance of Windows File Manager with a mounted file system as well as will launch a default web browser navigating to the WebDAV server url specified in your <span class="code">appsettings.json</span>:</p> |
| 25 | +<p><img id="__mcenew" alt="WebDAV Drive sample launches Windows File manager with mounted virtual file system displaying content of your WebDAV server" src="https://www.userfilesystem.com/media/2103/mapdrivesample1.png" rel="121895"></p> |
25 | 26 | <p>You can start managing and editing files on your WebDAV server and will see all changes being propagated to the file system on the client machine. You can also edit documents and manage file structure on the client and all changes will automatically be reflected on theWebDAV server.</p> |
26 | 27 | <h2>On-Demand Loading</h2> |
27 | 28 | <p>Initially, when you start the application, the user file system does not contain any file of folder placeholders, except the sync root folder. The content of the folders is populated only when any application is listing folder content. The content of files is loaded only when an application is opening a file for reading or writing.</p> |
28 | | -<p>After running the sample all files and folders are marked with a cloud icon<img id="__mcenew" alt="Offline File" src="https://www.userfilesystem.com/media/1988/offilefile.png" data-allowlink="false" rel="116798">, which means that the content of this file or folder is not available locally but instead resides in the remote location. Even though the file shows the correct size in the Size column, the file occupies zero bytes on the disk. You can open the file Properties dialog to check the "Size on disk" value. You can see in the console log that only root folder files and folders placeholders are being created when Windows File Manager listed the root folder content during initial launch. Folders located deeper in the hierarchy are not loaded, until their content is being requested by the platform file system calls. </p> |
29 | | -<p>When any application is accessing the file, located under the <span class="code">\DAV\</span> folder, opening it for reading or writing, the operating system redirects the call to this sample, which loads file content from the WebDAV server. The file becomes marked with a green check-mark on a white background icon<img id="__mcenew" alt="Local File" src="https://www.userfilesystem.com/media/1986/localfile.png" data-allowlink="false" rel="116799">, which means the file content is present on the local disk:</p> |
| 29 | +<p>After running the sample all files and folders are marked with a cloud icon<img id="__mcenew" alt="Offline File" src="https://www.userfilesystem.com/media/1988/offilefile.png" rel="116798" data-allowlink="false">, which means that the content of this file or folder is not available locally but instead resides in the remote location. Even though the file shows the correct size in the Size column, the file occupies zero bytes on the disk. You can open the file Properties dialog to check the "Size on disk" value. You can see in the console log that only root folder files and folders placeholders are being created when Windows File Manager listed the root folder content during initial launch. Folders located deeper in the hierarchy are not loaded, until their content is being requested by the platform file system calls. </p> |
| 30 | +<p>When any application is accessing the file, located under the <span class="code">\DAV\</span> folder, opening it for reading or writing, the operating system redirects the call to this sample, which loads file content from the WebDAV server. The file becomes marked with a green check-mark on a white background icon<img id="__mcenew" alt="Local File" src="https://www.userfilesystem.com/media/1986/localfile.png" rel="116799" data-allowlink="false">, which means the file content is present on the local disk:</p> |
30 | 31 | <p><img id="__mcenew" alt="Local Cloud File. Green check-mark on a white background icon means the file content is present on the local disk." src="https://www.userfilesystem.com/media/1983/localcloudfile.png" rel="116801"></p> |
31 | | -<p>The Windows File Manager provides the "Always keep on this device" and "Free up space" context menus, which are standard menus provided by Windows OS. If you select the "Always keep on this device" the file or entire folder structure will be recursively loaded to the local disk, all file content will be loaded to the local disk and will become available offline. All files and folders are marked with a pinned file icon<img id="__mcenew" alt="Pinned File" src="https://www.userfilesystem.com/media/1989/pinnedfile.png" data-allowlink="false" rel="116800">. Pinned files will not be deleted from the drive even if it runs low on space.</p> |
| 32 | +<p>The Windows File Manager provides the "Always keep on this device" and "Free up space" context menus, which are standard menus provided by Windows OS. If you select the "Always keep on this device" the file or entire folder structure will be recursively loaded to the local disk, all file content will be loaded to the local disk and will become available offline. All files and folders are marked with a pinned file icon<img id="__mcenew" alt="Pinned File" src="https://www.userfilesystem.com/media/1989/pinnedfile.png" rel="116800" data-allowlink="false">. Pinned files will not be deleted from the drive even if it runs low on space.</p> |
32 | 33 | <p><img id="__mcenew" alt="Always keep on this device menu will load all files to a loacal disk and will keep them from purging on low disk space." src="https://www.userfilesystem.com/media/1982/alwayskeeponthisdevice.png" rel="116802"></p> |
33 | | -<p>To remove content from the local disk select the "Free up space" menu. It will restore the cloud icon<img id="__mcenew" alt="Offline File" src="https://www.userfilesystem.com/media/1988/offilefile.png" data-allowlink="false" rel="116798">.</p> |
| 34 | +<p>To remove content from the local disk select the "Free up space" menu. It will restore the cloud icon<img id="__mcenew" alt="Offline File" src="https://www.userfilesystem.com/media/1988/offilefile.png" rel="116798" data-allowlink="false">.</p> |
34 | 35 | <p>When a large file is being downloaded from the WebDAV server, this sample submits progress reports to the operation system, to show a standard Windows "Downloading" dialog. At the same time, the Windows File Manager also shows progress in the files list view:</p> |
35 | 36 | <p><img id="__mcenew" alt="Large file download from the remote storage show progress reports in Windows File Manager and Files View" src="https://www.userfilesystem.com/media/1984/cloudfiledownloadprogress.png" rel="116804"></p> |
36 | 37 | <h2>Microsoft Office Documents Editing</h2> |
37 | 38 | <p>When a Microsoft Office document is being opened, the WebDAV Drive sample automatically locks the document on a WebDAV server:</p> |
38 | | -<p><img id="__mcenew" alt="Microsoft Office documents are automatically locked when opened for editing from the WebDAV Drive" src="https://www.userfilesystem.com/media/2101/msofficelockedsmall.png" rel="121877"></p> |
39 | | -<p>The information about the lock (lock-token, etc.) is being saved on the client machine. When a document is modified on the client, all changes to the document are being saved on the local drive, without being sent to the WebDAV server untill the file is unlocked. When the document is closed, the file content is being automatically sent to the server and than unlocked.</p> |
40 | | -<p>Any temporary Microsoft Office documents are stored in local file system only and are NOT synchronized to the server. Typically temporary Microsoft Office documents are being automatically deleted by Microsoft office when the document editing is completed.</p> |
| 39 | +<p><img id="__mcenew" alt="WebDAV Drive automatically locks Microsoft office document when it is being opened for editing and unlocks when closed." src="https://www.userfilesystem.com/media/2105/mapdrivesamplemsofficenarrowsmall.png" rel="121897"></p> |
| 40 | +<p>The information about the lock (lock-token, etc.) is being saved on the client machine. When a document is modified on the client, all changes to the document are being saved on the local drive, without being sent to the WebDAV server until the file is unlocked. When the document is closed, the file content is being automatically sent to the server and than unlocked.</p> |
| 41 | +<p>Any temporary Microsoft Office documents (~$docfile.docx, G57BURP.tmp, etc) are stored in the local file system only and are NOT synchronized to the server. Typically temporary Microsoft Office documents are being automatically deleted by Microsoft office when the document editing is completed.</p> |
41 | 42 | <p>Locks and Etags are being stored in the application data folder, under the path that corresponds with the mounted drive. For example: <span class="code">C:\Users\<user>\AppData\Local\WebDAV Drive\C\Users\<user>\DAV\ServerData\</span></p> |
42 | 43 | <h2>File ETags</h2> |
43 | 44 | <p>When listing folder content the client reads file ETags and saves them in local file system. When sending modified content to the server, the client attaches the saved etag to the request. The server compares etags to ensure the file was not modified on the server since the file was read by the client. In the case of Microsoft Office documents, etags provide one more level of protection against overwriting server changes in addition to locks.</p> |
|
0 commit comments