How to reset Checklist to the Template on WI type change

Modified on Tue, 7 Jan at 12:19 PM

Having specific Checklist templates for different WI types: 

You might have a few Work Item types that use the same Checklist ID but have their own type-specific templates.

That is a standard behavior, where you configure the type-specific template IDs in the Configuration properties like below: 

nextedy.checklist.userstory.testChecklist.workItemTemplateId=CHEC-287

nextedy.checklist.requirement.testChecklist.workItemTemplateId=CHEC-288

You can see that the Checklist ID is the same in both cases 'testChecklist', but we specify different WIs as a template ID based on the WI type (userstory, requirement)



NEW! 

Available from Checklist version 25.1.0


Reset the Checklist to the template on WI type change action:

It might happen that you need to change the WI type into a different item, which also has its own Checklist template.


In this case, you'll need to add the property specified below into Polarion Administration - Configuration properties and put there comma-separated checklist IDs that shall be monitored on the type change.


If such a checklist is not empty and the WI type is changed, the Checklist will be reset to the template.


Configuration property to monitor Checklist IDs on WI type change:

nextedy.checklist.checklistsIdsForTypeChanges=testChecklist,dor


After adding this property, the WI with the changed type will have a Checklist as defined in the template for the WI its been converted into.



Example:


- There is a Userstory that uses "testChecklist" and has some checklist entries.


- For some reason, we need to change the WI type of this Userstory to Requirement, which uses a different Checklist template.

- After performing the type change action, the 'Test Checklist' is reset to the Requirement template as this checklist ID was added and monitored in the Configuration Properties. 

nextedy.checklist.checklistsIdsForTypeChanges=testChecklist


- This way you can ensure that in the Checklist you'll see only those entries that are relevant for a given WI type.



Important note:

This solution was introduced as currently there is a tracked Polarion issue, which happens on the type change action that converts the checklist from multi-line plain text into rich text. 

We have already reported this issue to Siemens, but you may report it as well to speed up the process.



In case of any questions please contact us via [email protected]



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article