Skip to content

Commit 9606de3

Browse files
authored
Merge pull request #129 from genestack/Template-Editor-locked-parameters
Mandatory fields and Validity check info
2 parents 609ae75 + a3325eb commit 9606de3

File tree

5 files changed

+30
-0
lines changed

5 files changed

+30
-0
lines changed
-54.5 KB
Loading
-24.2 KB
Loading
85.4 KB
Loading
162 KB
Loading

docs/user-guide/doc-odm-user-guide/template-editor.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,24 @@ Templates include the following metadata options:
3434

3535
![image](doc-odm-user-guide/images/template-example.png)
3636

37+
!!! abstract "Mandatory Attributes"
38+
All templates contain mandatory technical fields that are **grayed out** in the user interface and cannot be edited or removed.
39+
40+
**Common field:**
41+
42+
- `genestack:accession`
43+
44+
**Tabular data fields:**
45+
46+
- `Features (string)`
47+
48+
- `Features (numeric)`
49+
50+
- `Values (numeric)`
51+
52+
- `Data Class` (for Tabular, Variants, and Flow Cytometry data)
53+
54+
3755
## Create and edit template
3856

3957
If you have the permission to edit/manage templates you can click on the template name and select **Duplicate** to create your own editable copy of a template and modify it if needed.
@@ -67,3 +85,15 @@ From the **Metadata Editor**, click the study name, then **Apply another** and s
6785
the template of interest from the list of suggested files. Click **Explore** to open it with the Template Editor.
6886

6987
![image](doc-odm-user-guide/images/change-template-me.png)
88+
89+
## Template validity checks
90+
91+
When you apply or modify templates, a **validity check** is automatically triggered to ensure consistency between the template and associated studies.
92+
93+
- **When changing a template assigned to a study:**
94+
The validity check is run **only for that specific study**.
95+
96+
- **When editing a field in a template:**
97+
The validity check is triggered for **all studies that use this template**.
98+
99+

0 commit comments

Comments
 (0)