Clicker.txt 0.05                     UTF-8                  dh:2007-04-10

                 CLICKER.JAR 0.05 TEST FOR ODMJNI 1.0 0.58beta
                 =============================================

     *********************************************************************
     *  WARNING: This Clicker.jar was developed for confirmation of the  *
     *  ODMJNI 1.0 0.58beta runtime package, ODMJNI100.jar, and also the *
     *  0.58beta source tree and deployment procedures.                  *
     *                                                                   *
     *  Clicker.jar does not operate with previous versions of ODMJNI    *
     *  1.0 development releases.  Consult the download page and related *
     *  links for the latest Clicker.jar information and its usability   *
     *  with any later ODMJNI 1.0 releases.                              *
     *********************************************************************

     The 0.58beta distribution of which Clicker.jar 0.05 is part is
     available at <http://odma.info/dev/devNotes/2006/11/d061101n.htm>.
     Consult that page for the latest status and for links to important
     related material.

   If there is any concern for the authenticity of Clicker.jar and its
   content, obtain a full replacement copy from the above 0.58beta page
   on the ODMA Interoperability Exchange site, http://ODMA.info.


              The software in this Java archive is released under the
              Open Document Management API License 1.0, an open-
              source software license using the BSD template
              license.

              A copy of the license should accompany the computer
              software that is contained in this Java archive.
              If the license has been separated from the material,
              obtain a copy at <http://DMware.info/license/>.

   CONTENT

        1. Prerequisites
        2. Manifest
        3. Dependencies
        4. Tools Required
        5. Installation and Usage

1. PREREQUISITES

   This package is intended to be used as a confirmation procedure as part
   of the ODMJNI100-0.58beta.zip distribution of the ODMJNI 1.0 runtime
   components.

   The prerequisites for runtime use of Clicker.jar are the same as those
   for the ODMJNI100-0.58beta.zip runtime archive.

   The package is constructed and is usable as part of the development
   source-code tree, usually located at <classpath>\info\odma\OdmDeploy100\
   and the subordinate test\ClickerJar folder.  Here, <classpath> is the
   file-system location where the source-code tree is extracted for review,
   confirmation testing, and any further modification and development.

   The prerequisites for development replication and use of Clicker.jar
   are those provided with the d061101n-odmjni100-0.58beta.zip updates for
   the ODMJNI 1.0 development code tree.


2. MANIFEST

   This is a self-contained executable Jar file. This file consists of the
   following files:

        Clicker.jar/                0.05 2007-04-10-12:33 Java archive
                OdmClicker$1.class  0.08 481 byte, 2007-02-12-17:24 version
                OdmClicker.class    0.08 4,411 byte, 2007-02-12-17:24
                                    Simple OdmClicker for confirming install
                                    and availability of ODMA

            meta-inf/
                Clicker.txt         0.05 this narrative manifest note
                                    13,271 bytes dated 2007-04-10-12:32
                License.txt         0.01 4,016 byte, 2007-04-09-21:47 based
                                    on Open Document Management License 1.0
                Manifest.mf         0.05 Jar utility manifest
                                    503 byte, 2007-04-10-12:33 file

            results/                images of expected OdmClicker displays
                OdmClicker0.08-00-Waiting0.png    7,747 2007-04-07-13:22
                OdmClicker0.08-01-Stuck0.png      7,676 2007-04-07-13:31
                OdmClicker0.08-02-Operating1.png  7,587 2007-04-07-12:23
                OdmClicker0.08-04-Available3.png  7,637 2007-04-07-13:26
                OdmClicker0.08-06-Default5.png    7,638 2007-04-07-13:26
                OdmClicker0.08-07-ToLaunch6.png   7,689 2007-04-07-13:27

   The Manifest.mf file is inserted via the Java Jar tool.  It provides
   the following information:

      Manifest-Version: 1.0
      Class-Path: ODMJNI100.jar
      Created-By: 1.5.0_09 (Sun Microsystems Inc.)
      Main-Class: OdmClicker
      Implementation-Title: OdmClicker ODMJNI 1.0 0.58beta Confirmation
      Comment: See Clicker.jar/meta-inf/Clicker.txt for more information.
      Implementation-Vendor-Id: http://NuovoDoc.com
      Implementation-Version: OdmClicker 0.08 / Clicker.jar 0.05 2007-04-10
      Implementation-Vendor: Dennis E. Hamilton of NuovoDoc
      Implementation-URL: http://ODMA.info/dev/DevNotes/2006/11/d061101n.htm


3. DEPENDENCIES

   3.1 Execution of Clicker.jar requires a Java Runtime Environment (JRE)
   installed on your computer.  The *.jar extension must be registered as an
   Executable Jar File.  To execute Clicker.jar from a command-line console,
   the java runtime (JRE) bin\ directory must be in the environment PATH.

   3.2 Execution of Clicker.jar depends on the ODMJNI100.jar and the
   odmjni100.dll being in the same directory as Clicker.jar.  Additional
   dependencies of ODMJNI100.jar and odmjni100.dll must also be satisfied.

   3.3 In order to connect to ODMA, there must be an installed ODMA
   Connection Manager Odma32.dll (ODMA 2.0 version preferred).

   3.4 In order to operate with an ODMA DMS there must be a global-default
   DMS or else the ODMA Application ID "OdmNativeTest" must have a default
   DMS assigned for use.

4. TOOLS REQUIRED

   Clicker is meant to be used in conjunction with the ODMJNI 1.0 runtime
   package that it is distributed with (e.g., in ODMJNI100-0.58beta.zip).
   The prerequisites are those for that runtime package:

       Internet Connection and Browser for download

       Zip-format archive access utility

       A Java JRE runtime such as a JRE 1.5 installation or a JRE installed
       as part of a Java Development Kit (JDK).

       Clicker will determine whether or not there is an ODMA Connection
       Manager and a default ODMA DMS integration available for the
       application.  It will also run properly in the absence of ODMA.

