<< Click to Display Table of Contents >> Navigation: Support > Reconfigurable Rulebook > Definition Types > Common Properties |
All top level Definitions share the following common properties.
Property Name |
Type |
Description |
Type |
String formatted as a Type |
Identifies the type of Definition. Must be one of the following: •ATTRIBUTE •COURSE OF FIRE •EVENT AND STAGE STYLE MAPPING •EVENT STYLE •RANKING RULES •RESULT LIST FORMAT •SCORE FORMAT COLLECTION •STAGE STYLE •TARGET •TARGET COLLECTION Required. |
Version |
String formatted as a Version |
The version number for this definition. User must update this value with each new version uploaded to Orion's cloud. Required. |
HierarchicalName |
String formatted as a Hierarchical Name |
The unique name space and proper name of this definition. Required. The namespace must be assigned to the users account when uploading to Orion's cloud. |
SetName |
String formatted as a Set Name |
Unique identifier given to this definition within all EVENT AND STAGE STYLE MAPPING objects. This value is controlled by Orion, users should not add this attribute to their definition files. See Set Names for more information. |
CommonName |
String |
A human readable, and commonly referred to name for this EVENT AND STAGE STYLE MAPPING. Not required, but strongly recommended. If not included, the ProperName portion of the HierarchicalName field is used. |
Description |
String |
A human readable description of this EVENT AND STAGE STYLE MAPPING object. Not required, but strongly recommended. |
Owner |
String formatted as an Owner |
The Orion Account Owner of this EVENT AND STAGE STYLE MAPPING definition. Required. Must be users Orion Account value. |
Discipline |
String formatted as a Discipline |
The shooting discipline that uses this EVENT AND STAGE STYLE MAPPING. Required. |
Subdiscipline |
String formatted as a Subdiscipline and Tags |
The subdiscipline to categorize this EVENT AND STAGE STYLE MAPPING. Not required, but strongly recommended. |
Tags |
List of Strings formatted as a Subdiscipline and Tags |
The tag or tags to categorize with. Not required but strongly recommended. |
Comment |
String |
Internal documentation comment. All text is ignored by the system. Not required. |
JSONVersion |
String formatted as a JSON Version |
The JSON Version value for this definition.
Not required. Assumed to be 2020-03-31 if not included. |
Discontinued |
Boolean |
True if this Definition is no longer in use.
Not Required. Defaults to false, meaning it is still in use.. |
|
||
|
||