> ## 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.

# Reset on Work Item Type Change

> Automatically reset checklists to the correct template when a work item type changes, ensuring checklist items always match the target type.

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>;
};

## 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:

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

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

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

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/Jklvz9qm2AdmIvBG/checklist/diagrams/guides/type-change-reset/diagram-1.svg?fit=max&auto=format&n=Jklvz9qm2AdmIvBG&q=85&s=7138e0c08506ceb5a818065d5cb62962" alt="diagram" style={{ maxWidth: "740px", width: "100%" }} width="740" height="240" data-path="checklist/diagrams/guides/type-change-reset/diagram-1.svg" />
</Frame>

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.

<Warning title="All existing data is cleared">
  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.
</Warning>

## Example Walkthrough

**Starting state:** A User Story with the `testChecklist` field containing completed checklist items.

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/lFfu8PoRgYT7NTOd/checklist/assets/images/article-how-to-reset-checklist-to-the-te-01de0c6c.png?fit=max&auto=format&n=lFfu8PoRgYT7NTOd&q=85&s=248ef40a68e3f264d15846be56d21330" alt="User story with completed checklist items before type change" width="1474" height="992" data-path="checklist/assets/images/article-how-to-reset-checklist-to-the-te-01de0c6c.png" />
</Frame>

**Action:** Change the work item type from **User Story** to **Requirement**.

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/DmUJjOTXttZGhiDi/checklist/assets/images/article-how-to-reset-checklist-to-the-te-c74692e0.png?fit=max&auto=format&n=DmUJjOTXttZGhiDi&q=85&s=c982db513bef9ccdeedaf2f678f300f5" alt="Work item type change action in Polarion" width="924" height="470" data-path="checklist/assets/images/article-how-to-reset-checklist-to-the-te-c74692e0.png" />
</Frame>

**Result:** After the type change, the checklist resets to the Requirement template because `testChecklist` is listed in `nextedy.checklist.checklistsIdsForTypeChanges`.

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/lFfu8PoRgYT7NTOd/checklist/assets/images/article-how-to-reset-checklist-to-the-te-00aff1f4.png?fit=max&auto=format&n=lFfu8PoRgYT7NTOd&q=85&s=18d3c4fad26ae359813a46c58b6bd52f" alt="Checklist reset to requirement template after type change" width="1826" height="1388" data-path="checklist/assets/images/article-how-to-reset-checklist-to-the-te-00aff1f4.png" />
</Frame>

## Configuration Reference

| Property                                                | Value                     | Description                                          |
| ------------------------------------------------------- | ------------------------- | ---------------------------------------------------- |
| `nextedy.checklist.checklistsIdsForTypeChanges`         | Comma-separated field IDs | Checklist fields to monitor and reset on type change |
| `nextedy.checklist._TYPEID._FIELDID.workItemTemplateId` | Work item ID              | Template source for each type (e.g., `CHEC-287`)     |

<Tip title="Cross-project template references">
  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.
</Tip>

## 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:

```properties theme={null}
nextedy.checklist.disable.hook
```

<Warning title="Disabling the hook removes automatic features">
  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.
</Warning>

## Mixed-Type Bulk Edit Behavior

<Note title="Version 24.9.0 behavior change">
  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.
</Note>

## 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](/checklist/guides/templates) -- Define checklist template work items, configure template properties, and manage cross-project template references
* [Multiple Templates per Type](/checklist/guides/multiple-templates) -- Configure different checklist templates for different work item types using the hierarchical property system
* [Workflow Gates and Validation](/checklist/guides/workflow-gates) -- Add workflow conditions and functions to enforce checklist completion before status transitions
* [Troubleshooting](/checklist/guides/troubleshooting) -- Diagnose and resolve common checklist issues including save hook conflicts, template merging errors, and rendering problems

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