Page tree

You are on the Xporter Cloud documentation. If you are looking for Xporter Server documentation, you can find it in this page.

Skip to end of metadata
Go to start of metadata

Xporter for Jira Cloud allows you to export all the information available on the Issue Checklist Free and Issue Checklist Pro apps.

Definition

This integration provides a set of global mappings, being able to get an overview of the Issue Checklist.

FieldDescription
IssueChecklist.ProgressThe progress of the Issue Checklist, percentage of items marked as done.
IssueChecklist.CheckedCountThe number of Issue Checklist items completed.

IssueChecklist.UncheckedCount

The number of Issue Checklist items not complete.
IssueChecklist.ItemCountThe number of Issue Checklist items.
IssueChecklistThe Checklist YAML content.
IssueChecklistCountThe number of Issue Checklist.
Expand to see the sample code
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}


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

Issue Checklist Field

Description

StatusThe status of the item can have one of the following values: Todo, Skipped, In Progress or Done.
LabelThe label available on each line of the Issue Checklist.
DescriptionThe description available on each line of the Issue Checklist.
IsItemTrue if the Issue Checklist object is an Item.
CheckedTrue if the Issue Checklist Item is completed. (Skipped, Done)
Expand to see the 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


Let's use this integration to export data from Issue Checklist.



The result of the following template:

In order to get the same result on your generated document, check the template used:

Note

This integration gives the ability to customize the way how 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, with checkable and non-checkable values;
  • No labels