---
title: "Smart Checklist"
canonical: "https://docs.getxporter.app/space/XPORTERCLOUD/526502/Smart%20Checklist"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

# Introduction

[<span style="color: #172B4D">Xporter for Jira Cloud</span>](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?tab=overview&hosting=cloud)<span style="color: #172B4D"> allows you to export all the information available on the</span><span style="color: #172B4D"> </span>[Smart Checklist for Jira. Pro](https://marketplace.atlassian.com/apps/1216451/smart-checklist-for-jira-enterprise?hosting=cloud&tab=overview) and [Smart Checklist for Jira. Free](https://marketplace.atlassian.com/apps/1215277/smart-checklist-for-jira-free?hosting=cloud&tab=overview)<span style="color: #172B4D"> apps.</span>

# <span style="color: #172B4D">Using the Smart Checklist</span>

## <span style="color: #172B4D">Definition</span>

The Smart Checklist integration provides a set of global [mappings](https://docs.getxporter.app/space/XPORTERCLOUD/558575), <span style="color: #0d0d0d">enabling you to get an</span> overview of the Smart Checklist.

| **Field** | **Description** |
| --- | --- |
| SmartChecklist | The raw markdown value |
| SmartChecklistCount | The number of lines on the Smart Checklist |
| SmartChecklist.Progress | The progress of the Smart Checklist, percentage of items marked as done |
| SmartChecklist.CheckedCount | The number of Smart Checklist items completed |
| SmartChecklist.UncheckedCount | The number of Smart Checklist items not complete |
| SmartChecklist.ItemCount | The number of Smart Checklist items |

## Sample Code

```
Raw markdown: ${SmartChecklist}
Number of lines in the Smart Checklist: ${SmartChecklistCount}
Progress: ${SmartChecklist.Progress}%
Number of items completed: ${SmartChecklist.CheckedCount}
Number of items not completed: ${SmartChecklist.UncheckedCount}
Number of items in the Smart Checklist: ${SmartChecklist.ItemCount}
```

<span style="color: #0d0d0d">Additionally</span>, <span style="color: #0d0d0d">you can obtain more details by iterating over all the lines of the Smart Checklist.</span>

| <span style="color: #172B4D">**Smart Checklist**</span>** Field** | **Description** |
| --- | --- |
| Label | The label available on each line of the Smart Checklist |
| Status | The status of the item can have one of the following values: *Todo*, *Skipped*, *In Progress*, or *Done* |
| Checked | True if the Smart Checklist Item is completed |
| IsItem | True if the Smart Checklist object is an Item |

## Sample Code

```
#{for SmartChecklist}
	${wiki:SmartChecklist[n].Label}
	${SmartChecklist[n].Status}
	${SmartChecklist[n].Checked}
	${SmartChecklist[n].IsItem}
#{end}
```

or

```
#{for <VariableName>=FieldNameCount}
   Content and Issue Mappings. Example: ${FieldName[VariableName].Field}
#{end}
```

## Example

### Using this Integration to Export Data from Smart Checklist (Figure 1)

![image](media://aaaeb038-5c14-4314-a2af-ad8604908369)

### <span style="color: #172B4D">The Result of the Following Template (Figure 2)</span>

![Figure 2 - Template](media://b691eb6a-6184-4a94-8977-5f82c6887228)

To achieve the same result in your generated document, [refer to the Template used in this example](https://docsxporter.atlassian.net/wiki/pages/viewpageattachments.action?pageId=526502&preview=%2F526502%2F526534%2FSmart+Checklist.docx).

> ℹ️ This integration gives the ability to customize the way the Smart Checklist is displayed. 
> ℹ️ 
> ℹ️ You can define in your template which type of data you want to export:
> ℹ️ 
> ℹ️ - Use your own checkbox.
> ℹ️ - Export only the checkable items.
> ℹ️ - Export all the information, with checkable and non-checkable values.


<details>
<summary>Support/Troubleshooting</summary>

If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://docs.getxporter.app/space/XPORTERCLOUD/18251779/In-App+Chat+Support).
</details>