From 43fb57267a6259adac2ec802beed5515af10cfff Mon Sep 17 00:00:00 2001 From: blackout Date: Fri, 26 Jan 2024 09:13:16 -0500 Subject: [PATCH] SYN-6658: docs on ext props updated to note the need to delete values before removing them (#3510) docs: Update admin guide with additional info about updating extended model elements. --- docs/synapse/adminguide.rstorm | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/synapse/adminguide.rstorm b/docs/synapse/adminguide.rstorm index 220205d397..6e6be552dd 100644 --- a/docs/synapse/adminguide.rstorm +++ b/docs/synapse/adminguide.rstorm @@ -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 --------------