Pramati Technologies

Adding Custom Tools to Pramati Studio

Overview

Published Studio Framework and Tool APIs allow to plugin custom tools as tool archives. To import a tool:

  1. Download the tool.
  2. In Studio select Tools > Configure.
  3. In the Configure dialog, click Import Tool.
  4. Select the location of tool and click OK to import the tool

Given a JAR, the class ToolJarReader in com.pramati.studio.config file creates tool configuration information objects. The JAR should have a manifest file with all necessary entries. Studio registers all features of the tool immediately. There is no need to restart Studio to access the new tool.

Writing a tool for Studio

The class ToolJarReader in com.pramati.studio.config creates the tool configuration information objects. The JAR should have a manifest file with all required entries.

Adding a manifest file to a JAR

To add a manifest file to an existing JAR, at the command prompt type: 

jar ufm <jar-file-name> <manifest-content-text-file>

where <manifest-content-text-file> is a simple text file that contains all information present in the manifest file MANIFEST.MF. The manifest file in the JAR should contain the following information:

Table 1:
Field
Description
Manifest Version: 1.0
This field is mandatory.
Name
Type the tool name here to make it unique in context of the JAR.
Pramati-Studio-Tool
Set to `true' to specify the entry points to a Studio-Tool. Set to `false' such that Studio retains the entries without picking up the tool.
Tool- Class-Path: templates.jar classes.jar
Set classpath for the tool. The original JAR is always in the class path. Classpaths can be relative or absolute. If relative, construct an absolute path using the parent directory of the original JAR. The classpath can be blank.
Tool-Main-Class
Enter the main class for the tool from the StudioTool API located in <install_dir>\PStudio35\lib\pramati
Error-Message
Enter the error messages if any. The error message field can be blank.
Description
Enter the description of the tool here. The description can be left blank.

Click Import Tool. It displays a message prompting to enter the JAR name. Studio allows to deploy and undeploy the tool. To understand the format of the manifest file, see the sample: 

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

Note: The tool main class `ManifestWizard' in the example is a dummy tool.

About tools++

Tools++ is a collection of tools that can be plugged into Studio to enhance functionality and scope. Tools presently supported are JAD Tool, Export to HTML, and Memory Grapher. For details and download, visit Pramati website.

You can also contribute ideas to write new tools and configure them in Studio.

Pramati Technologies  © Copyright   TOCPREVNEXTINDEX