Plone Debug Client

Plone debug client is a Zope client attached to a Windows console. It shows the standard output and standard error of a running Zope client in debug mode. It also allows you to interact with the Plone site via the command line.

Another product, Clousseau (http://plone.org/products/clouseau-- not included with Enfold Server) performs many of the same functions within a browser window (thus providing cross-platform use). Clousseau is open source and created by an Enfold developer. Plone debug client's main advantage is that it provides more security in a production environment. Clousseau is not recommended except in a controlled testing environment.

Plone Shell

Plone Shell lets you interact safely with the live ZODB in a relatively safe environment. Not only can you view objects and classes from a python interface, you can also try code and commands and see what the output would be without having to commit to the changes. (To commit a command inputted through the Plone Shell, you will need to type:

import transaction; transaction.commit()
app._p_jar.sync()

The first line commits your command. The second line synchronizes this with the remaining Zope clients.

Here are some ways the Plone Shell can be useful.

1. Provides access to ZODB when ZMI is down or available. (plone shell only has access to ZODB)
2. Can run a script directly without having to deal with Zope security.
3. Can do import/export data with scripts from the command line
4. Can let you test code within a live server environment with relatively little risk

Plone Debug Server

This utility lets you see the output and errors from the Zope Enterprise Objects (ZEO) Server. You can run this whenever ZEO Server is running. ZEO server does not yield as much useful information as Plone Debug client.

To run this utility, go to Start > Programs > Enfold Server > Development > Plone Debug Server

Plone Test

If you call up the Plone Test utility, that will run a preassembled battery of tests on the Server. Generally, this verifies that the libraries have been installed correctly or that the files are all there.

To run this utility, go to Start > Programs > Enfold Server > Development > Plone Tests

The results are available at C:\Program Files\Enfold Server\Python\Lib\site-packages\EnfoldTools\Cluster\util (or some place similar).

Python Shell and Windows Shell

Enfold Server also includes two interactive python shells for testing.

• Python
• PythonWin

PythonWin is a Python IDE which includes Python Windows extensions, a Python prompt and a Python text editor. You can start this at Start > Programs > Enfold Server > Development > PythonWin

Setup Environment

The Setup Environment utility lets you have access to your Plone environment in a command window where you can run Windows commands on the file system.

This is helpful for:

• performing file system operations

• using buildout/easy_install to download new application eggs or products. (Buildout/Ploneout is a new way to download python libraries and update Plone products).

  

Using easy_install with Enfold Server

New methods have emerged for updating python libraries and Plone products. One such method called Easy Install lets you install and update Plone products and libraries via an easy command line tool. (You can read some background information on easy install at http://peak.telecommunity.com/DevCenter/EasyInstall).

1. Sign on as the user who installed Enfold Server (or a domain user with local Administrator privileges).

2. Go to Start --> Enfold Server --> Development --> Setup environment. Setup environment is the terminal command prompt that uses the python path and Plone variables that coincide with your Enfold Server installation.

3. Run the easy_install command. You will not need to type the path because the Setup Environment tool already sets these things up for you. Here's an example:

   C:\\Program Files\\Enfold Server\\Python>easy_install feedparser
   

Note You should not run easy_install from a python prompt on a Windows command line. This is because the Windows command line may not have set the python path/variables properly or may reference another version of Python installed on your Windows machine. The Setup Environment tool included with Enfold Server has already set the python path and variables to coincide with your Plone install. For this reason, running the command from the Setup Environment tool is more likely to work.

1. Verify that the new egg has been successfully installed. If the import command executes without giving an error, that means the egg has been successfully installed.

   C:\\Program Files\\Enfold Server\\Python>python
   Python 2.4.4 (#71, Oct 18 2006, 08:34:43) [MSC v.1310 32 bit (Intel)] on win32
   Type "help", "copyright", "credits" or "license" for more information.
   >>> import FeedParser
   >>>
   

2. Restart Enfold Server.