ATTRIBUTE

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Types >

ATTRIBUTE

Description:

An Attribute is a property that helps describes a participant in a match. For example the type of rifle a participant is using (e.g. Sporter vs Precision air rifle) or an age group the participant is a member of (e.g. Junior, Open, Senior).

Attributes are highly configurable.  Each Attribute will have one or more fields. Each field may be configured to be any value the user types in, a value from a pre-configured list, or a combination.

There are two types of Attributes. Attributes that rely on user input and Derived Attributes, that get their value from one or more other attributes. An example of a Derived Attribute is an age group that gets its value from an athlete’s date of birth.

An Attribute Value represents the data that is stored.

A ‘Simple Attribute’ is a special type of Attribute. It is when MultipleValues is false, there is only one AttributeField defined, and it has MultipleValues set to false.

Definition

Attribute Name

Type

Description

DisplayName

string

High Level, human readable name of the field.

Fields

List of AttributeField

A list of AttributeFields that describe the make-up.

Fields is required and must have at least one object.

Designation

List of string

The type of match participants that this Attribute may be applied to. All values must be from the following list:

ATHLETE

CLUB

MATCH OFFICIAL

TEAM

TEAM OFFICIAL

USER

HIDDEN

Field is not required. however if it is not included all designations, except HIDDEN, are assumed.

MultipleValues

boolean

Indicates if multiple field values may be assigned.

Not required, Default if false.

MaxVisibility

string

The maximum visibility the user can set for the attribute value. Must be one of the following values:

PUBLIC

PROTECTED

PRIVATE

Not required. Default is PRIVATE

HierarchicalName

String formatted as a HierarchialName

The unique name space and proper name of this definition.

Required. The namespace must be assigned to the users account when uploaded to Orion's cloud [include link].

Owner

String formatted as an Owner

The Orion Account Owner of this COURSE OF FIRE definition.

Required. Must be users Orion Account value.

RequiredAttributes

List of strings formatted as a SetName.

A list of ATTRIBUTES that each competitor needs to have in order for the mapping to EVENT STYLE or STAGE STYLE to work. Used when a COURSE OF FIRE is defined for multiple equipment classes.

Required if the attributes StageStyleSelection or EventStyleSelection are used within Events. Not required otherwise, and defaults to an empty list otherwise.

SetName

String formatted as a SetName

Unique identifier given to this definition within the COURSE OF FIRE types.

Attribute is controlled by Orion, users should not add this attribute to their definition files.

Type

String formatted as a Type

Identifies that this is a COURSE OF FIRE type definition.

Required. Must be the value, "COURSE OF FIRE".

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.

 

 


 

Note:

The Reconfigurable Rulebook and functionality will be implemented with the release of Orion Scoring System v. 3.0 (TBA)