OpenForm

Artifacts

Last updated on

The four artifact types in OpenForm

OpenForm has 4 basic artifacts:

ArtifactDescription
DocumentStatic documents (e.g., disclosures, pamphlets)
FormDynamic documents that have parties, fields, annexes, and/or logic (e.g., contracts, applications, certificates)
ChecklistCompliance documents that track the completion of tasks or requirements (e.g., closing checklist)
BundleContainers for Documents, Forms, Checklists and even other Bundles (e.g., loan application packet)

Base properties

All artifacts share the same base properties:

name: string
Unique identifier; must follow slug constraints
version?: string
Artifact version (semantic versioning). Required for publishing to registry
title?: string
Human-friendly name presented to end users. Recommended for published/shared artifacts and directory browsing
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/published
metadata?: Metadata
Custom metadata map

On this page