Descriptors
A descriptor is a template that defines available fields to fill in for scripts. Descriptors allow standardizing what additional information can be associated with each script and controlling what data is displayed in the generated cases.
What it is used for
- Standardizing additional information fields in scripts
- Facilitating documentation and tracking of scripts
- Controlling what information is publicly displayed in generated cases
Configuration
| Field | Description |
|---|---|
| Descriptor name | Field identifier (e.g., "Author", "Version", "Owner", "Area") |
| Public | Indicates whether descriptions based on this descriptor will appear in generated cases |
How it works
When creating/editing scripts
When creating or editing a script, descriptions based on available descriptors can be added. Each description includes:
- Name: Copied from the descriptor
- Value: Filled in specifically for that script
- Public: Inherited from the descriptor (can be modified per script)
Automatic initialization
If a script has no descriptions, the system automatically proposes all available descriptors to facilitate completion.
Display in cases
Only descriptions marked as public appear in the view of cases generated by that script, allowing relevant information to be shown without exposing internal data.
Relationship with other modules
- Scripts: Scripts have multiple descriptions based on descriptors
- Cases: Cases display the public descriptions of the script that generated them