---
title: "Issue Checklist"
canonical: "https://docs.getxporter.app/space/XPORTERCLOUD/460221/Issue%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>[<span style="color: #172B4D">Issue Checklist. Free</span>](https://marketplace.atlassian.com/apps/1220209/issue-checklist-free?hosting=cloud&tab=overview)<span style="color: #172B4D"> and </span>[<span style="color: #172B4D">Issue Checklist. Pro</span>](https://marketplace.atlassian.com/apps/1213231/issue-checklist-pro?hosting=cloud&tab=overview)<span style="color: #172B4D"> apps.</span>

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

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

This integration provides a set of global [mappings](https://docs.getxporter.app/space/XPORTERCLOUD/558575), enabling you to get an overview of the Issue Checklist.

| **Field** | **Description** |
| --- | --- |
| IssueChecklist.Progress | <span style="color: #172B4D">The progress of the Issue Checklist, percentage of items marked as done</span> |
| IssueChecklist.<span style="color: #172B4D">CheckedCount</span> | <span style="color: #172B4D">The number of Issue Checklist items completed</span> |
| IssueChecklist.<span style="color: #172B4D">UncheckedCount</span> | <span style="color: #172B4D">The number of Issue Checklist items not complete</span> |
| IssueChecklist.<span style="color: #172B4D">ItemCount</span> | <span style="color: #172B4D">The number of Issue Checklist items</span> |
| IssueChecklist | The Checklist YAML content |
| IssueChecklistCount | The number of Issue Checklist |

```
Progress: ${IssueChecklist.Progress}%
Number of items completed: ${IssueChecklist.CheckedCount}
Number of items not completed: ${IssueChecklist.UncheckedCount}
Number of items in the Issue Checklist: ${IssueChecklist.ItemCount}
```

Additionally, it's possible to obtain more details by iterating over all the lines of the Issue Checklist.

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

## Sample Code

```
#{for IssueChecklist}
    ${IssueChecklist[n].Label}
    ${IssueChecklist[n].Description}    
    ${IssueChecklist[n].Status}
    ${IssueChecklist[n].Checked}
    ${IssueChecklist[n].IsItem}
#{end}

```

or

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

## Example

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

![image](media://11dc09dc-29d2-4c54-801a-d2219ff7b2d1)

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

![Figure 2 - Template](media://877f63fb-0bb4-42b0-839f-e9b9555f404d)

<span style="color: #0d0d0d">To achieve the same result in your generated document</span>, [refer to the Template used](https://docsxporter.atlassian.net/wiki/pages/viewpageattachments.action?pageId=460221&preview=%2F460221%2F460241%2FIssue+Checklist.docx).

> ℹ️ This integration provides the ability to customize the way the Issue 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, including 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>