Skip to main content

​
Prerequisites

  • Nextedy CHECKLIST version 25.1.0 or later
  • Type-specific checklist templates already configured for each work item type
  • Access to Polarion Administration > Configuration Properties

​
When You Need This

You have multiple work item types that share the same checklist custom field ID but use different templates. For example: 
nextedy.checklist.userstory.testChecklist.workItemTemplateId=CHEC-287
nextedy.checklist.requirement.testChecklist.workItemTemplateId=CHEC-288
Both user stories and requirements use the testChecklist field, but each has its own template with type-appropriate checklist items. When someone changes a work item from one type to another, the checklist needs to reset to the new type’s template.

​
Configuring Automatic Reset on Type Change

​
Step 1: Verify Your Type-Specific Templates

Confirm that each work item type has its own template configured. Navigate to Administration > Configuration Properties and verify entries like: 
nextedy.checklist.userstory.testChecklist.workItemTemplateId=CHEC-287
nextedy.checklist.requirement.testChecklist.workItemTemplateId=CHEC-288

​
Step 2: Enable Type Change Monitoring

Add the following configuration property to specify which checklist field IDs should be monitored for type changes: 
nextedy.checklist.checklistsIdsForTypeChanges=testChecklist,dor
This property accepts a comma-separated list of checklist custom field IDs. When a work item type changes and any of these checklists contain data, the checklist is automatically reset to the template defined for the new type.

​
Step 3: Save and Test

  1. Navigate to Administration > Configuration Properties.
  2. Add the nextedy.checklist.checklistsIdsForTypeChanges property with the relevant field IDs.
  3. Save the configuration.

​
How the Reset Works

The following diagram illustrates the automatic reset flow: diagram When a work item is saved after a type change:
  1. The system compares the current type against the previously saved revision.
  2. If the type has changed, it checks whether any configured checklist fields contain data.
  3. For each monitored checklist field with data, the checklist is reset and the new type’s template is applied.
  4. The reset action is logged for audit purposes.
The reset operation discards all user changes to the checklist, including checked items, notes, and manually added items. The checklist is replaced entirely with the template for the new work item type. Ensure users understand this behavior before enabling the feature.

​
Example Walkthrough

Starting state: A User Story with the testChecklist field containing completed checklist items. User story with completed checklist items before type change Action: Change the work item type from User Story to Requirement. Work item type change action in Polarion Result: After the type change, the checklist resets to the Requirement template because testChecklist is listed in nextedy.checklist.checklistsIdsForTypeChanges. Checklist reset to requirement template after type change

​
Configuration Reference

PropertyValueDescription
nextedy.checklist.checklistsIdsForTypeChangesComma-separated field IDsChecklist fields to monitor and reset on type change
nextedy.checklist._TYPEID._FIELDID.workItemTemplateIdWork item IDTemplate source for each type (e.g., CHEC-287)
The workItemTemplateId property supports cross-project references using the format projectId:workItemId. This allows you to maintain a central template project shared across multiple projects.

​
Disabling the Save Hook

If you encounter conflicts with other Polarion extensions that also use save hooks (such as EHCache conflicts), you can disable the Checklist save hook entirely with the system property: 
nextedy.checklist.disable.hook
Setting nextedy.checklist.disable.hook disables both the type change reset and the summary field synchronization. Core checklist functionality (editing, templates, workflow functions) continues to work. Only use this as a workaround for save hook conflicts.

​
Mixed-Type Bulk Edit Behavior

Starting with version 24.9.0, checklists do not load when bulk-editing work items of mixed types. This intentional change prevents template corruption when different work item types share the same checklist field ID. If you select work items of different types and open the bulk editor, the checklist field will not be displayed.

​
Verification

You should now see:
  • After changing a work item type, the checklist resets to the template configured for the new type
  • Only checklists listed in nextedy.checklist.checklistsIdsForTypeChanges are affected
  • Checklists on fields not listed in the property remain unchanged during type changes
  • The reset applies the full template for the new type, replacing all previous items

​
See Also

  • Creating and Managing Templates — Define checklist template work items, configure template properties, and manage cross-project template references
  • Multiple Templates per Type — Configure different checklist templates for different work item types using the hierarchical property system
  • Workflow Gates and Validation — Add workflow conditions and functions to enforce checklist completion before status transitions
  • Troubleshooting — Diagnose and resolve common checklist issues including save hook conflicts, template merging errors, and rendering problems
KB ArticlesSupport TicketsSource Code
  • ChecklistResetToTemplate.java
  • SaveHandler.java
  • ChecklistService.java
  • DocumentChecklistView.java
  • IChecklistService.java