ArtifactsLast updated on
Last updated on
The four artifact types in OpenForm
OpenForm has 4 basic artifacts:
| Artifact | Description |
|---|---|
| Document | Static documents (e.g., disclosures, pamphlets) |
| Form | Dynamic documents that have parties, fields, annexes, and/or logic (e.g., contracts, applications, certificates) |
| Checklist | Compliance documents that track the completion of tasks or requirements (e.g., closing checklist) |
| Bundle | Containers 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