Community
Q&A
Jira
Questions
Jira and Velocity - form field

Jira and Velocity - form field

Hi,

I'm newbie in JIRA topic, I trying to create simple form.

I have following class

public class ManageTemplates extends JiraWebActionSupport {

	public ManageTemplates(FieldScreenRendererFactory fieldScreenRendererFactory,
			JiraAuthenticationContext jiraAuthenticationContext) {
		
		String issueId = ((String[])ActionContext.getParameters().get("id"))[0];
		MutableIssue issue = ComponentAccessor.getIssueManager().getIssueObject(Long.valueOf(issueId));
		
		
	}
}

Class is connected with .vm file via atlassian-plugin.xml config file. Here's my .vm

&lt;html&gt;
&lt;head&gt;
	&lt;meta name="decorator" content="atl.admin"/&gt;
    &lt;title&gt;Create X&lt;/title&gt;
&lt;/head&gt;
&lt;body class="nl"&gt;
	&lt;div class="content intform"&gt;
	&lt;/div&gt;
&lt;/body&gt;
&lt;/html&gt;

How could I insert user picker to form? Any code examples?

1 answer

1 accepted

4 votes

Answer accepted

Hi,

I do not knowv how to reuse standard user picker - you must check source code, but why you read parameter 'id' in so complicated way. You should define property id + getter/setter in action class and set it in request as some hidden form field or directly in url.

private String issueId;

public String getIssueId() {
  return issueId;
}
	
public void setIssueId(String issueId) {
  this.issueId = issueId;
}

Also you can define other methods in action (not only overwrite execute), eg. to list all JIRA users

public Collection&lt;User&gt; getAllUsers() {
  return UserUtils.getAllUsers();
}

Than iterate throught results in vm tempate and create eg. select element.

&lt;select id="jiraUser" name="jiraUser"&gt;
#foreach ($user in $action.getAllUsers())
  &lt;option value="$user.name"&gt;$user.displayName&lt;/option&gt;
#end
&lt;/select&gt;

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Hi Radek,

I wanna ask a question to you. action is the class name or not? I guess it is not :) If so, how can I set a class as action?

Thanks

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

It is not class name. You can use notation as $action.someMethodCall() in any vm template, where action is mapped into the class defined for your webwork in atlassian-plugin.xml

Example:

1. atlassian-plugin.xml

&lt;webwork1 key="action-webwork" name="Test Action module" class="java.lang.Object"&gt;
		&lt;description key="test.action.webwork.desc"&gt;Action used to demonstrate test example.&lt;/description&gt;
		&lt;actions&gt;
			&lt;action name="com.mycompany.jira.plugin.test.web.actions.TestAction"
				alias="TestAction"&gt;
				&lt;view name="error"&gt;/template/plugin/webwork/testaction.vm&lt;/view&gt;
				&lt;view name="input"&gt;/template/plugin/webwork/testaction.vm&lt;/view&gt;
			&lt;/action&gt;
		&lt;/actions&gt;
	&lt;/webwork1&gt;

2. Some parts of vm template "testaction.vm" mapped to action class TestAction.java

#set($names = $action.getNames())
#set($counter = $names.size())
#if($counter &gt; 0)
	#set( $i = 1 )
	#foreach( $name in $names )
		&lt;tr&gt;
			&lt;td class="fieldLabelArea"&gt;
				$i18n.getText("name.action.label")
				&lt;span class="icon icon-required"&gt;&lt;span&gt;$i18n.getText("general.field.required")&lt;/span&gt;&lt;/span&gt;
			&lt;/td&gt;
			&lt;td class="fieldValueArea"&gt;
				&lt;input type="text" id="name_$i" value="$!name"&gt;
			&lt;/td&gt;  
		&lt;/tr&gt;
		#set($i = $i + 1)
	#end
#end

3. TestAction.java

public class TestAction extends JiraWebActionSupport {

	private String nameList;
	private TestService testService;
	
	public TestAction(TestService testService) {
		this.testService = testService;
	}

	@Override
	protected void doValidation() {
		super.doValidation();
		// Some other TestAction validation
	}

	@Override
	@RequiresXsrfCheck
	protected String doExecute() throws Exception {
		if (hasAnyErrors())return ERROR;
		// Some execute TestAction code
		return INPUT;
	}

	public String getNameList() {
		return nameList;
	}
	
	public void setNameList(String nameList) {
		this.nameList = nameList;
	}
	
	public List&lt;String&gt; getNames() {
		return testService.getHelper().tokenize(nameList, "@@");
	}

}

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Your experience may be impacted by an Atlassian Cloud Services incident. View latest updates.

Forums

Q&A

Community resources

Support

Top groups

Community resources

Support

Learn

Community resources

Support

Events

Community resources

Support

Jira and Velocity - form field

1 answer

1 accepted

Suggest an answer

Was this helpful?

Thanks!

TAGS

Community showcase

Atlassian Community Events