Skip to main content

Property Hierarchy

The system resolves properties in the following order, from most specific to least specific: diagram Where:
  • _TYPEID is the work item type ID (e.g., userstory, requirement, task)
  • _FIELDID is the checklist custom field ID (e.g., dod, dor, testChecklist)

Template Properties

Work Item Templates

PropertyTypeDefaultDescription
nextedy.checklist._TYPEID._FIELDID.workItemTemplateIdStringNoneWork item ID used as the checklist template source. Supports cross-project references with projectId:workItemId format
nextedy.checklist._TYPEID._FIELDID.workItemTemplateHolderStringNoneCustom field ID that holds the template work item ID dynamically. Overrides static workItemTemplateId when set
Example — static template per type:
nextedy.checklist.userstory.dod.workItemTemplateId=CHEC-287
nextedy.checklist.requirement.dod.workItemTemplateId=CHEC-288
nextedy.checklist.task.dod.workItemTemplateId=CHEC-289
Example — cross-project template reference:
nextedy.checklist.userstory.dod.workItemTemplateId=templates:TMPL-100
Example — dynamic template from custom field:
nextedy.checklist.userstory.dod.workItemTemplateHolder=checklistTemplateRef
When workItemTemplateHolder is set, the system reads the template work item ID from the specified custom field on the work item, allowing per-instance template selection.

Document Templates

PropertyTypeDefaultDescription
nextedy.checklist._TYPEID._FIELDID.documentTemplateIdStringNoneDocument location path used as the checklist template source for document checklists
nextedy.checklist._TYPEID._FIELDID.documentTemplateHolderStringNoneCustom field ID that holds the template document location dynamically for document checklists

Template Merging Properties

PropertyTypeDefaultDescription
nextedy.checklist._TYPEID._FIELDID._STATUS.mergeTemplateBooleanSee applicationControls whether template items are merged into the checklist at a specific workflow status. Set to false to freeze the checklist at that status
nextedy.checklist._TYPEID._FIELDID.mergeTemplateResolvedBooleanSee applicationControls whether template merging continues after the work item is resolved (has a resolution set). Set to false to stop merging on resolved items
Example — freeze checklist at “reviewed” status:
nextedy.checklist.dod.reviewed.mergeTemplate=false
nextedy.checklist.dod.mergeTemplateResolved=false
When template merging is disabled at a status, the checklist shows only data stored so far. Use the ChecklistApplyTemplate workflow function on the transition to the frozen status to ensure the checklist is synchronized with the latest template version. See Freezing Checklists by Status.

Mandatory Items

PropertyTypeDefaultDescription
nextedy.checklist._TYPEID._FIELDID.allMandatoryBooleanSee applicationWhen true, all checklist items are treated as mandatory regardless of their individual mandatory flag
Example — 4-level hierarchy for allMandatory:
# Level 1: Only for "dod" checklist on user stories
nextedy.checklist.userstory.dod.allMandatory=true

# Level 2: For "dod" checklist on any work item type
nextedy.checklist.dod.allMandatory=true

# Level 3: For any checklist on user stories
nextedy.checklist.userstory.allMandatory=true

# Level 4: For any checklist on any type
nextedy.checklist.allMandatory=true

Icon Customization

PropertyTypeDefaultDescription
nextedy.checklist.checked_signStringDefault iconFont Awesome class for the checked (OK) icon
nextedy.checklist.unchecked_signStringDefault iconFont Awesome class for the unchecked (NOK/rejected) icon
nextedy.checklist.no_signStringDefault iconFont Awesome class for the empty/not-addressed icon
Example — custom Font Awesome icons:
nextedy.checklist.checked_sign=fas fa-check-circle
nextedy.checklist.unchecked_sign=fas fa-times-circle
nextedy.checklist.no_sign=far fa-circle
Choose icons from the Font Awesome v5 free gallery. Use the class names shown on the icon detail page (e.g., fas fa-check-circle for a solid check circle). See Custom Icons for a step-by-step guide.

Type Change Reset

PropertyTypeDefaultDescription
nextedy.checklist.checklistsIdsForTypeChangesStringNoneComma-separated list of checklist custom field IDs to monitor for automatic reset when a work item type changes
Example:
nextedy.checklist.checklistsIdsForTypeChanges=testChecklist,dor
When a work item type is changed and the checklist field listed here contains data, the checklist is automatically reset to the template configured for the new type. See Reset on Work Item Type Change.

Summary Field

PropertyDescription
Summary field IDsConfigured per work item type. For each checklist field ID configured for summary, a corresponding {checklistId}_summary field is automatically updated on save
The summary field contains a text representation of the checklist state and enables Lucene full-text search on checklist content.
PlaceholderDescription
{checked}Count of checked items
{unchecked}Count of unchecked items
{rejected}Count of rejected items
{NA}Count of N/A items
{uncheckedMandatory}Count of unchecked mandatory items
{mandatory}Total count of mandatory items
{checkedMandatory}Count of checked mandatory items
{all}Total count of all items

System Properties

PropertyTypeDefaultDescription
nextedy.checklist.disable.hookSystem propertyNot setDisables the Checklist save hook entirely. Removes automatic type change reset and summary field synchronization. Use as a workaround for save hook conflicts with other extensions
If multiple Polarion extensions use save hooks simultaneously, EHCache conflicts may occur. Setting nextedy.checklist.disable.hook disables the Checklist save hook. This removes summary field updates and type change reset functionality but preserves all other Checklist features. See Troubleshooting.

Baseline Properties

PropertyDefaultDescription
Baseline item typebtaskWork item type used for storing baseline checklist data
Baseline fieldbaselineCustom field name used to store baseline revision identifiers
Baseline property names are resolved through the document context. Consult your project configuration for the exact property keys used in your environment.

See Also

KB ArticlesSupport TicketsSource Code
  • ChecklistFormExtension.java
  • ChecklistView.java
  • ChecklistAllChecked.java
  • DocumentChecklistView.java
  • ChecklistApplyTemplate.java