Content
View differences
Updated by Dominic Bräunlein about 1 year ago
# Admin Guide: Configuring Automatic Subjects
This guide explains how administrators configure **automatic subject admins define **subject patterns** for work packages in OpenProject. Subject patterns combine static text with dynamic attributes—such as dates, author names, or custom fields—to automatically generate consistent and informative work package types, ensuring clear, automated titles.
Automatic subject patterns help teams quickly identify tasks, reduce manual errors, and standardize naming conventions across your projects. ## 1\. Introduction
---
## 1. How Subject Patterns Work
A subject pattern includes a combination of:
- **Static text** (e.g., `Invoice`, `Vacation Request`)
- **Dynamic attribute placeholders** (e.g., `[Author]`, `[Start date]`, patterns embed placeholders, like `[Author]` or `[Custom Field: Invoice ID]`)
When users create ID]`, into titles. Users creating or edit editing work packages, OpenProject automatically replaces packages see subjects auto-generated from these placeholders with real attribute values, generating clear subjects. patterns, promoting consistency and clarity.
--- > **Tip:** See the [User Guide on Automatic Subjects](https://community.openproject.org/#) for the user's perspective.
## 2. 2\. Adding, Changing, and Deleting Attributes
Administrators configure subject patterns using a simple editor in the admin settings:
### 2.1 Adding Attributes
1. Navigate Go to **Administration → Work Package Types**, choose select a type, then open **Subject configuration**.
2. Type `/` in the input text field to open activate attribute search.
3. Search for and select Start typing an attribute name (e.g., “start date”); select it from the dropdown. The chosen attribute appears as dropdown to insert a placeholder pill (e.g., `[Start date]`).
### 2.2 Changing Attributes
- * Click directly into an existing pill. It becomes editable, triggering the attribute placeholder to edit it. This triggers search.
* Type the new attribute search again.
- Type name and select a different attribute from the dropdown. The placeholder pill updates automatically.
immediately.
### 2.3 Deleting Attributes
- Delete an attribute placeholder just like * Remove the pill as you would regular text (e.g., using backspace).
---
## 3. 3\. Supported Attributes Values and Limitations Display
### 3.1 Work package Patterns support concise attributes suitable for subjects:
Subject patterns can include placeholders referencing the following work package attributes:
| Attribute Name | Data Type | Example |
| -------------- | ----------------- | ---------- |
| Accountable | User name | Jon Doe |
| Assignee | User name | Jon Doe |
| Author | User name | Jon Doe |
| Category | String | Category A |
| Created on | Date | 2025-01-10 |
| * **Standard fields**: Author, Start date, Finish date | Date | 2025-01-15 |
| ID | Integer | 3000 |
| date, Status, Priority | String | Normal |
| Project | Project ID | 30 |
| Remaining work | Hours (float) | 8.0 |
| Start date | Date | 2025-01-12 |
| Status | String | New |
| Type | Work package type | Task |
| Work | Hours (float) | 10.0 |
* **User fields**: Assignee, Accountable
* **Version and Category**
* **Custom fields**: Supported custom fields include Text, Integer, Float, List, Date, Boolean, User, Version.
**Unsupported attributes**: Long Short text, integer, lists (long text and Link custom fields multi-select excluded)
* **Project attributes**: Project name, Project identifier
Unsupported attributes (long texts or ~~multi-selects~~) won’t appear in search results. \[ES: multi-selects are excluded to keep subjects concise. part now, they are represented as CSV\]
> **Note:** Ensure selected ## 4\. Limitations
* **Multi-select and long text fields** are not supported. \[ES: multi-selects are part now, they are represented as CSV\]
* Referencing unavailable attributes are activated and available or empty fields results in your **“N/A”**.
* Attributes from a parent or project and update only when the child work package types to avoid showing “N/A” in subjects.
### 3.2 Supported project attribute is saved.
## 5\. When Does the Subject Update?
| Attribute Name | Data Type | Example |
| ---------------------- | ----------- | -------- |
| Project: Active | Boolean | true |
| Project: Name | String | HR |
| Project: Status | Status code | on_track |
| Project: Subproject of | ID | 123 |
| Project: Public | Boolean | false |
**Custom project attributes:** Supported attributes include Integer, Float, List, Date, Boolean, User, Version.
**Unsupported project attributes**: Long text and Link custom fields are excluded to keep subjects concise.
---
## 4. Updating Automatic Subjects
Automatic subjects update regenerate automatically whenever an attribute referenced attributes change in the **current work package** changes and the work package is saved.
**Important:** Attributes referencing parent work packages or project upon saving. Changes to attributes won't trigger immediate updates. Changes in parent the **parent or project attributes appear only when project** require updating and saving the child work package itself is updated and saved again. again to refresh the subject.
---
## 5. Why "N/A" Appears 6\. “N/A” in Subjects
"N/A" indicates an empty or unavailable attribute referenced in the subject pattern. Typical causes: “N/A” appears when:
- The attribute hasn't been filled by the user.
- * A parent referenced attribute is referenced, but no empty.
* No parent is set, or the set (if parent doesn't contain attributes are referenced).
* Referenced attributes don’t exist for the attribute.
- The attribute isn't parent’s type.
* Attributes aren’t activated in for the current project.
Providing the missing attribute
Filling or enabling these attributes and saving the work package replaces **"N/A"** **“N/A”** with the actual value. values.
---
## 6. Tips for 7\. Choosing Effective Patterns
Good subject patterns should be:
- **Concise**: Keep subjects short and readable.
- **Relevant**: Include only * **Be concise**: Limit placeholders to essential attributes needed for quick identification.
- **Descriptive**: (date, ID, author).
* **Clear labels**: Use clear static text (e.g., `Invoice`, `Bug Report`) to define the short descriptions indicating work package type.
Check our
* **Start simple**: Begin with common or critical tasks (Invoices, Vacation Requests).
For examples, refer to [Example Subject Patterns](#) for inspiration. Patterns](https://community.openproject.org/#).
---
## 7. 8\. Further Resources Reading
- * [User Guide on Automatic Subjects](#)
- Subjects](https://community.openproject.org/#)
* [Tips for on Writing Effective Patterns](#)
---
Patterns](https://community.openproject.org/#)
**Summary:**
Automatic subjects subject patterns simplify task management work package identification by combining dynamic standardizing titles. Choose concise attributes with descriptive text. Thoughtful, concise patterns help carefully, maintain simplicity, and clearly communicate the benefits to your team quickly identify tasks, reduce errors, and ensure consistency across projects. users.
This guide explains how administrators configure **automatic subject
Automatic subject patterns help teams quickly identify tasks, reduce manual errors, and standardize naming conventions across your projects.
---
## 1. How Subject Patterns Work
A subject pattern includes a combination of:
- **Static text** (e.g., `Invoice`, `Vacation Request`)
- **Dynamic attribute placeholders** (e.g., `[Author]`, `[Start date]`,
When users create
---
## 2.
Administrators configure subject patterns using a simple editor in the admin settings:
### 2.1 Adding Attributes
1. Navigate
-
* Type
- Type
- Delete an attribute placeholder just like
---
### 3.1 Work package
Subject patterns can include placeholders referencing the following work package attributes:
| Attribute Name | Data Type | Example |
| -------------- | ----------------- | ---------- |
| Accountable | User name | Jon Doe |
| Assignee | User name | Jon Doe |
| Author | User name | Jon Doe |
| Category | String | Category A |
| Created on | Date | 2025-01-10 |
|
| ID | Integer | 3000 |
|
| Project | Project ID | 30 |
| Remaining work | Hours (float) | 8.0 |
| Start date | Date | 2025-01-12 |
| Status | String | New |
| Type | Work package type | Task |
| Work | Hours (float) | 10.0 |
* **User fields**: Assignee, Accountable
* **Version and Category**
*
**Unsupported attributes**: Long
* **Project attributes**: Project name, Project identifier
Unsupported attributes (long texts or ~~multi-selects~~) won’t appear in search results. \[ES: multi-selects
> **Note:** Ensure selected
* **Multi-select and long text fields** are not supported. \[ES: multi-selects are part now, they are represented as CSV\]
* Referencing unavailable
* Attributes from a parent or
### 3.2 Supported project attribute
## 5\. When Does the Subject Update?
| Attribute Name | Data Type | Example |
| ---------------------- | ----------- | -------- |
| Project: Active | Boolean | true |
| Project: Name | String | HR |
| Project: Status | Status code | on_track |
| Project: Subproject of | ID | 123 |
| Project: Public | Boolean | false |
**Custom project attributes:** Supported attributes include Integer, Float, List, Date, Boolean, User, Version.
**Unsupported project attributes**: Long text and Link custom fields are excluded to keep subjects concise.
---
## 4. Updating Automatic Subjects
Automatic subjects update
**Important:** Attributes referencing parent work packages or project
---
## 5. Why "N/A" Appears
"N/A" indicates an empty or unavailable attribute referenced in the subject pattern. Typical causes:
- The attribute hasn't been filled by the user.
-
* No
* Referenced attributes don’t exist for
- The attribute isn't
* Attributes aren’t
Providing the missing attribute
Filling or enabling these attributes
---
## 6. Tips for
Good subject patterns should be:
- **Concise**: Keep subjects short and readable.
- **Relevant**: Include only
- **Descriptive**:
* **Clear labels**:
Check our
* **Start simple**: Begin with common or critical tasks (Invoices, Vacation Requests).
For examples, refer to
---
## 7.
-
-
*
---
Automatic subjects