How to specify time spent with IssueInputParameters during transition of an issue?

Hi,

i have been trying to transition issues with parameters programmatically. I am using IssueInputParameters to update system field values. I have been able to update almost all system fields except for timespent(log effort)

I am unable to set that effort using the setTimeSpent() of IssueInputParameters, however it does not reflect in the Issue and i do not notice any error.

Code Snippet:

IssueInputParameters issueInputParameters = new IssueInputParametersImpl();
//Populate IssueInputParameters with field values
...        
//Validate if the transition is valid for the issue
IssueService.TransitionValidationResult validationResult = issueService.validateTransition(user, issue.getId(), actionId, issueInputParameters);
if (validationResult.isValid()) {
	log.debug("Executing valid transition ");
	transResult = issueService.transition(user, validationResult);
	...
}else {
	//transition failed
}

Any pointers/help in this case is really appreciated.

Thanks in advance.

1 answer

1 accepted

1 vote
Mahesh S Community Champion Jun 15, 2016

Try the below script. Change the value of time spent and let me know the results.

import com.atlassian.jira.ComponentManager
import com.atlassian.jira.bc.issue.IssueService
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.comments.CommentManager
import com.opensymphony.workflow.WorkflowContext
import org.apache.log4j.Category
import com.atlassian.jira.issue.IssueInputParameters
import com.atlassian.jira.util.JiraUtils;
  
IssueService issueService = ComponentAccessor.getIssueService()
IssueInputParameters issueInputParameters = issueService.newIssueInputParameters()
issueInputParameters.setTimeSpent(2L)
workflowTransitionUtil.validate()
workflowTransitionUtil.progress()

Hi Mahesh,

Thank you for the suggestion. One quick question.

How is "issueInputParameters" passed as a param or related to "workflowTransitionUtil"?

workflowTransitionUtil as i know requires a mutableIssue object. Please correct me incase.

-Parashar

Mahesh S Community Champion Jun 15, 2016

The method setTimeSpent comes from the interface issueInputParameters. This sets the value for the field. But, workflowTransitionUtil.validate() and workflowTransitionUtil.progress() helps for ErrorCollection while storing the values, since issue.store() is deprecated.

FYI, I have updated this comment.

Sure, let me try to set a mutableIssue object to validate with workflowTransitionUtil.validate().

Here is the code snippet

WorkflowTransitionUtil workflowTransitionUtil =
              ( WorkflowTransitionUtil ) JiraUtils.loadComponent( WorkflowTransitionUtilImpl.class );
            issueInputParameters.setTimeSpent(2L*3600);
            workflowTransitionUtil.setUsername(user.getEmailAddress());
            workflowTransitionUtil.setAction(actionId);
            com.atlassian.jira.issue.MutableIssue opt= ComponentAccessor.getIssueManager().getIssueObject(issueKey);
			opt.setTimeSpent(2L*3600);
            workflowTransitionUtil.setIssue(opt);
            Collection<String> validateErrors = workflowTransitionUtil.validate().getErrorMessages();
            for (String error : validateErrors) {
                System.out.println("ParaTransitionItr - Validate error   "+ error);
            }
            Collection<String> progressErrors =workflowTransitionUtil.progress().getErrorMessages();
            for (String error : progressErrors) {
                System.out.println("ParaTransitionItr - Progress error   "+ error);
            }

 

There are no errors, the transition is successful but time spent is not updated! Same as with IssueinputParameters in transition.

issueService.transition(user, validationResult);
Mahesh S Community Champion Jun 15, 2016

Yes, it sets the value but it is not storing I guess. However workflowTransitionUtil.validate() helps to store the value to db.

Correct. But here is where i am stuck since it does not write to database.

Mahesh S Community Champion Jun 16, 2016

Cool. Enjoy now! smile

Thank you very much smile 

I was able to set the time. But I have to use time logging API to be able to log time/effort properly.
Updated the code above that worked for me.

Mahesh S Community Champion Jun 16, 2016

Nice! Please share your new code as well. It might help others. smile

Updated code that worked with WorkflowTransitionUtil to set the Time spent with MutableIssue object.

WorkflowTransitionUtil workflowTransitionUtil =
              ( WorkflowTransitionUtil ) JiraUtils.loadComponent( WorkflowTransitionUtilImpl.class );
            workflowTransitionUtil.setUsername(userName);
            workflowTransitionUtil.setAction(actionId);
            com.atlassian.jira.issue.MutableIssue mutIssueObj= ComponentAccessor.getIssueManager().getIssueObject(issueKey);
			//set time to 2 hours
            mutIssueObj.setTimeSpent(2L*3600);
            workflowTransitionUtil.setIssue(mutIssueObj);
			workflowTransitionUtil.validate();
            workflowTransitionUtil.progress();

Thank you for the pointers smile

-Parashar

Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

3,176 views 13 19
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot