> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nextedy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration Properties

> All Nextedy CHECKLIST configuration properties are managed through **Polarion Administration > Configuration Properties**.

export const LastReviewed = ({date}) => {
  if (!date) return null;
  const formatted = new Date(`${date}T00:00:00Z`).toLocaleDateString("en-US", {
    year: "numeric",
    month: "long",
    day: "numeric",
    timeZone: "UTC"
  });
  return <p className="mt-10 text-sm text-gray-400 dark:text-zinc-500 not-prose">
      Last reviewed on {formatted}
    </p>;
};

## Property Hierarchy

The system resolves properties in the following order, from most specific to least specific:

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/Jklvz9qm2AdmIvBG/checklist/diagrams/reference/configuration-properties/diagram-1.svg?fit=max&auto=format&n=Jklvz9qm2AdmIvBG&q=85&s=1e1456e5ee941f9190289a68ad6c9f57" alt="diagram" style={{ maxWidth: "600px", width: "100%" }} width="600" height="520" data-path="checklist/diagrams/reference/configuration-properties/diagram-1.svg" />
</Frame>

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

| Property                                                    | Type     | Default | Description                                                                                                              |
| ----------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
| `nextedy.checklist._TYPEID._FIELDID.workItemTemplateId`     | `String` | None    | Work item ID used as the checklist template source. Supports cross-project references with `projectId:workItemId` format |
| `nextedy.checklist._TYPEID._FIELDID.workItemTemplateHolder` | `String` | None    | Custom field ID that holds the template work item ID dynamically. Overrides static `workItemTemplateId` when set         |

**Example -- static template per type:**

```properties theme={null}
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:**

```properties theme={null}
nextedy.checklist.userstory.dod.workItemTemplateId=templates:TMPL-100
```

**Example -- dynamic template from custom field:**

```properties theme={null}
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

| Property                                                    | Type     | Default | Description                                                                                   |
| ----------------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------- |
| `nextedy.checklist._TYPEID._FIELDID.documentTemplateId`     | `String` | None    | Document location path used as the checklist template source for document checklists          |
| `nextedy.checklist._TYPEID._FIELDID.documentTemplateHolder` | `String` | None    | Custom field ID that holds the template document location dynamically for document checklists |

## Template Merging Properties

| Property                                                   | Type      | Default         | Description                                                                                                                                          |
| ---------------------------------------------------------- | --------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nextedy.checklist._TYPEID._FIELDID._STATUS.mergeTemplate` | `Boolean` | See application | Controls 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.mergeTemplateResolved` | `Boolean` | See application | Controls 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:**

```properties theme={null}
nextedy.checklist.dod.reviewed.mergeTemplate=false
nextedy.checklist.dod.mergeTemplateResolved=false
```

<Warning title="Initialize before freezing">
  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](/checklist/guides/freeze-by-status).
</Warning>

## Mandatory Items

| Property                                          | Type      | Default         | Description                                                                                             |
| ------------------------------------------------- | --------- | --------------- | ------------------------------------------------------------------------------------------------------- |
| `nextedy.checklist._TYPEID._FIELDID.allMandatory` | `Boolean` | See application | When `true`, all checklist items are treated as mandatory regardless of their individual mandatory flag |

**Example -- 4-level hierarchy for `allMandatory`:**

```properties theme={null}
# 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

| Property                           | Type     | Default      | Description                                              |
| ---------------------------------- | -------- | ------------ | -------------------------------------------------------- |
| `nextedy.checklist.checked_sign`   | `String` | Default icon | Font Awesome class for the checked (OK) icon             |
| `nextedy.checklist.unchecked_sign` | `String` | Default icon | Font Awesome class for the unchecked (NOK/rejected) icon |
| `nextedy.checklist.no_sign`        | `String` | Default icon | Font Awesome class for the empty/not-addressed icon      |

**Example -- custom Font Awesome icons:**

```properties theme={null}
nextedy.checklist.checked_sign=fas fa-check-circle
nextedy.checklist.unchecked_sign=fas fa-times-circle
nextedy.checklist.no_sign=far fa-circle
```

<Tip title="Browse available icons">
  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](/checklist/guides/custom-icons) for a step-by-step guide.
</Tip>

## Type Change Reset

| Property                                        | Type     | Default | Description                                                                                                     |
| ----------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------- |
| `nextedy.checklist.checklistsIdsForTypeChanges` | `String` | None    | Comma-separated list of checklist custom field IDs to monitor for automatic reset when a work item type changes |

**Example:**

```properties theme={null}
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](/checklist/guides/type-change-reset).

## Summary Field

| Property          | Description                                                                                                                                                       |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Summary field IDs | Configured 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.

| Placeholder            | Description                        |
| ---------------------- | ---------------------------------- |
| `{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

| Property                         | Type            | Default | Description                                                                                                                                                                         |
| -------------------------------- | --------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nextedy.checklist.disable.hook` | System property | Not set | Disables 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 |

<Warning title="Save hook conflicts">
  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](/checklist/guides/troubleshooting).
</Warning>

## Baseline Properties

| Property           | Default    | Description                                                   |
| ------------------ | ---------- | ------------------------------------------------------------- |
| Baseline item type | `btask`    | Work item type used for storing baseline checklist data       |
| Baseline field     | `baseline` | Custom field name used to store baseline revision identifiers |

<Info title="Verify in application">
  Baseline property names are resolved through the document context. Consult your project configuration for the exact property keys used in your environment.
</Info>

## See Also

* [Workflow Functions and Conditions](/checklist/reference/workflow-functions) -- Workflow integration reference
* [IChecklistService API](/checklist/reference/api) -- Programmatic access to checklist data
* [Creating and Managing Templates](/checklist/guides/templates) -- Template setup guide
* [Freezing Checklists by Status](/checklist/guides/freeze-by-status) -- Status-based freezing guide

<LastReviewed date="2026-07-02" />