Customizing Model Template File and Validator File

We describe the composition of Model template file and validator file. Steps to customizing model template file and validator file are also explained in detail.

The detailed description for model template files of Scene, Article, Action-Response, and Timeline are made available as part of this documentation. Each model template file has following JSON structure with a property associated with model template and it's corresponding value.

{
"property":"value"
}

These properties are listed in the available model template files after thorough review with Virtual Reality practitioner community. These properties are bare-minimum properties that are required for eliciting requirements for a typical Virtual Reality software product.

The underlying validator file of the above model template file looks as shown below. We can describe as many as property definitions as follows. More examples of model template validates

{

 "property":{
       "req":"mandatory", //Is it mandatory or optional
       "typeof":"string", //describes the datatype of the value
       "repeat":"notallow", //allow: to re-use this property multiples times in the file
       "%comment%":"Mention your VR Scene name here" //description about this attribute
    }

}

Customizing Model Template file and Validator file

The model template and validator files for Scene, Article, Action-Response and Timeline are open for customization but with one condition i.e. the existing property tags and their respective validator checks should not be altered.

To include a new property into the model template, please add it on top of the existing properties listed in the model template files made available as part of this document. To add a new property, follow below instructions for customizing model template file:

• The new property name should not be matching with the existing property name

• The property name should be included after all the existing properties in the existing model template file

• Ensure that the property name should have a value tag

For every new property and a value added in the model template file. the relevant validator value should be made available with an updated version of validator file. Follow below instructions for including the validation rules in the validator file for new properties from the model template file.

• Define the property with sub-tags as

  • req: it is to know if this tag is mandatory i.e. it cannot be skilled or optional i.e. can be skipped

  • typeof: this is the datatype of the value associated with the property

  • repeat: Can this tag be repeatable? if you wish to repeat a property, we should be marking it as "allow", or "not allow" if it is not supposed to be repeated in the model template file.

  • comments: this for documentation purpose for others to understand the intent of the property tag.

• There are other tags in the few validator files like root, proot i.e. to describe the property being the nested property especially for array type, nested properties in the validator files.