Deprecated Annotations

This document contains deprecated anntoation properties. In some cases the deprecated annotation is not completely removed but we discourage the usage of these properties as they will eventually be removed completely.

Annotations

Annotation Catalog Schema Table Column Key FKR Summary
2016 Ignore - X X X - - Ignore model element
2016 Export X X X - - - Describes export templates
2015 Vocabulary - - X - - - Table as a vocabulary list

Tag: 2015 Vocabulary

tag:misd.isi.edu,2015:vocabulary

This key has been completely removed and has no effect on ERMrestJS/Chaise.

It was allowed on any number of tables in the model, where the table contains at least one key comprised of a single textual column. A vocabulary table is one where each row represents a term or concept in a controlled vocabulary.

Supported JSON payload patterns:

  • null or {}: Default heuristics apply.

  • {… "uri": uri …}: The uri indicates the global identifier of the controlled vocabulary. The uri MAY be a resolvable URL.

  • {… "term": column …}: The named column stores the preferred textual representation of the term. The referenced column MUST comprise a single-column key for the table.

  • {… "id": column …}: The named column stores the preferred compact identifier for the term, which MAY be textual or numeric. The referenced column MUST comprise a single-column key for the table.

  • {… "internal": [column, …] …}: The one or more named columns store internal identifiers for the term, used for efficient normalized storage in the database but not meaningful to typical users. The referenced columns MUST each comprise a single-column key for the table.

  • {… "description": column …}: The named column stores a longer textual representation of the term or concept. The referenced column SHOULD comprise a single-column key for the table.

Tag: 2016 Ignore

tag:isrd.isi.edu,2016:ignore

This key has been completely removed and has no effect on ERMrestJS/Chaise.

This key was previously specified for these model elements but such use is deprecated:

This annotation indicates that the annotated model element should be ignored in typical model-driven user interfaces, with the presentation behaving as if the model element were not present. The JSON payload contextualizes the user interface mode or modes which should ignore the model element.

Supported JSON payload patterns:

  • null or true: Ignore in any presentation context. null is equivalent to tag:misd.isi.edu,2015:hidden for backward-compatibility.

  • [] or false: Do not ignore in any presentation context.

  • [ context , … ]: Ignore only in specific listed contexts, otherwise including the model element as per default heuristics. See Context Names section for the list of supported context names.

This annotation provides an override guidance for Chaise applications using a hierarchical scoping mode:

  1. Hard-coded default behavior in Chaise codebase.

  2. Server-level configuration in chaise-config.js on web server overrides hard-coded default.

  3. Schema-level annotation overrides server-level or codebase behaviors.

  4. Table-level annotation overrides schema-level, server-level, or codebase behaviors.

  5. Annotations on the column or foreign key reference levels override table-level, schema-level, server-level, or codebase behaviors.

Tag: 2016 Export

tag:isrd.isi.edu,2016:export

This tag is the old version of 2019 Export tag. The new tag supports contextualization and is preferred. Templates defined under this tag will be interpreted as "*" context of tag:isrd.isi.edu,2019:export. If both tag:isrd.isi.edu,2016:export and tag:isrd.isi.edu,2019:export for "*" context are defined, the tag:isrd.isi.edu,2016:export will be ignored.

This key can be used to define export templates that will be used for ioboxd service integration with the client tools. For more information about the annotation payload please visit the iobodx integration document.

Supported JSON payload pattern:

  • { "templates": [template] }: An array of template objects to export.

Please refer to 2019 Export for more information about the supported template patterns.