Setup New Plan Checklist

This document describes how can you setup a checklist to control Polarion Plans

To setup a Plan checklist you need to:

1. Create new custom field
2. Configure the Plan Report to show the checklist
3. Define a checklist template

1) Create a new custom field

This step is simple, just create a new custom field of type Text (multi-line plain text).

NOTE: you can setup multiple checklist custom fields.

2) Configure the Test Run Report to show the checklist

We now need to show the checklist on Test Run Report page.

1. Click "Customize Report Page" for your test run
2. We recommend to have the shared report template between a test run and test run template. So select "Customize Shared Report" if possible. Otherwise you need to repeat the step for all test runs.
   
3. Place the Script Block Widget where-ever you want to place your checklist on the page. And put there following line:
   
   $checklistService.getChecklistView().plan($plan).checklist("planDone").render()
   
   NOTES: The planDone refers to the id of you checklist custom field.
4. Save the report
5. The checklist shall be visible

3) Define a checklist template

1. Open your plan template, by clicking on template in the properties
2. If the checklist is not visible on this plan, repeat chapter 2 above for this plan template
3. Set your checklist there
4. The checklist from the template will be visible now also on  plans created from this template.