Skip to main content

​
Importing via Template Application

The primary method for importing a checklist is through the template system. When you configure a template for a checklist field, Checklist automatically merges the template items into the work item’s checklist when it is opened.

​
Step 1: Prepare a Template Work Item

Create a work item that contains the checklist items you want to import. Populate the checklist custom field with all the items, marking mandatory items and setting any default result states.
Create template work items that are not used for regular work. Any modification to the template work item’s checklist propagates to all items that reference it.

​
Step 2: Configure the Template Property

Open Polarion Administration > Configuration Properties and add the appropriate property. For work item checklists: 
nextedy.checklist._TYPEID._FIELDID.workItemTemplateId=TEMPLATE-WI-ID
Replace _TYPEID with the work item type (for example, requirement), _FIELDID with the checklist custom field ID, and TEMPLATE-WI-ID with the work item ID that holds the template. For document checklists: 
nextedy.checklist._TYPEID._FIELDID.documentTemplateId=SpaceName/DocumentName
Cross-project references are supported using the projectId:workItemId format: 
nextedy.checklist.requirement.dod.workItemTemplateId=SharedProject:TEMPL-42

​
Step 3: Open the Target Object

When you open a work item, document, test run, or plan that has the template configured, the checklist field automatically merges items from the template. diagram Template merging adds missing template items to the checklist while preserving any items you added locally.

​
Controlling Template Merge Behavior

​
Disable Merging at Specific Statuses

You can freeze the checklist at certain workflow statuses to prevent template items from being added after a gate: 
nextedy.checklist._TYPEID._FIELDID._STATUS.mergeTemplate=false
For example, to stop merging when a work item reaches the reviewed status: 
nextedy.checklist.dod.reviewed.mergeTemplate=false

​
Disable Merging After Resolution

To stop template merging once a work item has a resolution set: 
nextedy.checklist._TYPEID._FIELDID.mergeTemplateResolved=false
For example: 
nextedy.checklist.dod.mergeTemplateResolved=false
See Freezing Checklists by Status for complete details.

​
Importing via Workflow Function

You can trigger checklist template application during workflow transitions using the ChecklistApplyTemplate workflow function. This approach ensures the checklist is populated at a specific point in the workflow.

​
Configure the Workflow Function

Add the ChecklistApplyTemplate function to a workflow transition:
ParameterValueDescription
checklistComma-separated field IDsChecklist custom fields to apply templates to
For example, attach it to a “Start Work” transition to ensure the checklist is populated when an engineer begins work.
If you omit the checklist parameter, the workflow function throws an error. Always provide at least one checklist custom field ID.

​
Multi-Field Application

Apply templates to multiple checklist fields in a single transition by specifying comma-separated field IDs: 
checklist = dod,dor,reviewChecklist
This applies the configured template to each listed field.

​
Importing via Reset to Template

If a checklist has been modified and you want to reimport the template (discarding local changes), use the ChecklistResetToTemplate workflow function.
ParameterValueDescription
checklistComma-separated field IDsChecklist fields to reset
skipForUsersComma-separated user IDs (optional)Users who bypass the reset
Unlike ChecklistApplyTemplate (which merges), ChecklistResetToTemplate replaces the entire checklist with the template content. All manually added items and result states are lost.
Use the skipForUsers parameter to exempt administrator accounts during bulk data migrations. This prevents automated resets from overwriting imported data.

​
Dynamic Template Selection

For scenarios where the template varies per work item instance, use the workItemTemplateHolder configuration property: 
nextedy.checklist._TYPEID._FIELDID.workItemTemplateHolder=myTemplateField
This tells Checklist to read the template work item ID from a custom field on the work item itself. The workItemTemplateHolder value takes priority over the static workItemTemplateId. For documents, the equivalent property is: 
nextedy.checklist._TYPEID._FIELDID.documentTemplateHolder=myDocTemplateField

​
Bulk Import Considerations

As of version 24.9.0, checklists do not load when bulk-editing work items of mixed types. This prevents template corruption when different work item types share the same checklist field ID but reference different templates. Select work items of a single type when performing bulk edits.
Enterprise customers creating documents from templates with multiple work items should be aware that checklist templates are not automatically embedded within document templates. Configure checklist template properties at the project or global level, or use the ChecklistApplyTemplate workflow function to apply templates after document creation.

​
Verification

After configuring your import method:
  1. Open a work item (or document, test run, plan) with the template configured
  2. You should now see the checklist populated with items from the referenced template
  3. If using a workflow function, trigger the configured transition and verify the checklist items appear
  4. Confirm that locally added items are preserved (for merge) or replaced (for reset)

​
See Also

KB ArticlesSupport TicketsSource Code
  • ChecklistService.java
  • ChecklistSetupService.java
  • DocumentChecklistView.java
  • ChecklistAdminServlet.java
  • ChecklistAllChecked.java