How to deploy an Alternate Propery Editor (APE)



How to deploy an Alternate Propery Editor (APE)


  • Product Name: StarTeam
  • Product Version: 2006
  • Product Component: Alternate Property Editors (APEs)
  • Platform/OS Version: All Supported OS


The purpose of this article is to simplify the StarTeam Documentation and aid in the process of deploying an Alternate Propery Editor (APE).


Deploying an Alternate Property Editor can be greatly simplified.

Three files are absolutely necessary in order to launch an APE:

  1. Compiled JAR file with the GUI"s class files inside
  2. .propertyeditor.xml
  3. .Workflow.xml

The contents of each file must be setup in a very specific way. You must add a reference to the JAR file in .propertyeditor.xml

Ex: If you want to deploy a Task APE called LinkTypeTask

For now, we only want to deploy and test the custom form. We are not concerned about the workflow (if you plan on using one).

Task.Workflow.xml should contain the following:

Add these three file types to the StarFlow Extensions project"s "Project" folder and you can deploy the APE. With these three files, the custom form will appear after you go to Project -> Properties -> Editors -> Enable the check box for the form"s item type and type in "Locator " -> Push OK.

If you have any questions or concerns about this process, please contact Support.

For assistance with developing your organization"s own custom form, please contact Consulting Services or contact your Sales Representative.

Author: Daniel Rice

Old KB# 27515
Comment List