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.

A Project is the workspace boundary for a document-heavy business process. It brings together the documents, data definitions, review forms, Activity Plans, Tasks, knowledge, integrations, and access rules needed to run a real workflow. Projects do not define the whole operating model by themselves. The operating model comes from the mental model introduced in Concepts:
  • Activities run automated work.
  • Tasks represent human review and exception handling.
  • Data Definitions describe the structured business data you want from unstructured documents.
  • Data Forms give reviewers a usable surface for reviewing that data.
  • Knowledge captures reusable business context, classifications, and rules.

​
What a Project Contains

ResourceRole in the workflow
Document StoresWhere incoming files and their Kodexa document representations live
Data StoresStructured operational data associated with the process
Data DefinitionsThe object and field model for extracted business data
Activity PlansReusable automated processes bound into this project
Task TemplatesHuman review surfaces and assignments that Activities can create
Data FormsReview and correction UI for extracted data
Knowledge SetsReference knowledge, classifications, and enrichment rules
StatusesProject-specific document, task, and attribute states
Service BridgesExternal systems the workflow calls through governed integrations

​
Why Projects Matter

Projects let you keep reusable platform assets and local business configuration separate. An Activity Plan can be defined once for an organization, then bound to multiple projects that have different stores, data definitions, review queues, or downstream systems. That separation is important when the same process shape repeats across business units. An invoice intake workflow, claims intake workflow, or covenant compliance workflow may share the same Activity structure while still using project-specific stores, forms, statuses, and permissions.

​
Working with Projects in the SDK

Projects are owned by organizations. Use the SDK to find an organization, then list or load its projects. 
from kodexa.platform import KodexaClient

client = KodexaClient()
organization = client.organizations.find_by_slug("acme")

projects = organization.projects.list().to_df()
print(projects)

project = organization.projects.find_by_name("Invoice Operations")
print(project.id)
Once you have a project, use its resource accessors to inspect the project boundary. 
document_stores = project.document_stores.to_df()
print(document_stores)

​
Project Design Checklist

When modeling a new business process, define these decisions explicitly:
  1. Which documents enter the process, and where they should be stored.
  2. Which business objects and fields must be extracted.
  3. Which Activity Plan runs the automated work.
  4. Which Tasks are created when judgment or exception handling is required.
  5. Which Data Forms reviewers use to complete those Tasks.
  6. Which Service Bridges connect to downstream systems.
  7. Which statuses show the state of documents, Tasks, and attributes.

​
Next Steps

Activities

Understand automated business process runs.

Tasks

Understand human review work inside the workflow.

Activity Plans

Configure the steps that run automated work.

Project Templates

Package reusable project setup for repeatable deployments.