OpenForm

Checklist

Last updated on

An artifact for tracking tasks and progress

A Checklist defines items to track within a workflow.

Each item can have a boolean (done/not done) or enumerated status (e.g., pending, approved, rejected).

Examples include a loan closing checklist, document review checklist, or onboarding checklist.

Properties

kind: "checklist"
Discriminator for checklist artifacts
name: string
Unique identifier; must follow slug constraints
version?: string
Artifact version (semantic versioning)
title?: string
Human-friendly name presented to end users
description?: string
Long-form description or context
code?: string
Internal code or reference number
releaseDate?: string
ISO date string indicating when the artifact was released
metadata?: Metadata
Custom metadata map (keys must be alphanumeric with hyphens)
items: ChecklistItem[]
Ordered list of checklist items
layers?: Record<string, Layer>
Named layers for rendering this checklist into different formats
defaultLayer?: string
Key of the default layer to use when none specified

ChecklistItem

Template-time checklist item definition.

id: string
Item identifier
title: string
Item title
description?: string
Item description
status?: StatusSpec
Status specification for this item

Examples

kind: checklist
name: loan-closing
version: "1.0.0"
title: Loan Closing Checklist

items:
  - id: title-search
    title: Title Search
    description: Complete title search and review
    status:
      kind: boolean
      default: false

  - id: appraisal
    title: Appraisal
    status:
      kind: enum
      options:
        - value: pending
          label: Pending
        - value: approved
          label: Approved
        - value: rejected
          label: Rejected
      default: pending

Related

  • Layer - Layer specification

On this page