/
Custom Fields Guide

Custom Fields Guide

Smart Checklist provides custom fields that extend functionality across Jira, including JQL search, automation possibilities, cloning, data import/export, checklist completion validation, and more.

Contents👇🏼

Overview

Smart Checklist provides pre-configured custom fields when the app is installed – no additional setup required. These fields enable deeper Jira integration, allowing you to:

  • Search checklists using JQL

  • Automating checklist

  • Validate checklist completion in workflows

  • Access and update checklists via the API

  • Add checklists to Jira screens

  • Import and export checklist data

This article explains how to use these custom fields to integrate checklists more deeply with Jira.

Custom Fields

Field

Used for

Field

Used for

“Checklists” custom field

Paragraph text field storing checklist content in raw Markdown format.

☝🏼NOTE: For Team-managed projects the field must be on added to the issue screen for automation and cloning to work.

“Smart Checklist“ custom field

Custom application field for rendering checklist with formatted UI.

“Smart Checklist Progress” custom field

Short text field for storing checklist progress in x/y format
(x = completed items, y = total items count)

Custom Field Setup & Recommended Configuration

All Smart Checklist custom fields are created automatically when the app is installed.

If a field was removed, recreate it using:

  • Checklists → Paragraph (supports rich text) field type

  • Smart Checklist Progress → Short text field type

  • Smart Checklist → Cannot be deleted and recreated manually

☝🏼NOTE: Use Global context for all fields.
This prevents automation failures, visibility issues, and migration inconsistencies.

 

Q&A

Each field serves a different purpose and provides deeper Smart Checklist integration with Jira :

Field

Purpose

Field

Purpose

“Checklists” custom field

  • automation possibilities

  • data backup

  • import/export

  • issue cloning

  • JQL serach

  • work with checklist via API

“Smart Checklist” custom field

  • render checklists on Create and Transition screens

“Smart Checklist Progress” custom field

  • display checklist progress on board

  • checklist completion validator

 

Checklists field → editable raw data for automation, cloning, CSV import/export.

Issue properties → optimized representation for JQL, validators, and internal backup.

Problem: The “Checklists“ field is empty for source issues.

Solution: Associate “Checklists” custom field with the project context or provide the global context. and run data synchronization → https://railsware.atlassian.net/wiki/spaces/CHK/pages/3661922311.

Solution: Add the “Checklists” field to the issue screen and field is empty.

Check that the field has a global context and is available for all issue types.

In Team Managed projects: the “Checklists” field must be added to the issue screen.
In Company Managed projects: associate the “Checklists“ field with the project context or provide the global context.

Run Synchronization → https://railsware.atlassian.net/wiki/spaces/CHK/pages/3661922311
It will synchronize data between the “Checklists“ field, app storage and issue properties.

NOTE: recommended to use after CSV import.

Yes. Running it populates issue properties, which are required for validators and improved JQL searches.

If you want to keep only “Checklists“ custom field:

  • Run data synchronization for the “Checklists“ field

  • Validate the synchonized data

  • Remove duplicated fields

No worries. Checklist data is still available in the app’s storage.
Just manually recreate the field and run data synchronization.

The Checklists field is either:

  • not added to project/issue type context, or

  • missing from Team-managed screens.

  • For Company-managed projects: Yes, you can safely hide the field.

  • For Team-managed projects: Not recommended, as it may cause checklist automation and cloning to function incorrectly.

Yes, Smart Checklist will work but with limited functionality (no JQL, limited automations possibilities etc.)