Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
Table of Contents

Extended Attributes

The standard Registry Data Model is unlikely to cover all attributes required for a given CO. There are two ways of extending the data model to add additional attributes.

Simple

The Registry supports simple extended attributes that can be attached to CO Person Role records on a per-CO basis. These extended attributes can be managed entirely via the COnsole Registry UI (select "Extended Attributes" from the CO menu) or the REST COnnectorAPI, however the following limitations currently apply:

  • Extended attributes only permit one value per CO Person Role. For example, if you wanted to add an attribute for a favorite ice cream flavor, each person can have only one favorite ice cream flavor. (As a workaround, you could define two similar fields: favorite1 and favorite2.)
  • The only data types currently supported are:
    • INTEGER
    • TIMESTAMP
    • VARCHAR(32)
  • Once defined, an attribute's type cannot be changed.
  • Complex relationships, such as foreign keys, are not supported.

Implementation Notes

The information in this section is primarily of use for database administrators who need to know what is going on under the hood.

...

Deleting an extended attribute causes the associated column to be dropped from the table. If all extended attributes are deleted from a CO, then the dynamic table is dropped as well.

Complicated

More sophisticated requirements can be met by implementing native models, views, and controllers in the CakePHP framework. Specifics are beyond the scope of this document, however note that while the Registry knows about and can manipulate simple extended attributes, it will not know about complicated extended attributes except to the extent that you modify the appropriate code.

Currently, there are no standards for implementing complicated extended attributes. As such, future versions of the Registry may not be compatible with your implementation.

Extended Types

Extended types allow custom types to be defined for a given attribute. Not all attributes support extended types. Defining custom types for supported attributes is done by selecting "Extended Types" from the CO menu.