A project’s requirements schema defines attributes used to provide information about the project's requirements. When creating a new requirement or modifying an existing requirement, the user may assign values to these attributes.
For example, here are a few possible attributes that might appear in a requirements schema:
So, when defining a new requirement, the user may provide a full description of the requirement, and also fill in values for iteration number and the developer who will implement the requirement.
The schema consists of fixed default and customizable attributes.
Fixed default attributes are added by the system and have names that do not contain a dot (period). In the list above, ‘description’ is a fixed default attribute.
Custom attributes have a dot in their name. In the above example, 'iteration.number' and 'iteration.dev' are both custom attributes. A custom attribute may start with a dot, for example, '.Priority' is an acceptable custom attribute name.
Only custom attributes may be edited in the schema editor. Fixed default attributes appear in the schema editor but may not be changed. An attempt to edit and save a fixed default attribute results in an error message.
Each attribute consists of five required properties:
Additionally, the following properties may be applied to an attribute:
To edit the Default Requirements Schema, modify the JSON presented in Administration & Settings > Default Requirements Schema, then hit the Save button.
If you get an error associated with JSON format, you may validate your changes here: http://jsonformatter.curiousconcept.com
Here are a few examples of attributes as they appear in the schema editor:
{
"metadata": [
{ "name": "Prioritization.Difficulty",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"cardinality": "one",
"values": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10"
],
"required": false
},
{
"name": "Prioritization.Type",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"cardinality": "one",
"values": [
"Annotation",
"Business Objective",
"Issue",
"Requirement",
"Open Item",
"UI Specification",
"User Story"
],
"required": false
},
{
"name": "Planning.Cost",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"cardinality": "one",
"values": [
"1",
"2",
"3",
"5",
"8",
"13",
"21",
"34",
"55",
"89"
],
"required": false
},
{
"name": "Planning.Feature",
"type": "longtext",
"readOnly": false,
"requiredUpdate": false,
"required": false
},
{
"name": "Planning.Story Points",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"cardinality": "one",
"values": [
"1",
"2",
"3",
"5",
"8",
"13",
"21",
"34",
"55",
"89"
],
"required": false
},
{
"name": "Prioritization.Status",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"cardinality": "one",
"values": [
"Submitted",
"Defined",
"Analysis",
"Design",
"Requirements",
"Development",
"Testing",
"Completed"
],
"required": false
},
{
"name": "Prioritization.Priority",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"cardinality": "one",
"values": [
"Low",
"High",
"Medium",
"Critical"
],
"required": false
},
{
"name": "Planning.Epic",
"type": "longtext",
"readOnly": false,
"requiredUpdate": false,
"required": false
},
{
"name": "Planning.Due Date",
"type": "date",
"readOnly": false,
"requiredUpdate": false,
"required": false
},
{
"name": "Prioritization.Risk",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"cardinality": "one",
"values": [
"High",
"Medium",
"Low"
],
"required": false
},
{
"name": "Planning.Release",
"type": "longtext",
"readOnly": false,
"requiredUpdate": false,
"required": false
},
{
"name": "Planning.Iteration",
"type": "longtext",
"readOnly": false,
"requiredUpdate": false,
"required": false
},
{
"name": "text",
"type": "longtext",
"readOnly": false,
"requiredUpdate": false,
"required": true
},
{
"name": "description",
"type": "longtext",
"readOnly": false,
"requiredUpdate": false,
"required": false
},
{
"name": "simulationUrl",
"type": "link",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "createdBy",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"required": false
},
{
"name": "createdTime",
"type": "date",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "lastModifiedTime",
"type": "date",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "lastModifiedBy",
"type": "text",
"readOnly": false,
"requiredUpdate": false,
"required": false
},
{
"name": "docId",
"type": "text",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "index",
"type": "text",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "completed",
"type": "boolean",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "chapterId",
"type": "text",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "chapterSimulationUrl",
"type": "link",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "id",
"type": "text",
"readOnly": true,
"requiredUpdate": false,
"required": false
},
{
"name": "widgetReference",
"type": "text",
"readOnly": true,
"requiredUpdate": false,
"cardinality": "many",
"required": false
}
]
}Related articles
Configuring Requirements
Default Requirements Schema
Some technical knowledge is required to customize the schema, so please consult Support if you have any questions.