CaSS Docs

# Configuring Framework Properties

Framework properties are the values that can be added, edited, and deleted for framework objects. Minimal framework properties are id, name, and description. Properties added here will be displayed in the framework object at the top of the framework editor view.

Framework Configuration

# Property Fields

Certain property fields can be modified directly from the property list:

  • display label - label to be displayed in form inputs for that property
  • description - description of this property
  • display category - category (if any) under which the property is displayed in form inputs
  • required - property required toggle
  • display priority - priority in which the property is displayed in form inputs
    • primary, secondary, or tertiary

At the framework level the following static rules apply:

  • The id property is required
  • The name property is required and has a display priority of primary

# Custom Framework Properties

Custom properties can be added to a framework by clicking the add custom framework property button.

Add Custom Framework Property

Once clicked, the New Framework Property dialogue window is displayed.

New Framework Property

# Custom Framework Property Fields

Several fields must be completed in order to add the new property. Some field options (such as range/type: Text) allow further customization of the property.

# Context

WARNING

This is only editable at the time of property creation.

Custom properties in CaSS are stored as namespaced linked JSON-LD records. Because of this, all new properties must have a context. By default, all custom properties have the CaSS v4.0 [schema] (opens new window) context. However, it is also possible to modify this field to the following values:

It is highly recommended to accept the default for this field unless there is an actionable reason for not doing so.

# Range/Type

WARNING

Only editable at the time of property creation.

The range/type field defines the property type. Certain range/types allow for further customization of the property. The following values are available for this field:

# Display Priority

The priority in which the property is displayed in form inputs (primary, secondary, or tertiary).

# Required

The property is required toggle.

# Unique Property Identifier

WARNING

Only editable at the time of property creation.

The name of the property in the data record. Only alphanumerics are allowed.

# Display Label

The label to be displayed in form inputs for the property.

# Description

The description of the property.

# Display Category

The category (if any) under which the property is displayed in form inputs.

# One Entry Per Language

WARNING

This is only available for range/type=Lang-String

One entry per language

By toggling this field on, custom properties of the range/type Lang-String can be limited so that only a single entry can be made per language chosen.

# Limit Values

WARNING

This is only available for range/type=Text

When creating a custom property of range/type Text, you can limit the values allowed to the property. To do this, toggle the Limit Values field on and click the add button to begin managing the list of allowable values.

Limit Values

For each entry in the limit values table, a display label and field value must be entered.

  • display label - the label displayed to the user when selecting the value
  • field value - the recorded value when the value is selected by the user

Limit Value Entries

# Applying the Custom Framework Property

Once complete, the new property can be applied to the framework by clicking the apply new property in the lower right corner of the dialogue window.

# Editing/Deleting Custom Framework Properties

Custom properties can be edited and deleted by selecting the appropriate action buttons to the right of the corresponding property entry in the Framework Properties list.

Delete Custom Properties

← Managing Default Users →