This page explains the Docman API Tester. It is a small project with the goal to show how you can easily create your own integrations or tools for creating and importing documents in IFS Document Management using standard APIs in DOCMAN.
Use this page when you want to create your own integrations or tools for creating and importing documents in IFS Document Management.
The directory \docman\template\docman\DocmanAPITester\ contains the code for Docman API Tester. It is a small project with the goal to show how you can easily create your own integrations or tools for creating and importing documents in IFS Document Management using standard APIs in DOCMAN.
Note: This code is unsupported by R&D. If you want modify or add new features, add it yourself. We might or we might not update this template code when doing new releases.
The project consists of some of examples, ranging from a simple listing of document titles, to a small import tool that uses a metadata file (in this case a XML file) to define attributes and file name for documents that are to be imported. The small import tool could actually be useful in real life, but probably you want to extend the code so that it can set extra attributes on the document title and revision. Using a script/macro in for example AutoCAD you could quite easily create this metadata file and have it imported for you using this simple tool. This however is outside the scope of this project. The import tool supports two versions of the XML: either a very light one introduced by this tool, or the format AIIM uses. The AIIM format has a limitation in that document number must be filled in.
The code is built using the professional edition of Microsoft Visual Studio 2005, but it is quite simple so it might be possible to develop the code further using the free version that Microsoft provides.
All the interesting code is in the file Main.cs. It is fairly well commented/documented (the documentation is in the comments). If you want to extend it, it is recommended that you place the project in debug mode ("press play") follow all that happens from the moment the user clicks a certain button.
To run, this project needs a few basic IFS libraries (found in the lib folder) that is for handling IFS data types, the access provider to talk to the server and for file uploading through the FTS (File Transfer Service).