Attention

This document was written for an unsupported version of Plone, Plone 2.5.x, and was last updated 1499 days ago.

For more information, see the version support policy.

To learn how to upgrade to the current version of Plone, read the upgrade manual.

Introduction

by Jens W. Klein last modified Apr 16, 2009 01:17 PM
An introduction to ArchGenXML - what it is, reasons to use it, who made it.

What is ArchGenXML

With ArchGenXML you can create working python code without writing one single line of python. It is is a commandline utility that generates fully functional Zope Products based on the Archetypes framework from UML models using XMI (.xmi, .zargo, .zuml) files. The most common use case is to generate a set of custom content types, possibly with a few tools, a CMFMember type and some workflows thrown in.

In practice, you draw your UML diagrams in a tool like Poseidon or ObjectDomain which has the ability to generate XMI files. Once you are ready to test your product, you run ArchGenXML on the XMI file, which will generate the product directory. After generation, you will be able to install your product in Plone and have your new content types, tools and workflows available.

At present, round-trip support is not implemented: Custom code can't be converted back into XMI (and thus diagams). However, you can re-generate your product over existing code. Method bodies and certain "protected" code sections will be preserved. This means that you can evolve your product's public interfaces, its methods and its attributes in the UML model, without fear of losing your hand-written code.

ArchGenXML is hosted at "svn.plone.org":http://svn.plone.org/archetypes/ArchGenXML as a subproject of the Archetypes project. It is released under GNU General Public Licence 2 or later.

Please note ArchGenXML 1.x is not supported any longer and should be used only to maintain existing projects. If you're starting a new project, "use ArchGenXML 2 instead":http://plone.org/documentation/manual/archgenxml2.

Why should I use ArchGenXML?

Major reasons:

* You want to save time

* You are a lazy programmer

* You don't like to reinvent the wheel

* You dont like copying and pasting code and bugs

* You make heavy use of references and interfaces

* You have big projects with many different custom types

* You want or need a well-documented interface to your product

* You like structured model- and pattern-driven software development

* You want to maintain your project in future without getting a headache

and many more good and odd other reasons.

Contributors

The project was initially started by Phil Auersperg. Thanks to his laziness :-)

Authors

Phil Auersperg (Project Leader) -- "BlueDynamics Alliance, Auersperg-Castell KEG":http://www.bluedynamics.com/, "phil@bluedynamics.com":mailto:phil@bluedynamics.com,

Jens Klein (Release Manager, Developer and Doc-Writer) -- "BlueDynamics Alliance, Klein & Partner KEG":http://www.bluedynamics.com/, "jens@bluedynamics.com":mailto:jens@bluedynamics.com,

Reinout van Rees (Co-Release Manager, Developer and Doc-Writer) -- ZestSoftware

Fabiano Weimar dos Santos (Ideas, Testing, Bugfixing, Workflow) -- "Weimar Desenvolvimento e Consultoria em Informatica Ltda.":http://www.xiru.org/, "xiru@xiru.org":mailto:xiru@xiru.org,

Martin Aspeli (Improvements, bug fixes and documentation) -- "Martin Aspeli":mailto:optilude@gmx.net

and others -- thanks to everybody who contributed with testing, doc-writing or code-pieces!

Sponsors

* Xiru.org, Brazil (Fabiano Weimar dos Santos) sponsors a valuable amount of money into workflow support (State diagrams -> DCWorkflow, will go into release 1.2),

* PilotSystems, Paris, France (David Sapiro),

* OpenSource.ag, Innsbruck, Austria (Georg Pleger).

If you want to contribute ArchGenXML by improving the code, helping with documentation or sponsoring money to make us improve it, please contact one of us.


Contribute

Something wrong or out of date? Anybody can edit or create a new article in the knowledge base. Simply create an account on this site, log in, and click the Edit button to contribute.