OnDemand Toolbox - Examples for Client API Usage

Abstract

IBM Germany developed a set of sample programs for use with OnDemand Common Server. These programs are intended to provide examples of how to use client APIs to develop applications while providing useful as-is tools to meet customer needs. This document briefly describes what the sample programs do and how to download the source and associated documentation.

Contents

Four programs are included in the OnDemand (OD) toolbox. To download, click here and download the SG246915_ODToolbox.zip file.

The components are:

    • OD Update
    • OD Delete
    • OD Store
    • OD File System Monitor
Each component is a single program, working as stand-alone application. All programs are written in Visual Basic.net and are provided as ready-to-use binaries and as source code under the IBM Public License. Installation of the OnDemand client is a prerequisite for the installation of the OnDemand Toolbox. The Microsoft .NET Framework must be installed during the setup of the toolbox.

OD Update

The OD Update application provides an easy-to-use interface to update the index (key) values of documents archived in OnDemand.

The key features are:

    • Easy update of all documents
    • No need for any client configuration before using it
    • Fits into the OnDemand security concept
The user must have update authority to the application group, which is configurable using the OnDemand Administrator.

OD Delete

The OD Delete application is used for deleting documents archived in OnDemand.

The key features are:

    • Easy deletion of single or multiple documents
    • No need for any client configuration before using it
    • Fits into the OnDemand security concept
The user must have delete authority to the application group, which is configurable using the OnDemand Administrator.

Both OD Update and OD Delete applications provide a user interface that is similar to the OnDemand client, making them easy to use.

OD Store

The OD Store application is used for archiving PC files directly into OnDemand.

The key features are:

    • Easy interface for archiving single documents into OnDemand.
    • Integrates with the Windows Explorer.
    • Can handle all file types supported by OnDemand.
    • Requires prior configuration of which file type should be archived using which application, application group, and folder.
    • Configuration can be exported and easily distributed to other users.
    • Fits into the OnDemand security concept.

The user must have archive authority to the application group, which is configurable using the OnDemand Administrator.

OD File System Monitor

The OD File System Monitor application is a background application that monitors directories on a PC and automatically archives the files found in those directories using preconfigured field information and information extracted from the files.

To use the monitor, configure the following items:

    • The directories that should be monitored (multiple directories and network drives supported).
    • The file types that should be archived into OnDemand.
    • What to do after successful or unsuccessful archiving.
    • The file types that should be archived into which application and which application group.
    • What to do with files of other, unknown file types found in the monitored directories.
    • The folder that should be used and the information that should be used for the indexes.
The key features are:
    • When configured, the OD File System Monitor runs without any user interaction as a background process.
    • The document’s values for each index can be set to the file’s meta information such as file size, creation date and time, and more.
    • The OD File System Monitor creates detailed logs (configurable) about all its activities.
    • The OD File System Monitor fits into the OnDemand security concept.
    • The configured user account must have archive authority to the application group, which is configurable using the OnDemand Administrator.
    • Configuration of the OD File System Monitor is saved as an XML file and, therefore, can be distributed among other installations.
    • The source code can easily be modified to extract index information from other sources such as the file’s content.

Special Notices

This material has not been submitted to any formal IBM test and is published AS IS. It has not been the subject of rigorous review. IBM assumes no responsibility for its accuracy or completeness. The use of this information or the implementation of any of these techniques is a client responsibility and depends upon the client's ability to evaluate and integrate them into the client's operational environment.

Profile

Publish Date
11 August 2006


Rating:
(based on 5 reviews)


Author(s)

IBM Form Number
TIPS0633