Help Home      Return to FileHold.Com
Expand All  |  Collapse All
 

FileHold WebServices API Overview

 

FileHold document and record lifecycle software is based on the Microsoft .NET 3.0 framework Service Oriented Architecture (SOA) model. Microsoft provides an ideal technology platform to implement web services and to deliver modern Service Oriented Architecture. This architecture provides tremendous benefits to our customers, our partners and to FileHold's product development and professional services teams in terms of product scalability, flexibility and performance.

The main subsystems of FileHold communicate with each other via secure and fully authenticated web service calls. All FileHold application clients (including the FileHold Web Client, FileHold Desktop Application and FileHold MS Office Add-in) interact with the FileHold Server using the same web services and calls. These very same Web Services make up the FileHold Web Services API for integration of custom clients with the FileHold library. Sample custom integrations include integration of FileHold functionality into other productivity applications, develop connectors to import documents and metadata into FileHold from other applications or the ability to retrieve data and documents from the FileHold Library through a custom Intranet portal.

The SOA architecture provides the ability to deploy web services on different servers for the ultimate in system scalability and performance management.

Available Web Services & Operations

The FileHold application exposes a total of 13 Web Services with the following names. Clicking on the web service will show the names of all the operations associated with the web service along with the web service description. Clicking on any of the operation names will show in detail the operation SOAP calls and parameters required to interact with the operation.


NOTE: To access the location of these on your local FileHold production server replace the server location in the below URL with your internal server name and path.

    Subsystem/Component Web Service Name View Web Service Details & Operations At
    Document Repository RepositoryController http://demo.filehold.com/fH/FileHold/DocumentRepository/RepositoryController.asmx
    Full Text Search FullTextSearch http://demo.filehold.com/fH/FileHold/FullTextSearch/FullTextSearch.asmx
    Library Manager DocumentFinder http://demo.filehold.com/fH/FileHold/LibraryManager/DocumentFinder.asmx
    Library Manager DocumentManager http://demo.filehold.com/fH/FileHold/LibraryManager/DocumentManager.asmx
    Library Manager DocumentSchemaManager http://demo.filehold.com/fH/FileHold/LibraryManager/DocumentSchemaManager.asmx
    Library Manager GlobalSettingsManager http://demo.filehold.com/fH/FileHold/LibraryManager/GlobalSettingsManager.asmx
    Library Manager LibraryStructureManager http://demo.filehold.com/fH/FileHold/LibraryManager/LibraryStructureManager.asmx
    Library Manager UserPreferences http://demo.filehold.com/fH/FileHold/LibraryManager/UserPreferences.asmx
    Library Manager VirtualFolderManager http://demo.filehold.com/fH/FileHold/LibraryManager/VirtualFolderManager.asmx
    Library Manager WorkflowManager http://demo.filehold.com/fH/FileHold/LibraryManager/WorkflowManager.asmx
    User Role Manager UserGroupManager http://demo.filehold.com/fH/FileHold/UserRoleManager/UserGroupManager.asmx
    User Role Manager SessionManager http://demo.filehold.com/fH/FileHold/UserRoleManager/SessionManager.asmx
    User Role Manager LicenseManager http://demo.filehold.com/fH/FileHold/UserRoleManager/LicenseManager.asmx

Web Service Error Logging

FileHold adds a node to the Windows 2003 Event Viewer called FileHold that is useful for troubleshooting error conditions when integrating with the FileHold library using the FileHold Web Services API. The FileHold log file is created upon installation of FileHold onto a Windows 2003 Server. Upon installation all logging is enabled to the FileHold node. The FileHold event log is used for logging most application error messages. In addition, some error messages are logged to standard Windows logs (Application, System, Security).

 

Related Links