Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Project templates are blueprints for creating new Kodexa projects with predefined resources, configuration, and workspace setup. They should prepare the project boundary for a business process; Activity Plans should define the automated work that runs inside that boundary.

​
What You’ll Learn

This guide covers:
  • When to use a project template
  • Which resources belong in a template
  • How templates support Activity Plans, Tasks, Data Definitions, Data Forms, and project workspaces
  • How to test a template before using it in production

​
Activity-First Template Model

Use this split when designing templates:
ConcernWhere it belongs
Automated work, dependencies, branches, scripts, bridge calls, LLM steps, approvalsActivity Plan
Human review setup, queue metadata, review status modelTask Templates and Task statuses
Extracted business data modelData Definitions
Review and correction UIData Forms
Project-specific document storage and workspace panelsProject Template
Shared business knowledge and classification contextKnowledge Sets

​
Quick Example

slug: invoice-operations
orgSlug: acme
version: 1.0.0
name: Invoice Operations
type: projectTemplate
description: Workspace setup for AP invoice intake and review

stores:
  - slug: "${project.id}-intake"
    name: "Invoice Intake"
    description: "Upload incoming invoices here"
    storeType: DOCUMENT
    storePurpose: OPERATIONAL

taskStatuses:
  - slug: ready-for-review
    label: Ready for Review
    statusType: TODO

  - slug: complete
    label: Complete
    statusType: DONE
    locked: true

taskTemplates:
  - slug: invoice-review
    name: Invoice Review
    description: Review extracted invoice fields and resolve exceptions

dataForms:
  - ref: "acme/invoice-review-form"

taxonomies:
  - ref: "acme/invoice"

workspaces:
  - name: Review Workspace
    slug: review
    workspaceStorage:
      availablePanels:
        documentStores: true
        dataForms: true
        taxonomies: true
        exceptions: true
        auditEvents: true
Deploy with: 
kdx deploy invoice-operations.yaml

​
Template Use Cases

Project templates are useful when you need to:
  • Onboard a new business unit to an existing Activity Plan
  • Recreate the same workspace structure for multiple customers or teams
  • Standardize document stores, statuses, Data Forms, and Task Templates
  • Bind a project to shared Data Definitions and Knowledge Sets
  • Keep workspace configuration reviewable as source-controlled metadata

​
Documentation Structure

Build Project Templates

Build an activity-first template step by step.

Template Structure Reference

Look up supported sections and fields.

​
Next Steps

  1. Read Activity Plans to understand the automated work model.
  2. Use Project Template Structure as the field reference.
  3. Build your first template with Build Kodexa Project Templates.