## Ensim Pro Power Tools Documentation

### 1 Introduction

The document provides an illustrative application framework that enables customers to implement new Power Tools. It includes sample code that illustrates the implementation; it also includes utilities to build and integrate them with Ensim Pro.

To build and integrate Power Tools, you must be familiar with the Power Tools build environment. The document includes the build directory structure and build utilities such as makefiles and scripts.

- Limitations

The deployables_lib.py library provides functions that considerably simplify the implementation of many tools. The library has been gradually extended, as new tools were written at Ensim. Writing a new tool which differs significantly from the ones already implemented (e.g. a tool which needs a database other than MySQL or uses an installation wizard not written in PHP) may be difficult for a third party (as it may be for Ensim).

- Audience

The scripts are written in Python. To read and understand the scripts, you must have a basic understanding of Python.

Python 101 -- Introduction to Python (http://www.rexx.com/~dkuhlman/python_101/python_101.html)

Python Tutorial (http://www.python.org/doc/current/tut/)

### 2 Terminology

Terms commonly used throughout the document.

### 3 How to package a Deployable Script

This topics illustrates with an example the common tasks required to create a Power Tool.

### 4 Source tree structure and build utilities

This topic discusses the build process - the build directory structure, makefiles, scripts and instructions on how to build the DSP RPMs.

### 5 DSP Interface (dsp.xml)

This topic discusses the XML document dsp.xml that contains global configuration parameters and the parameters that are required for each DSP instance.

### 6 Other DSP components

This topic discusses DSP components such as the DSP logo, include.mk and the msgs.list file. The msgs.list file contains error declarations.

### 7 DSP life cycle (dAPI.py methods)

This topic contains dAPI.py methods that enable the Power Tools Installer to install, remove, and manage DSP instances of a tool.

### 8 API explored (deployables_lib.api/)

This topic describes the common tasks involved in managing a DSP deployed on an Ensim Pro server.

### 9 Kickstart templates

This topic provides template source files that help in writing new DSPs. These files assume the most common DSP requirements.

### 10 Troubleshooting

This topic discusses potential issues you may encounter and tips to resolve them.

Retrieved from "wiki/index.php/Main_Page"