Skip to content

Commit

Permalink
SYN-6658: docs on ext props updated to note the need to delete values…
Browse files Browse the repository at this point in the history
… before removing them (#3510)

docs: Update admin guide with additional info about updating extended
model elements.
  • Loading branch information
MichaelSquires authored Jan 26, 2024
1 parent d269eda commit 43fb572
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/synapse/adminguide.rstorm
Original file line number Diff line number Diff line change
Expand Up @@ -1385,6 +1385,13 @@ The Synapse data model in a Cortex can be extended with custom `forms`_ or `prop
extension Storm Library (:ref:`stormlibs-lib-model-ext`). Extended model forms and properties must have names
beginning with an underscore (``_``) to avoid potential naming conflicts with built-in model elements.

.. NOTE::

Extended model elements that are in-use (have nodes using the extended forms or properties) cannot be removed until
all instances of that extended model element are removed. In other words, before removing extended forms any nodes
created with that extended form must be delete first, and before removing extended properties any nodes with that
extended property must have the property value removed.

Extended Forms
--------------

Expand Down

0 comments on commit 43fb572

Please sign in to comment.