N-API Documentation

N-API Version 2.0.0

This software is the confidential and proprietary information of SOFTPRO ("Confidential Information"). You shall not disclose such Confidential Information and shall use it only in accordance with the terms of the license agreement you entered into with SOFTPRO (see License Agreement)

SignWare N-API

Package de.softpro.signware.napi defines and implements an interface that allows for comparing signatures and references within an operating system independent environment.

It uses SignWare J-API functionality to perform the compares on an engine computer which must run within a windows operating system.

The package includes:

• de.softpro.signware.napi.SPNifInterface represents the interface
• de.softpro.signware.napi.SPNif implements the interface
• de.softpro.signware.napi.SPNifCompareResult represents a compare result
• de.softpro.signware.napi.SPResult represents the abstract result
• de.softpro.signware.SPVersionInfo represents a version info object

All classes are packed into SPSignware_32.jar which is provided in the folder $(InstallDir)\j-api.

This package requires java 1.4 or higher.

Installation

Client side installation

• Please add SPSignware_32.jar (path: $(InstallDir)\j-api) to your classpath if you want to access the N-API package.
• This package requires an engine process, that must be running on a computer with Windows 2000 or newer operating system. The application, that accesses this interface requires Java Version 1.3 or higher, that means it may run on any operating system that hosts a JVM.
• Please copy all files in the client directory ($(InstallDir)\n-api\client) to your application, don't forget to add some packages to your classpath, see NDemo.cmd as an example.

Engine side installation

• Copy all files from the engine subdirectory ($(InstallDir)\n-api\engine) to the engine computer.
• Set the property RemoteEngine in file spnapi.properties on the application directory to the name of the engine host, use localhost if both process's run on the same machine.
• Register sif license on the engine host.
  Please register the files Sif.lic and Sif.lic in the registry, assure that you have entered the correct fully qualified path the files.
  • HKCR\Software\SOFTPRO\SPLM2\Sif.lic=$(InstallDir)\Sif.lic
  • HKCR\Software\SOFTPRO\SPLM2\Sif.dat=$(InstallDir)\Sif.dat
• Start the engine process, see the Engine.cmd file as a sample how to start the engine process. Especially see the path statement, the engine process requires some native libraries that are adressed via the path variable.

Browser side installation
The pad input in the browser is implemented as a browser plugin. The plugin is available for Internet Explorer (ActiveCap.cab) and for Mozilla / Firefox (SPCapPlugin.xpi). The plugin is dowloaded to the browser during initialisation.
The plugin for Internet Explorer is packaged into a cabinet, that includes additional modules:

• msvcr71.dll Microsoft runtime library
• WTablet.dll Softpro driver for TabletPC signature entry
• SP_TZDrv.dll Softpro driver for Topaz tablets
• SP_SODrv.dll Softpro driver for StepOver tablets
• SWIlUniv.dll Softpro driver for Interlink tablets

The plugin for Mozilla / Firefox does not include any further modules, msvcr71 must be copied manually (most computers will have msvcr71.dll installed anyway).
You must additionally install these drivers after the manufacturers driver installation is compleeted:

• Topaz pads: SP_TzDrv.dll
• StepOver pads: SP_SODrv.dll
• TabletPC: WTablet.dll (only Mozilla / Firefox)
• Interlink pads: SWIlUniv.dll
• Wacom pads: no additional modules are required

The modules are available in the drivers - folder of the SignWare package. Please copy the required modules to a folder that is included in the PATH variable on the browser side, such as %SystemRoot%.

Please refer to the chapter SignWare Installation

FAQs Frequently asked questions

Error handling and Debugging

The interface side does not provide for any logging facility. The applications must evaluate the return code and trace whatever seems applicable.

The engine process includes a logging facility, which is controlled via command line parameters:

• -d=level trace level, see below
• -p=file fully qualified file name where traces are written to.

The engine uses the C-API to perform the requested tasks, all debugging capabilities of the C-API Error handling and Debugging also apply for these calls.

The engine trace level ranges from 0 to 5, 0 turns off traces, 5 traces all.

Versions

Network SDK Version history

• Version 0.98.3: 12 May 2005: license check to render SPSignature objects
• Version 0.98.2: Added SPLogger, SPResource
• Version 0.98.1: Added createImage(Object padSignature, java.awt.Dimension size, Object oOption, int iFormat);
• Version 0.90.0, 9 Oct 2004: new SignWare addon