> ## 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.
# Set Up a Document (LiveDoc) Checklist
> Add a checklist to a LiveDoc by creating a custom field and embedding a checklist panel with a wiki block.
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
Last reviewed on {formatted}
;
};
To set up a checklist on a work item instead, see [Set Up a Work Item Checklist](/checklist/guides/setup/work-items).
## 1. Create the custom field
Create a new document custom field of type **Text (multi-line plain text)**. This field holds the checklist content; you'll reference its ID (for example `dod`) in the wiki block below.
## 2. Add a panel to your LiveDoc
1. Open your live document.
2. Navigate to the place in the document where you want the checklist to appear.
3. Insert a **Wiki Block**.
4. Put the following content into it:
```text theme={null}
$checklistService.getDocumentChecklistView().document($document).checklist("dod").title("Checklist").view($context).render()
```
* `"dod"` is the ID of your document checklist custom field from step 1.
* `.title("Checklist")` is optional — omit it if you don't want a title added above the checklist.
* You can also chain `.hideInPdf()` before `.render()` if you don't want the checklist to appear in PDF exports.
5. Save the document. You should see the checklist panel rendered in place of the wiki block.
**Hide the checklist in PDF exports**
If the interactive checklist widget doesn't make sense in a static PDF, append `.hideInPdf()` before `.render()`. The document checklist view automatically switches to a static HTML rendering of the checklist content when the document is being exported to PDF, unless it's hidden entirely.
## 3. (Optional) Define a checklist template
To centrally manage the checklist content on a document type — so edits to the template propagate to every LiveDoc using it — configure a document template ID:
```properties theme={null}
nextedy.checklist.documentSpecification.documentReadyChecklist.documentTemplateId=Specification/Product Spec Template
```
Here `documentSpecification` is the LiveDoc type and `documentReadyChecklist` is the checklist ID. See [Create a Checklist Template](/checklist/guides/templates/create-a-template) for the full property reference, including how to point at a template stored in another project.
**LivePages are also supported**
The checklist rendering methods described here (`getDocumentChecklistView()`) work on both Documents (LiveDocs) and **LivePages** (Info Pages). Embedding a checklist in a LivePage via a Script Block — e.g. `$checklistService.getDocumentChecklistView().workitem($wi).checklist("dor").view($context).render()` — renders an interactive checklist, and check/uncheck works and persists there just as it does on a LiveDoc.
## How data is saved
When a user checks or unchecks an item in the rendered panel, the browser posts the checklist ID, the target document, and the checklist data back to the server, which writes the change to the document's custom field inside a transaction. If the save fails, the server returns an error and logs the request parameters — useful information if you need to contact support about a document checklist that won't save.
**Follow-up from support: Test Run / LiveReport integration is not a documented setup path**
A separate request to embed Checklists inside Test Run or Test Run Template LiveReport pages was resolved via a live support call rather than written documentation, and is not covered by this guide. If you need a checklist inside a test run context, use the dedicated [Set Up a Test Run Checklist](/checklist/guides/setup/test-runs) guide rather than trying to adapt the document wiki-block snippet above.
## Verification
You should now see the checklist panel rendered inside your LiveDoc wherever you placed the wiki block, with items you can check and uncheck. If you added `.title("Checklist")`, confirm the title appears above the panel. Save the document and reopen it to confirm your checked items persist.
## See also
* [Set Up a Work Item Checklist](/checklist/guides/setup/work-items)
* [Create a Checklist Template](/checklist/guides/templates/create-a-template)
* [Shared and Cross-Project Templates](/checklist/guides/templates/shared-and-document-templates)
* [Control Who Can Change the Checklist](/checklist/guides/permissions)
* [Track and Compare Checklist Baselines](/checklist/guides/baselines)
**KB Articles**
* Setup new document (LiveDoc) checklist
* How to create checklist template?
* Setup new Work Items checklist
**Support Tickets**
* [#332](https://support.nextedy.com/helpdesk/tickets/332)
* [#235](https://support.nextedy.com/helpdesk/tickets/235)
* [#418](https://support.nextedy.com/helpdesk/tickets/418)
**Source Code**
* `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/ChecklistServlet.java`
* `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/internal/ChecklistAdminService.java`
* `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/IChecklistService.java`
* `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/wf/ChecklistFailIfMandatoryUnchecked.java`
* `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/wf/ChecklistApplyTemplate.java`