Integration points for Add-On Developers

Web Panel locations

Location	Description	Available since
wittified.projectcreator.nextsteps	This will allow them to specify any reminders or suggestions about the next configuration steps after a project has been created.	2.0
wittified.projectcreator.template.edit-left	Left column of the template editing area. The context will provide the templateId in the parameters passed (named "templateId")	2.2
wittified.projectcreator.template.edit-right	Right column of the template editing area. The context will provide the templateId in the parameters passed (named "templateId")	2.2
wittified.projectcreator.creation	Panel on the project details of the project creation process. The context will provide: templateId (the id of the template) templateIds ( array of ids for override templates)	2.2

For more information about web-panels - please see http://developer.atlassian.com/display/JIRADEV/Web+Panel+Plugin+Module

API

In order to participate in the template editing and project creation process, you will need to add the following to your atlassian-plugin.xml:

<wittified-pcfj-extension key="emailEventListener" class="com.wittified.jira.projectcreator.email.EmailProjectCreatorExtension"/> where EmailProjectCreatorExtension is a class that implements the com.wittified.jira.projectcreator.api.ProjectTemplateExtensionHandler interface. This interface is available as a maven artifacts (see below for coordinates)

The ProjectTemplateExtensionHandler defines 4 methods:

public Map<String, Object> projectCreatedFromTemplateEvent(long projectId, Integer[] templateIds,  Map<String, Object> params);
public void projectTemplateDeletedEvent( int templateId);
public void projectTemplateEditedEvent( int templateId, Map<String, Object> data);
public String verifyProjectMetaData(  Integer[] templateIds, Map<String, Object> params);

projectCreatedFromTemplateEvent method

This is called after the project has been created and PCFJ has done all of its configuration. The projectId is the global pid of the project. The array of templateIds is an array of templateIds. Finally the params passed in a list of parameters used to render the nextsteps web-panel. This map should returned back with any additional information that you might have.

projectTemplateDeletedEvent method

Called whenever a project template is deleted.

projectTemplateEditedEvent method

Called whenever a project template is saved. The map contains all of the http request parameters fetched from the editor.

verifyProjectMetaData method

Called during the validation of the project data before it's created. Returning back a null means that there are no validation issues. The string returned back is displayed to the end user.