AttributeField

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Objects >

AttributeField

Description

A member of the ATTRIBUTE definition, an AttributeField describes one field of the Attribure

Definition

Attribute Name

Type

Description

FieldName

String

Unique, within the parent ATTRIBUTE, name given to this field.

Required.

DisplayName

String

Human readable name for the field. This is the value that is displayed to users in a form entering ATTRIBUTE VALUES. In a Simple Attribute, it is customarily the same value as the ATTRIBUTE's DisplayName.

Not required. If missing or is blank, value from FieldName is used instead.

FieldType

String

Indicates if the value of the attribute must be chosen from a list, may be any value, of the there is a suggested list of values.

Must be one of the following values:

OPEN

CLOSED

SUGGEST

DERIVED

Field is only required when ValueType is STRING. Prohibited when ValueType is BOOLEAN, All other ValueTypes are considered OPEN.

ValueType

String formatted as a Value Type.

The type of data that this field will hold.

Required.

DefaultValue

Dynamic, of type ValueType.

The default value for this field. It is the value assigned to the field if the user does not enter one.

May not be used when MultipleValues is True. As the default value is always an empty list.

Field is required when FieldType is CLOSED, not required otherwise.

When FieldType is CLOSED or SUGGEST it must be one of the listed Values.

If DefaultValue is not specified, the following types will have the following default values.

STRING => null

INTEGER => 0

FLOAT => 0

DATE => Today’s date

DATE TIME => Current date and time

BOOLEAN => true

The DefaultValue may not be an empty string (""), instead use null.

MultipleValues

Boolean

True if the user may enter multiple values in this field. False if the user may only enter one value.

Prohibited to be true when ValueType is BOOLEAN. Not required otherwise. Default if false.

Required

Boolean

True if the user is required to enter a value. False if the user desn't have to. If the user doesn't have to, then the DefaultValue is applied.

Not required. False, when not specified.

Key

Boolean

In an ATTRIBUTE that has MultipleValues set to true, Key determines the unique identifier in the list. Exactly one AttributeField within an ATTRIBUTE must have Key set to true.

Not required, default value is false.

Validation

AttributeValidation

Validation rule that all must be true in order for the value to pass validation.

May not be used with FieldType is DERIVED or ValueType is BOOLEAN. Not required otherwise. If a rule is not listed all values are considered to be valid.

Values

List of AttributeValueOption

List of possible values.

Required when FieldType is CLOSED or  SUGGEST. Prohibited when ValueType is BOOLEAN.

Description

String

A human readable description as to what this data in this AttributeField does.

Not required, default value in an empty string.

 


 

Note:

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