> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.cxplanner.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Asset documentation tracking / matrix

## Overview: asset documentation matrix

The asset document matrix in the Asset module lets you define required documents per asset type, track completion percentage per asset, and attach project files to document slots, which is used for structured turnover where every asset of a type needs the same document set such as manuals, drawings, and test reports.

* Your role must be **Admin** to enable the feature, and **Manager** or higher to configure requirements and attach files (or a matching assigned user group).
* You can find the menu at Asset module - **Types: Assets** (Document matrix), asset **Documents** tab, and asset overview percent columns.
* This changes document slots on assets, completion percentage, and attached project file links.

|| This is an Enterprise feature. The **Asset documents matrix** toggle only appears when your company has the AssetDocuments plugin enabled.

## What CxPlanner does with the document matrix

* Creates matching document slots on every asset of a configured type
* Tracks required-document completion as a percentage
* Links existing project files into document slots with **Attach**
* Leaves optional slots out of the completion percentage
* Shows **Documents %** and per-group percent columns in the asset overview

## How to use the asset document matrix

### Video guide

${frame}[Expert OR: Asset Documentation Matrix for Handover Tracking](https://www.loom.com/embed/0ee59ff77881428f960a9d990a7accd3)

### Enable the feature on the project

1. Open the project and go to **Project settings**.
2. Find the **Asset documents matrix** toggle and turn it on.
3. Save the project settings.

![Screenshot: Enable Asset documents matrix in project settings](https://storage.crisp.chat/users/helpdesk/website/-/e/a/2/c/ea2cfd7bb6130800/image_8hsbcz.png)

### Configure document groups and requirements

1. In the Assets sidebar, open **Types: Assets**.
2. Scroll to the **Document matrix** section for the asset type.
3. Click **Add document group**, enter a **Group name** (for example Drawings), and click **Create**.
4. To copy an existing setup, open **Advanced** and enable **Clone document matrix from another asset type**.
5. Inside a group, click **Add requirement**.
6. Enter a **Name** and optional **Description**.
7. Leave **Required** checked if the document should count toward completion.
8. Under **Advanced**, optionally set an **Assigned user group** and enable **Import to existing assets of this type**.
9. Click **Create**.

![Screenshot: Add a document group on an asset type](https://storage.crisp.chat/users/helpdesk/website/-/e/a/2/c/ea2cfd7bb6130800/image_6fbeyk.png)

### Fulfill documents on an asset

1. Open **Asset overview** and click an asset.
2. Select the **Documents** tab.
3. Find the requirement row in the **Document matrix** table.
4. Click **Attach** and select one file from project files.
5. Confirm **Fulfilled** shows **Yes** and **Newest file** shows the filename.
6. To replace a file, click **Detach**, confirm, then **Attach** a new file.

![Screenshot: Attach a document on the asset Documents tab](https://storage.crisp.chat/users/helpdesk/website/-/e/a/2/c/ea2cfd7bb6130800/image_dlnwnx.png)

### Fulfill documents from the asset overview

1. Open **Asset overview**.
2. Add the **Documents %** column if it is not visible.
3. Click a percent cell to open the document slots popup.
4. Click **Attach** or **Detach**, or open the filename.

![Screenshot: Documents percent popup in Asset overview](https://storage.crisp.chat/users/helpdesk/website/-/e/a/2/c/ea2cfd7bb6130800/image_fcsfcs.png)

### Open the dedicated document matrix view

1. Open **Asset overview**.
2. Click **Options** and select **Asset documents**.

## Results: document matrix behavior

| Action | Result |
|---|---|
| Enable Asset documents matrix | Documents tab and overview percent columns become available |
| Add a requirement | Matching slots are created on assets of that type |
| Attach a file | Slot is fulfilled; required completion percentage updates |
| Detach a file | Link is removed from the slot; the project file is not deleted |
| Delete a requirement | Slot is removed from the asset type and from assets |

| Action | Project role |
|---|---|
| Enable Asset documents matrix | Admin |
| Create, edit, delete groups and requirements | Manager or Admin |
| Attach and detach files | Manager or Admin, or matching assigned user group |
| View completion and open files | Any project role with asset access |

## Troubleshooting: asset documentation matrix

| Problem | Cause | Solution |
|---|---|---|
| No Document matrix or Documents tab | Plugin missing or feature not enabled | Confirm the AssetDocuments plugin is active, then ask an **Admin** to enable **Asset documents matrix** in project settings |
| No Attach or Detach on a slot | Your role is below the requirement, or you are not in the assigned user group | Ask a **Manager** to change **Assigned user group**, or to attach the file for you |
| Documents % stays at 0% after attaching files | Slots are marked Optional | Mark the slots **Required** on the asset type, then refresh the overview |
| New requirement missing on existing assets | Slots were not created on existing assets | Enable **Import to existing assets of this type**, or re-save the requirement |
| Detach did not clear the file | Confirmation was skipped or the request failed | Confirm in the **Detach** modal, refresh the Documents tab, and retry |