Skip to main content

Introducing Projects

Learn about Projects, their purpose, and some key concepts

Updated today

Overview

Projects in Kodexa bring together various resources to address specific unstructured data use cases. A Project is a container that organizes Document Stores, Data Stores, Data Definitions, and other resources into a cohesive workflow. Projects are designed to be flexible and adaptable to a wide range of data processing scenarios.

What is a Project?

A Project is a workspace where you organize and manage all the resources needed for a specific data processing use case. Each Project includes:

  • Document Stores - Storage for unstructured documents

  • Data Stores - Storage for extracted structured data

  • Data Definitions - Templates defining the structure of data to extract

  • Assistants - AI-powered tools that connect and automate workflows

  • Workspaces - Interactive environments for working with documents and data

Creating a New Project

To create a new Project:

  1. Navigate to your Organization's homepage

  2. Click the New Project button

  3. Choose to create from a template or start from scratch

  4. If using a template, select from the Project Marketplace

  5. Enter a name and description for your Project

Project Templates

When creating a Project from a template, you'll see the Project Marketplace showing available templates. The templates available depend on your Organization's associated templates. Projects created from templates include a link in the Project Overview to learn about using that specific template.

Project Properties

Each Project has several configurable properties visible in the Project Overview:

Basic Information

  • Name - A unique identifier for your Project

  • Description - Optional details about the Project's purpose

  • Status - Set to Active, Archived, or None to organize Projects

  • Owner - The team member responsible for the Project

  • Notes - Additional information and documentation

Project Options

Projects include configurable options organized into two categories:

  • General Options - Standard configuration settings available to all users

  • Developer Options - Advanced settings including cloud models and embeddings for technical users

Working with Projects

Opening a Workspace

Projects provide access to Workspaces where you can interact with documents and data. Click the Open Workspace button in the Project Overview to launch the interactive workspace environment.

Managing Project Information

You can update Project properties at any time:

  1. Navigate to the Project Overview or Project Management page

  2. Update the Name, Description, Status, or Owner as needed

  3. Changes are saved automatically

Deleting a Project

When deleting a Project, you can choose whether to:

  • Delete Project only - Removes the Project but keeps associated resources

  • Delete Project and resources - Removes the Project and all related Document Stores, Data Stores, and other resources

Note: Project deletion cannot be undone. Ensure you have backups of any important data before deleting.

Project Organization

Project Status

Use Status to organize your Projects:

  • Active - Projects currently in use

  • Archived - Completed or inactive Projects that may be referenced later

  • None - No specific status assigned

Project Ownership

Assign an Owner to clarify responsibility and facilitate collaboration. The Owner can be changed at any time through the Project Overview.

Next Steps

After creating a Project, you can:

  • Add Document Stores to upload and organize documents

  • Define Data Definitions to specify what data to extract

  • Create Assistants to automate workflows

  • Open Workspaces to interact with your documents

  • Configure Project Options to customize behavior

Did this answer your question?