5. INSTALLATION AND USAGE

   5.1 Simply place Clicker.jar in the same directory as ODMJNI100.jar and
   odmjni100.dll.  This can be accomplished by extracting them from
   ODMJNI100-0.58beta.zip together.

   5.2 You can inspect (and view or extract) material in Clicker.jar by
   opening it with a Zip utility.  If you don't have a Zip utility, you can
   make it temporarily accessible as a folder on Windows 2000 and later by
   renaming Clicker.jar to Clicker.jar.zip, then changing the name back in
   order to use it as an executable Jar.

   5.3 You can execute the program by double-clicking on the Clicker.jar
   file.  If the program fails to start or it remains stuck on the step
   "0: Waiting for the First Click," the configuration is incorrect.

   5.4 To obtain details of any failure, you'll need to operate the program
   from a command-line console shell.  If Java is properly installed, you
   can use the command

            java -jar Clicker.jar

   and any unchecked exceptions that are encountered will be reported in the
   console window.

   5.4 Characteristic Results.  The Clicker.jar/results image files provide
   illustrations of the expected behavior when Clicker is operated:

            OdmClicker0.08-00-Waiting0.png is the normal starting Window
                of the application.  If this window does not appear, there
                is a problem with the Java installation and its treatment
                of Jar files.

            OdmClicker0.08-01-Stuck0.png is the appearance if the button
                is clicked and no progress occurs.  This can be because
                the ODMJNI100.jar is not present in the same directory, or
                if the odmjni100.dll is not also present in the same place.
                To see the error messages produced by Java, it is necessary
                to run in a console session.

            OdmClicker0.08-02-Operating1.png is the normal display after
                the button is clicked for the first time.  In this case, the
                Java application has started normally and the configuration
                appears to be fine.  Clicking again will determine whether
                or not the ODMA Connection Manager can be connected by
                OdmClicker.

            OdmClicker0.08-04-Available3.png is the result if there is an
                ODMA Connection Manager available.  If not, there will be
                a different message below the button.  This is not an error,
                since ODMA-aware applications are designed to operate when
                ODMA is not present.  If it is expected that ODMA would be
                present, the ODMA configuration must be reviewed.  Clicking
                again from this display will determine whether there is a
                default DMS that can be used by OdmClicker.

            OdmClicker0.08-06-Default5.png is the result if there is a
                default DMS available.  If one is not available, a different
                message will appear beneath the button.  This is not an
                error, since there might not be a default DMS even though
                there is an ODMA Connection Manager.  If a DMS was expected
                to be available, the ODMA Configuration must be examined to
                determine if there is a global default and/or a specific
                default for Application Id "OdmNativeTest".  If there is,
                it may be the case that the DLL for that DMS has not been
                registered properly, or is not installed where expected.

            OdmClicker0.08-07-ToLaunch6.png is the state that is reached
                before any operation is attempted with the default DMS.
                Click the button to continue.

   5.5 OdmClicker 0.08 does not retrieve or open any documents.  It simply
   reports the selection.  It will keep offering more selections until
   one is cancelled, the option for opening a local file is selected, or
   there is a failure.


 - - - - - - - - - - - - - - - - - - | - - - - - - - - - - - - - - - - - -

Questions, comments, discussion and feedback about ODMA concepts, status,
and materials are welcome.  Please send comments to the discussion list at
<mailto:activeodma-discuss@lists.sourceforge.net>.  For further details
visit <http://ODMA.info/contact.htm>.

             Copyright © 2007 NuovoDoc <http://NuovoDoc.com>

           This work is licensed under the Creative Commons Attribution
           License.  To view a copy of this license, visit web site
           http://creativecommons.org/licenses/by/2.5/ or send a letter
           to Creative Commons, 559 Nathan Abbott Way, Stanford,
           California 94305, USA.

Attributions can be made in any suitable scholarly-citation format.  It is
requested that citations identify the material sufficiently for others
to be able to independently locate the material.   This citation example
can be adapted to your purpose and format:

    Hamilton, Dennis E.
        Clicker.jar 0.05 Test for ODMJNI 1.0 0.58beta. ODMA Interopera-
        bility Exchange, April 10, 2007.  Current version available as
        part of the runtime package downloadable at
        <http://ODMA.info/dev/devNotes/2006/11/d061101n.htm>.

 - - - - - - - - - - - - - - - - - - | - - - - - - - - - - - - - - - - - -

 0.05 2007-04-10-12:16 Correct use of "narrative" and correct version and
      timestamps that were not updated as part of 0.04 creation.
 0.04 2007-04-09-22:07 Make corrections noticed during testing and build a
      clean version for the 0.58beta release.
 0.03 2007-04-07-21:14 Correct version numbering of the jar and its content
      to synchronize with that of this manifest.  The manifest is used to
      establish the version for the entire package and those elements that
      do not have a recorded version identifier.  This corresponds with the
      idea that the version of a binary is the version of its source code.
      We view *narrative* manifests as the source code for a package.
 0.02 2007-04-07-14:50 Correct unbroken lines and tidy up for adding to the
      ODMJNI100-0.58beta.zip runtime package.
 0.01 2007-04-07-14:09 Clean up with manifest information
 0.00 2007-04-04-22:00 Adapt from d061101m.txt 0.00 to make a manifest and
     usage note for the Clicker.jar.

$Header: /ODMdev/info/odma/OdmDeploy100/test/ClickerJar/meta-inf/Clicker.txt 15    07-04-10 12:32 Orcmid $

                       *** end of Clicker.txt ***