FileHold 8.5 APIDemo Application - Installation Usage & Examples

Download the Demo Application

The FileHold '08 APIDemo application can be downloaded HERE. Please note that this application will only work with FileHold 8.5 server.

How to Install the Demo Application

FileHold APIDemo comes as a Microsoft Visual Studio 2005 project. You can open it in Visual Studio 2005 Standard or Express edition and build it. It will produce a command line application. MSBuild from Microsoft .Net 2.0 Framework can also be used to build this demo, therefore, MS Visual Studio is not required and the only pre-requisite is the presence of .Net 2.0 Framework. Here is a sample build command using MSBuild:

          C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\msbuild APIDemo.csproj

This small demo requires no installation. It can be simply run from the directory where it was built. For your convenience, pre-built binaries are ready for testing in the Release Folder.

How to Use the Demo Application - Application Arguments

Launch a command prompt window and navigate to the directory where the demo executable resides. To launch the demo, call it with the following arguments:

          /u:username – FileHold account Login Name (only FileHold local users are supported in this demo)

          /p:password – FileHold Password. Please note that spaces and some special characters will not work as part of the password for this demo

          /f:uri – If uploading, put a full file path here. If downloading, put a target folder path here. Note that spaces in the path or file name are not supported

          /m:{put | get} – Use /m:put if you want to upload a file or /m:get if you want to download a file

          /s:search_word – Search string. The APIDemo search scope is limited to file names only. It does not support spaces as part of the name

          /w:server_url – Web address (URL) of FileHold Server. In a typical installation of FileHold the server URL should be http://ip_number_here/FH/FileHold or http://host_name_here/FH/FileHold. If the server is installed locally, http://localhost/FH/FileHold could be used.

Sample Upload (PUT) Document

As an example, in order to upload a demo.doc file stored in c:\temp directory to a FileHold server running on the same machine the command could be:

          APIdemo /u:sysadm /p:P@ssw0rd /f:c:\test\demo.doc /m:put /w:http://localhost/FH/FileHold

If the operation was successful, the demo will print relevant information to your console and you will be able to see the results in FileHold using Web Client or FDA.

Sample Retrieve (GET) Document

In order to retrieve the same file into c:\test\get directory the command could be:

          APIdemo /u:sysadm /p:P@ssw0rd /f:c:\test\get /m:get /w:http://localhost/FH/FileHold /s:demo

The results of the search will be displayed on your screen and the file will be downloaded to the specified c:\test\get folder.

Related Links