Instructions to Write Tools for Pramati Studio

1. The class ToolJarReader in com.pramati.studio.config creates the tool configuration information objects.
2. The jar should have a manifest file with all the required entries.
The manifest file in the jar should follow the format given below:

Field	Description
Manifest-Version:1.0	This field is mandatory.
Name: Name of the Tool	Placing the name of the tool here makes it unique in context of the jar.
Pramati-Studio-Tool: true	Specifies that the entry points to a Pramati-Studio-Tool. The entries can be retained without having the Studio pick up tools by setting the value to false.
Tool- Class-Path: templates.jar classes.jar	Set the Classpath for the tool here. The original jar is always in the class path. Classpaths can be relative or absolute. If relative, then an absolute path is constructed using the parent directory of the original jar. The classpath can be left blank.
Tool-Main-Class: class name	Enter the tool's main class. Once the user has set the main class here, it is not required to remember the class after this.
Error-Message: message	Enter the error message to be printed when there is an error. The error message can be left blank.
Description: description	Enter the description of the tool here. The description can be left blank.
Â

3. To add the manifest files to an existing jar, use the command
jar ufm <jar-file-name> <manifest-content-text-file> where <manifest-content-text-file> is a simple text file comprising all the required contents in MANIFEST.MF, the manifest file.
4. Once the manifest file is ready, clicking on Import Tool prompts the user for the jar to be imported. After the jar is imported into the Studio, the tool can be deployed and undeployed.

Example:

To understand the format of the manifest file more clearly, read the sample manifest file. The tool main class ManifestWizard used in the example is a dummy tool.

Name:	ManifestWizard
Pramati-Studio-Tool:	true
Tool-Class-Path:
Tool-Main-Class:	com.pramati.studio.tools.manifestwizard.ManifestPropertiesPanel
Description:	Dummy tool for importing in Pramati Studio
Error-Message: