OdooWiki OCA HUB

Project Key

project_key folder_open OCA/project open_in_new
Project License: LGPL-3

This module provides functionality to uniquely identify projects and tasks by simple key field.

auto_awesome What this module does

AI-generated from the code · Odoo 19.0

Gives every project a short unique key and every task an automatic key built from the project key plus a running number, so people can refer to projects and tasks by short codes instead of long names.

This module adds a short code (a "key") to projects and tasks, so you can talk about "PRJ-12" instead of a long title.

  • On a project, a key field appears in the project form and is required. If you leave it empty, Odoo builds one from the project name (first letters of the words, or the first three letters of a single word) and adds a number if that code is already taken. Keys must be unique, and a warning is shown if you use a dash in a project key.
  • Each project gets its own numbering sequence for tasks, starting at 1 and prefixed with the project key. New tasks automatically receive the next key, and tasks moved to another project get a new key from that project's sequence (including their sub-tasks).
  • Keys are shown in front of the name on project and task forms, in task lists and kanban cards, and in the customer portal task list and task page. Searching projects and tasks by name also matches the key, and the portal search bar offers a "Search in Key" option.
  • Short web addresses like /projects/KEY and /tasks/KEY open the matching project or task.
  • When the module is installed, existing projects and their tasks are given keys automatically.

It extends project.project and project.task and touches the project and task screens, the sharing views and the portal.

Depends on

portalproject
Models and fields (2)
  • project.task · extends an existing modelkey, url (URL)
  • project.project · extends an existing modelkey, show_key_warning, task_key_sequence_id (Key Sequence)

Text generated by AI (DeepSeek) from reading the Odoo 19.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 7 confirmed, 2 with no information of 9 versions.

terminal Installation and usage

OCA documentation · Odoo 19.0

Usage

Source · Odoo 19.0

To use this module functionality you just need to:

On project.project level:

In Kanban View:

  • Go to Project \> Dashboard
  • Create
  • Enter project name and use auto generated key or simply override value by entering your own key value.

In Tree View:

  • Go to Project \> Configuration \> Projects
  • Create
  • Enter project name and use auto generated key or simply override value by entering your own key value.

In form View:

  • Go to Project \> Dashboard
  • Open the projects settings
  • Modify the "key" value
  • After modifying project key the key of any existing tasks related to that project will be updated automatically.

When you create a project, under the hood a ir.sequence record gets creted with prefix: <project-key>-.

On project.task level:

  • Actually there is nothing to be done here
  • Task keys are auto generated based on project key value with per project auto incremented number (i.e. PA-1, PA-2, etc)

In browser address bar:

  • Navigate to your project by entering following url: \<\\>/projects/PROJECT-KEY
  • Navigate to your task by entering following url: \<\\>/tasks/TASK-KEY

No verified information in OCA: Installation, Configuration.

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.