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 .

Owner

String formatted as an Owner

The Orion Account Owner of this ATTRIBUTE definition.

Required. Must be users Orion Account value.

RequiredAttributes

List of strings formatted as a SetName

This is a list of Set Names of Attribute definitions. This list represents the Attributes that must be present in a match in order for the current definition to be used. Typically used in conjunction with ConditionalTest.

SetName

String formatted as a SetName

A SetName uniquely identifies a definition within a type. It has three parts, version, namespace, and proper name. The namespace identifies the organization that owns the definition. The proper name is a human readable title for the definition. Version is a major version and minor version pair. Version is prepended with a ‘v’. The three parts are concatenated together with colons. For example, “v1.2:orion:generic target”.

 

Special case is when version is “0.0” this always denotes the most recent version of the definition. For example, “v0.0:orion:generic target”. “X.0” (where x is a major version) always denotes the most recent version within a major version.

Type

String formatted as a Type

The type of reconfigurable rulebook definition. Must be one of the following strings:

ATTRIBUTE

COURSE OF FIRE

DERIVED ATTRIBUTE

EVENT STYLE

FUNCTION

RANGE

RANKING RULES

RESULT

RULEBOOK

STAGE STYLE

TARGET

Version

String formatted as a Version

Version has two parts, major version and minor version. Both represented by integers. Stored as the concatenation together with an period(‘.’). For example 1.12 (major version = 1, minor version = 12).

Both major version and minor version must start at 1 and increment up.

Required.

 

 


 

Note:

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