From 22ab941151e65bbf30754f0cd85f5dca34ed2eab Mon Sep 17 00:00:00 2001 From: Dan Wolfson Date: Thu, 12 Nov 2026 18:05:46 +0000 Subject: [PATCH 01/19] Keep stored additionalProperties keys on a merge update Egeria replaces a map property whole, even with mergeUpdate true. A Create that found its element (and became an Update), or an Update with Merge Update true, sent only the keys its document gave, so every other key was removed: on laz a SavedQuery's refresh keys were wiped, and a CDO Report's search keys nearly were. - AsyncBaseCommandProcessor._prepare_additional_properties runs once before apply_changes() on an update of an existing element. When the update sends additionalProperties (the document gives Additional Properties, or the processor writes keys of its own: WRITES_ADDITIONAL_PROPERTIES, set on ReportProcessor), it reads the stored map and lays the document's keys over it; the merged map becomes the value every body builder reads. - A replace update (Merge Update false) still replaces, with a warning that names the stored keys it removes. - A merge update whose stored map can't be read (element read without its properties and a re-read by GUID fails) is refused in words (AdditionalPropertiesUnreadable), never sent as a replacement. - upsert_dashboard_asset merges with the existing Dashboard's map too, and its unchanged check compares only the keys given. A Dr.Egeria document has no way to clear one key (a JSON null is parsed to the string "null"); Merge Update false is the way to remove keys. Tests use the laz SavedQuery refresh keys and a 10-key CDO Report. 3.13 micro suite: 3,465 passed. Probe gate (88cf76b7, PostgreSQL scratch, 757a5df0): PASS, identical to the baseline. Signed-off-by: Dan Wolfson --- md_processing/v2/additional_properties.py | 63 +++++ md_processing/v2/processors.py | 72 +++++ md_processing/v2/report.py | 20 ++ ...test_merge_update_additional_properties.py | 253 ++++++++++++++++++ 4 files changed, 408 insertions(+) create mode 100644 md_processing/v2/additional_properties.py create mode 100644 tests/micro-tests/test_merge_update_additional_properties.py diff --git a/md_processing/v2/additional_properties.py b/md_processing/v2/additional_properties.py new file mode 100644 index 00000000..13ea1eb1 --- /dev/null +++ b/md_processing/v2/additional_properties.py @@ -0,0 +1,63 @@ +"""additionalProperties on a merge update: keep the keys the document doesn't write. + +Egeria replaces a map property as one value, even on a merge update (`mergeUpdate: true` merges +properties, not the keys inside one map property). A Dr.Egeria Create that finds its element (and +becomes an Update), or an Update with Merge Update true, used to send only the keys its document +gave, so every other key on the element was removed: on laz a SavedQuery's refresh keys +(lastRefreshedTime, resultCount, resultsSetGuid, smartQueryRelGuid, lastRefreshParams) were wiped +this way, and a CDO Report's search keys nearly were. + +The fix: on a merge update, read the element's stored map and overlay the document's keys on it, +key by key, so the map sent is the whole map. A replace update (Merge Update false) still replaces, +and says which keys go. + +There is no way in a Dr.Egeria document to clear a single key: a Dictionary value is parsed to +strings (a JSON `null` becomes the string "null"), and an empty value is no value. To remove keys, +use Merge Update false, which replaces the element's properties with exactly what the document gives. +""" + +from __future__ import annotations + +from typing import Any, Dict, Iterable, Optional + + +class AdditionalPropertiesUnreadable(ValueError): + """A merge update would send additionalProperties, but the stored map couldn't be read.""" + + +def stored_additional_properties(element: Optional[Dict[str, Any]]) -> Optional[Dict[str, Any]]: + """The element's stored additionalProperties ({} when it has none), or None when the element + wasn't read with its properties (so its map is unknown).""" + if not isinstance(element, dict): + return None + properties = element.get("properties") + if not isinstance(properties, dict): + return None + stored = properties.get("additionalProperties") + if stored is None: + return {} + return dict(stored) if isinstance(stored, dict) else None + + +def merge_additional_properties(stored: Dict[str, Any], document: Optional[Dict[str, Any]]) -> Dict[str, Any]: + """The stored map with the document's keys laid over it: the document wins key by key, and keys + it doesn't give are kept.""" + merged = dict(stored or {}) + merged.update(document or {}) + return merged + + +def replace_note(stored: Optional[Dict[str, Any]], sent_keys: Iterable[str]) -> Optional[str]: + """The sentence a replace update (Merge Update false) adds, naming the stored keys it removes.""" + removed = sorted(set(stored or {}) - set(sent_keys)) + if not removed: + return None + return ("Merge Update is false, so this update replaces additionalProperties as a whole: " + f"these stored keys are removed: {', '.join(removed)}") + + +def unreadable_message(what: str) -> str: + return (f"Refusing to update {what}: the update would send additionalProperties, but the element's " + "stored additionalProperties couldn't be read, and Egeria replaces that map as a whole, so the " + "keys this document doesn't give would be removed. Re-run once the element can be read, or set " + "Merge Update to false to replace the map on purpose.") diff --git a/md_processing/v2/processors.py b/md_processing/v2/processors.py index 2d79175b..424e30b9 100644 --- a/md_processing/v2/processors.py +++ b/md_processing/v2/processors.py @@ -17,6 +17,10 @@ from md_processing.v2.extraction import DrECommand from md_processing.v2.parsing import AttributeFirstParser +from md_processing.v2.additional_properties import ( + AdditionalPropertiesUnreadable, merge_additional_properties, replace_note, stored_additional_properties, + unreadable_message, +) from md_processing.md_processing_utils.typed_properties import (_as_dict, classification_map, new_element_properties, not_applied_notes, parent_relationship_properties, @@ -1356,6 +1360,7 @@ async def _execute(self) -> Dict[str, Any]: f" | GUID={self.parsed_output.get('guid', 'new')} ══\033[0m" ) try: + await self._prepare_additional_properties() output = await self.apply_changes() finally: self._report_unapplied() @@ -2192,6 +2197,73 @@ async def sync_members(self, # Control flags rather than element properties: keep their defaults on an update. _KEEP_DEFAULTS_ON_UPDATE = {"Merge Update"} + #: True for a processor that writes additionalProperties keys of its own beside the document's + #: "Additional Properties" (ReportProcessor's report parameters), so an update always sends the map. + WRITES_ADDITIONAL_PROPERTIES = False + + def _is_merge_update(self) -> bool: + value = ((self.parsed_output.get("attributes") or {}).get("Merge Update") or {}).get("value", True) + return not (value is False or (isinstance(value, str) and value.strip().lower() == "false")) + + async def _prepare_additional_properties(self) -> None: + """Keep the stored additionalProperties keys the document doesn't write (md_processing/v2/additional_properties.py). + + Runs once, just before apply_changes(), for an update of an existing element (a Create that found + its element, or an Update). When the update sends additionalProperties -- the document gives + "Additional Properties", or the processor writes keys of its own -- the element's stored map is + read and the document's keys are laid over it, and the merged map becomes the "Additional + Properties" value every body builder reads. A replace update (Merge Update false) replaces, and + a warning names the stored keys it removes. A merge update whose stored map can't be read is + refused (AdditionalPropertiesUnreadable), never sent as a replacement. + """ + if not self.supports_target_element_lookup(): + return + is_update = bool(self.as_is_element) or ( + self.command.verb in ("Update", "Modify", "Upsert") + and bool(self.parsed_output.get("exists") or self.parsed_output.get("guid"))) + if not is_update: + return + attributes = self.parsed_output.get("attributes") + if attributes is None: + return + entry = attributes.get("Additional Properties") + document = entry.get("value") if isinstance(entry, dict) else None + if document in (None, "", {}): + document = None + elif not isinstance(document, dict): + return # not a parsed Dictionary: leave it to the processor + if document is None and not self.WRITES_ADDITIONAL_PROPERTIES: + return # nothing sent: Egeria keeps the stored map + + stored = stored_additional_properties(self.as_is_element) + if stored is None and self.as_is_element: + guid = (self.as_is_element.get("elementHeader") or {}).get("guid") + if guid: + try: + stored = stored_additional_properties(await self.fetch_element(guid)) + except Exception as e: # reported below as unreadable + logger.debug(f"_prepare_additional_properties: re-read of {guid} failed: {e}") + + if not self._is_merge_update(): + note = replace_note(stored, (document or {}).keys()) + if note: + self._add_warning(note) + return + if stored is None: + what = self.parsed_output.get("qualified_name") or self.parsed_output.get("guid") or "this element" + raise AdditionalPropertiesUnreadable(unreadable_message(f"'{what}'")) + + merged = merge_additional_properties(stored, document) + kept = sorted(set(stored) - set(document or {})) + if isinstance(entry, dict): + entry["document_value"] = document + entry["value"] = merged + else: + attributes["Additional Properties"] = {"value": merged, "style": "Dictionary", + "document_value": None, "kept_from_element": True} + if kept: + logger.info(f"Merge update keeps stored additionalProperties keys: {', '.join(kept)}") + def _drop_create_defaults(self) -> None: """Remove spec defaults the parser filled in for a Create that has become an Update. diff --git a/md_processing/v2/report.py b/md_processing/v2/report.py index f47fba4e..7160e6a4 100644 --- a/md_processing/v2/report.py +++ b/md_processing/v2/report.py @@ -38,6 +38,9 @@ from pyegeria.core._exceptions import PyegeriaNotFoundException +from md_processing.v2.additional_properties import ( + AdditionalPropertiesUnreadable, merge_additional_properties, stored_additional_properties, unreadable_message, +) from md_processing.v2.processors import AsyncBaseCommandProcessor from md_processing.md_processing_utils.common_md_utils import ( set_create_body, set_element_prop_body, update_element_dictionary, @@ -267,6 +270,12 @@ def _props_differ(desired: Dict[str, Any], current: Dict[str, Any]) -> bool: for key, value in desired.items(): if key in ("class", "typeName") or value is None: continue + if key == "additionalProperties" and isinstance(value, dict): + # merged key by key on update, so only the keys given count (additional_properties.py) + stored = current.get(key) or {} + if any(stored.get(k) != v for k, v in value.items()): + return True + continue if current.get(key) != value: return True return False @@ -288,6 +297,13 @@ async def upsert_dashboard_asset(client: Any, qualified_name: str, props: Dict[s if not _props_differ(props, existing.get("properties") or {}): return guid, "Unchanged", None update_props = filter_update(props, merge_update) if filter_update else props + stored = stored_additional_properties(existing) + if merge_update and update_props.get("additionalProperties") is not None: + # Egeria replaces the map whole: send the stored keys too (md_processing/v2/additional_properties.py). + if stored is None: + raise AdditionalPropertiesUnreadable(unreadable_message(f"Dashboard '{qualified_name}'")) + update_props = {**update_props, "additionalProperties": merge_additional_properties( + stored, update_props["additionalProperties"])} update_body = {"class": "UpdateElementRequestBody", "properties": update_props, "mergeUpdate": merge_update} await client._async_update_asset(guid, update_body) @@ -335,6 +351,10 @@ class ReportProcessor(AsyncBaseCommandProcessor): a spec with no element gets a note saying no link was written, not silence. """ + # The report parameters are additionalProperties keys, so every update sends the map: the base + # processor merges the stored keys in first (_prepare_additional_properties). + WRITES_ADDITIONAL_PROPERTIES = True + async def apply_changes(self) -> str: attributes = self.parsed_output["attributes"] qualified_name = self.parsed_output.get("qualified_name") or self.derive_qualified_name(attributes) diff --git a/tests/micro-tests/test_merge_update_additional_properties.py b/tests/micro-tests/test_merge_update_additional_properties.py new file mode 100644 index 00000000..41da154b --- /dev/null +++ b/tests/micro-tests/test_merge_update_additional_properties.py @@ -0,0 +1,253 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the ODPi Egeria project. +"""A merge update keeps the stored additionalProperties keys the document doesn't write. + +Egeria replaces a map property whole, even with mergeUpdate true. A Create that found its element (and became +an Update) used to send only the document's keys, so on laz a SavedQuery's refresh keys were wiped, and a CDO +Report's search keys nearly were. The base processor now overlays the document's keys on the stored map +(md_processing/v2/additional_properties.py); a replace update replaces and says so; a merge update whose stored +map can't be read is refused. The fake clients stand in for Egeria; nothing reaches a server. +""" +from typing import Any, cast + +import pytest + +from md_processing.v2.additional_properties import ( + AdditionalPropertiesUnreadable, merge_additional_properties, stored_additional_properties, +) +from md_processing.v2.extraction import DrECommand +from md_processing.v2.report import ReportProcessor, upsert_dashboard_asset +from md_processing.v2.saved_query import SavedQueryProcessor + +pytestmark = pytest.mark.unit + +GUID = "aaaaaaaa-0000-0000-0000-00000000000a" + +# The keys the Portal's insights refresh writes on a laz SavedQuery (wiped at 11:08Z by a Create->Update). +SAVED_QUERY_REFRESH_KEYS = { + "lastRefreshedTime": "2026-11-12T10:55:02Z", + "resultCount": "17", + "resultsSetGuid": "bbbbbbbb-0000-0000-0000-00000000000b", + "smartQueryRelGuid": "cccccccc-0000-0000-0000-00000000000c", + "lastRefreshParams": '{"page_size": 100, "type_name": "Asset"}', +} + +# A CDO Report: the three keys its document writes, and seven search keys only the stored element has. +CDO_DOCUMENT_KEYS = {"Report Spec": "Risk-DrE-Basic", "Output Format": "TABLE", "Search String": "CocoPharma::Risk::"} +CDO_STORED = { + "reportSpec": "Risk-DrE-Basic", + "outputFormat": "TABLE", + "searchString": "CocoPharma::Risk::", + "startsWith": "true", + "endsWith": "false", + "ignoreCase": "true", + "metadataElementTypeName": "GovernanceRisk", + "limitResultByStatus": "ACTIVE", + "graphQueryDepth": "1", + "pageSize": "200", +} + + +class _Recorder: + def __init__(self): + self.calls = [] + + def __getattr__(self, name): + async def _record(*args, **kwargs): + self.calls.append((name, args, kwargs)) + return "dddddddd-0000-0000-0000-00000000000d" + return _record + + +class _Client(_Recorder): + def __init__(self, fetched=None): + super().__init__() + self.classification_manager = _Recorder() + self.data_designer = _Recorder() + self._fetched = fetched + + async def _async_get_element_by_guid_(self, guid): + return self._fetched + + def updates(self): + return [args for name, args, _ in self.calls if name == "_async_update_asset"] + + +def _element(additional): + props = {"qualifiedName": "X::test", "displayName": "test"} + if additional is not None: + props["additionalProperties"] = additional + return {"elementHeader": {"guid": GUID}, "properties": props} + + +def _processor(cls, object_type, attributes, as_is, fetched=None, verb="Update"): + client = _Client(fetched) + p = cls(client=cast(Any, client), command=DrECommand(verb=verb, object_type=object_type, attributes={}, + raw_block=f"## {verb} {object_type}"), context={}) + p.parsed_output = {"qualified_name": f"{object_type}::test", "attributes": attributes, "exists": True, + "guid": GUID} + p.as_is_element = as_is + + async def _render(guid): + return guid + p.render_result_markdown = _render + return p, client + + +async def _run(p): + """What execute() does around apply_changes().""" + await p._prepare_additional_properties() + return await p.apply_changes() + + +def _a(merge=True, **values): + attrs = {k: {"value": v} for k, v in values.items()} + attrs["Display Name"] = {"value": "test"} + attrs["Merge Update"] = {"value": merge, "is_default": True} + return attrs + + +# ------------------------------------------------------------------ the merge itself + +def test_merge_keeps_stored_keys_and_the_document_wins(): + merged = merge_additional_properties({"a": "1", "b": "2"}, {"b": "new", "c": "3"}) + assert merged == {"a": "1", "b": "new", "c": "3"} + + +def test_stored_map_is_unknown_without_properties(): + assert stored_additional_properties({"elementHeader": {"guid": GUID}}) is None + assert stored_additional_properties(_element(None)) == {} + assert stored_additional_properties(_element({"k": "v"})) == {"k": "v"} + + +# ------------------------------------------------------------------ SavedQuery (laz refresh keys) + +@pytest.mark.asyncio +async def test_saved_query_create_to_update_keeps_the_refresh_keys(): + attributes = _a(**{"Additional Properties": {"owner": "erinoverview"}}) + p, client = _processor(SavedQueryProcessor, "Saved Query", attributes, _element(dict(SAVED_QUERY_REFRESH_KEYS)), + verb="Create") + await _run(p) + (guid, body), = client.updates() + assert guid == GUID and body["mergeUpdate"] is True + assert body["properties"]["additionalProperties"] == {**SAVED_QUERY_REFRESH_KEYS, "owner": "erinoverview"} + + +@pytest.mark.asyncio +async def test_saved_query_document_key_overrides_a_stored_key(): + attributes = _a(**{"Additional Properties": {"resultCount": "0"}}) + p, client = _processor(SavedQueryProcessor, "Saved Query", attributes, _element(dict(SAVED_QUERY_REFRESH_KEYS))) + await _run(p) + sent = client.updates()[0][1]["properties"]["additionalProperties"] + assert sent == {**SAVED_QUERY_REFRESH_KEYS, "resultCount": "0"} + + +@pytest.mark.asyncio +async def test_saved_query_without_additional_properties_sends_no_map(): + p, client = _processor(SavedQueryProcessor, "Saved Query", _a(), _element(dict(SAVED_QUERY_REFRESH_KEYS))) + await _run(p) + assert client.updates()[0][1]["properties"].get("additionalProperties") is None # Egeria keeps the stored map + + +# ------------------------------------------------------------------ Report (CDO search keys) + +@pytest.mark.asyncio +async def test_report_create_to_update_keeps_the_cdo_search_keys(): + p, client = _processor(ReportProcessor, "Report", _a(**CDO_DOCUMENT_KEYS), _element(dict(CDO_STORED)), + verb="Create") + await _run(p) + (guid, body), = client.updates() + sent = body["properties"]["additionalProperties"] + assert sent == CDO_STORED # all 10 keys, not just the 3 the document writes + + +@pytest.mark.asyncio +async def test_report_document_values_win_over_stored(): + p, client = _processor(ReportProcessor, "Report", _a(**{**CDO_DOCUMENT_KEYS, "Output Format": "LIST"}), + _element(dict(CDO_STORED))) + await _run(p) + sent = client.updates()[0][1]["properties"]["additionalProperties"] + assert sent == {**CDO_STORED, "outputFormat": "LIST"} + + +# ------------------------------------------------------------------ replace update + +@pytest.mark.asyncio +async def test_replace_update_replaces_and_says_so(): + attributes = _a(merge=False, **{"Additional Properties": {"owner": "erinoverview"}}) + p, client = _processor(SavedQueryProcessor, "Saved Query", attributes, _element(dict(SAVED_QUERY_REFRESH_KEYS))) + await _run(p) + body = client.updates()[0][1] + assert body["mergeUpdate"] is False + assert body["properties"]["additionalProperties"] == {"owner": "erinoverview"} + (warning,) = [w for w in p.parsed_output["warnings"] if "Merge Update is false" in w] + for key in SAVED_QUERY_REFRESH_KEYS: + assert key in warning + + +@pytest.mark.asyncio +async def test_report_replace_update_sends_only_the_document_keys(): + p, client = _processor(ReportProcessor, "Report", _a(merge=False, **CDO_DOCUMENT_KEYS), _element(dict(CDO_STORED))) + await _run(p) + sent = client.updates()[0][1]["properties"]["additionalProperties"] + assert sent == {"reportSpec": "Risk-DrE-Basic", "outputFormat": "TABLE", "searchString": "CocoPharma::Risk::"} + + +# ------------------------------------------------------------------ unreadable as-is element + +@pytest.mark.asyncio +async def test_unreadable_element_is_refused_not_replaced(): + attributes = _a(**{"Additional Properties": {"owner": "erinoverview"}}) + headless = {"elementHeader": {"guid": GUID}} # read without its properties, and the re-read finds nothing + p, client = _processor(SavedQueryProcessor, "Saved Query", attributes, headless, fetched=None) + with pytest.raises(AdditionalPropertiesUnreadable, match="Refusing to update"): + await _run(p) + assert client.updates() == [] + + +@pytest.mark.asyncio +async def test_report_with_unreadable_element_is_refused(): + p, client = _processor(ReportProcessor, "Report", _a(**CDO_DOCUMENT_KEYS), {"elementHeader": {"guid": GUID}}) + with pytest.raises(AdditionalPropertiesUnreadable): + await _run(p) + assert client.updates() == [] + + +@pytest.mark.asyncio +async def test_headless_element_is_re_read_by_guid(): + attributes = _a(**{"Additional Properties": {"owner": "erinoverview"}}) + p, client = _processor(SavedQueryProcessor, "Saved Query", attributes, {"elementHeader": {"guid": GUID}}, + fetched=_element(dict(SAVED_QUERY_REFRESH_KEYS))) + await _run(p) + sent = client.updates()[0][1]["properties"]["additionalProperties"] + assert sent == {**SAVED_QUERY_REFRESH_KEYS, "owner": "erinoverview"} + + +@pytest.mark.asyncio +async def test_update_with_no_as_is_element_is_refused(): + attributes = _a(**{"Additional Properties": {"owner": "erinoverview"}}) + p, _ = _processor(SavedQueryProcessor, "Saved Query", attributes, None) + with pytest.raises(AdditionalPropertiesUnreadable): + await p._prepare_additional_properties() + + +# ------------------------------------------------------------------ Dashboard asset upsert + +@pytest.mark.asyncio +async def test_dashboard_upsert_merges_with_the_existing_map(): + client = _Client() + existing = _element({"family": "CDO", "layoutHint": "grid"}) + props = {"class": "DashboardProperties", "qualifiedName": "Dashboard::CDO", "additionalProperties": {"family": "CDO2"}} + guid, verb, body = await upsert_dashboard_asset(client, "Dashboard::CDO", props, existing) + assert verb == "Updated" + assert body["properties"]["additionalProperties"] == {"family": "CDO2", "layoutHint": "grid"} + + +@pytest.mark.asyncio +async def test_dashboard_upsert_unchanged_when_given_keys_match(): + client = _Client() + existing = _element({"family": "CDO", "layoutHint": "grid"}) + props = {"class": "DashboardProperties", "qualifiedName": "X::test", "displayName": "test", + "additionalProperties": {"family": "CDO"}} + _, verb, body = await upsert_dashboard_asset(client, "X::test", props, existing) + assert verb == "Unchanged" and body is None From d1a36b746e7ec3a5935c08a9d442e725c63187e1 Mon Sep 17 00:00:00 2001 From: Dan Wolfson Date: Thu, 12 Nov 2026 18:11:20 +0000 Subject: [PATCH 02/19] Pin the CDO Report merge test to the real laz stored map The Report fixture is now the stored additionalProperties of CocoPharma::Report::CDODashboard::MyNinetyDayPlanProgress as read on laz on 2026-11-12 (version 1, LIST): 10 string-valued keys, startFrom included, no metadataElementTypeName. A Create Report block writing only reportSpec, outputFormat TABLE and searchString sends all 10 keys with only outputFormat changed. Signed-off-by: Dan Wolfson --- ...test_merge_update_additional_properties.py | 34 +++++++++++-------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/tests/micro-tests/test_merge_update_additional_properties.py b/tests/micro-tests/test_merge_update_additional_properties.py index 41da154b..d8c445d0 100644 --- a/tests/micro-tests/test_merge_update_additional_properties.py +++ b/tests/micro-tests/test_merge_update_additional_properties.py @@ -32,20 +32,22 @@ "lastRefreshParams": '{"page_size": 100, "type_name": "Asset"}', } -# A CDO Report: the three keys its document writes, and seven search keys only the stored element has. -CDO_DOCUMENT_KEYS = {"Report Spec": "Risk-DrE-Basic", "Output Format": "TABLE", "Search String": "CocoPharma::Risk::"} +# A CDO Report: the stored map of CocoPharma::Report::CDODashboard::MyNinetyDayPlanProgress as read on laz +# on 2026-11-12 (version 1, LIST). Every value is a string, "['ACTIVE']" included. CDO_STORED = { - "reportSpec": "Risk-DrE-Basic", - "outputFormat": "TABLE", - "searchString": "CocoPharma::Risk::", - "startsWith": "true", - "endsWith": "false", - "ignoreCase": "true", - "metadataElementTypeName": "GovernanceRisk", - "limitResultByStatus": "ACTIVE", + "reportSpec": "Project-DrE-Basic", + "searchString": "JulesKeeper::", "graphQueryDepth": "1", - "pageSize": "200", + "startFrom": "0", + "ignoreCase": "False", + "endsWith": "False", + "pageSize": "0", + "limitResultByStatus": "['ACTIVE']", + "outputFormat": "LIST", + "startsWith": "True", } +# The Create Report block: it writes only these three keys. +CDO_DOCUMENT_KEYS = {"Report Spec": "Project-DrE-Basic", "Output Format": "TABLE", "Search String": "JulesKeeper::"} class _Recorder: @@ -158,16 +160,18 @@ async def test_report_create_to_update_keeps_the_cdo_search_keys(): await _run(p) (guid, body), = client.updates() sent = body["properties"]["additionalProperties"] - assert sent == CDO_STORED # all 10 keys, not just the 3 the document writes + # all 10 stored keys, with only outputFormat changed (what had to be done by hand on laz, 2026-11-12) + assert sent == {**CDO_STORED, "outputFormat": "TABLE"} + assert len(sent) == 10 and sent["limitResultByStatus"] == "['ACTIVE']" @pytest.mark.asyncio async def test_report_document_values_win_over_stored(): - p, client = _processor(ReportProcessor, "Report", _a(**{**CDO_DOCUMENT_KEYS, "Output Format": "LIST"}), + p, client = _processor(ReportProcessor, "Report", _a(**{**CDO_DOCUMENT_KEYS, "Search String": "JulesKeeper::Plans::"}), _element(dict(CDO_STORED))) await _run(p) sent = client.updates()[0][1]["properties"]["additionalProperties"] - assert sent == {**CDO_STORED, "outputFormat": "LIST"} + assert sent == {**CDO_STORED, "outputFormat": "TABLE", "searchString": "JulesKeeper::Plans::"} # ------------------------------------------------------------------ replace update @@ -190,7 +194,7 @@ async def test_report_replace_update_sends_only_the_document_keys(): p, client = _processor(ReportProcessor, "Report", _a(merge=False, **CDO_DOCUMENT_KEYS), _element(dict(CDO_STORED))) await _run(p) sent = client.updates()[0][1]["properties"]["additionalProperties"] - assert sent == {"reportSpec": "Risk-DrE-Basic", "outputFormat": "TABLE", "searchString": "CocoPharma::Risk::"} + assert sent == {"reportSpec": "Project-DrE-Basic", "outputFormat": "TABLE", "searchString": "JulesKeeper::"} # ------------------------------------------------------------------ unreadable as-is element From 447f3e61a50fbe62c08bdd69607dce9cf1ff51c6 Mon Sep 17 00:00:00 2001 From: Dan Wolfson Date: Thu, 12 Nov 2026 18:46:04 +0000 Subject: [PATCH 03/19] Test that a first Create sends the document's additionalProperties without reading A Create Saved Query / Create Report with Additional Properties and no as-is element sends the document's map as given (plus the Report's own parameter keys), never reads a stored element, and is neither merged nor refused (Architect read-back suggestion, 2026-11-12). Signed-off-by: Dan Wolfson --- ...test_merge_update_additional_properties.py | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/tests/micro-tests/test_merge_update_additional_properties.py b/tests/micro-tests/test_merge_update_additional_properties.py index d8c445d0..88c6ca43 100644 --- a/tests/micro-tests/test_merge_update_additional_properties.py +++ b/tests/micro-tests/test_merge_update_additional_properties.py @@ -67,8 +67,10 @@ def __init__(self, fetched=None): self.classification_manager = _Recorder() self.data_designer = _Recorder() self._fetched = fetched + self.reads = [] async def _async_get_element_by_guid_(self, guid): + self.reads.append(guid) return self._fetched def updates(self): @@ -235,6 +237,27 @@ async def test_update_with_no_as_is_element_is_refused(): await p._prepare_additional_properties() +# ------------------------------------------------------------------ first Create: nothing to merge + +@pytest.mark.asyncio +@pytest.mark.parametrize("cls, object_type, attributes, expected", [ + (SavedQueryProcessor, "Saved Query", {"Additional Properties": {"owner": "erinoverview"}}, + {"owner": "erinoverview"}), + (ReportProcessor, "Report", {**CDO_DOCUMENT_KEYS, "Additional Properties": {"owner": "erinoverview"}}, + {"owner": "erinoverview", "reportSpec": "Project-DrE-Basic", "outputFormat": "TABLE", + "searchString": "JulesKeeper::"}), +]) +async def test_first_create_sends_the_document_map_and_never_reads(cls, object_type, attributes, expected): + p, client = _processor(cls, object_type, _a(**attributes), None, verb="Create") + p.parsed_output.update({"exists": False, "guid": None}) + await _run(p) + assert client.reads == [] # no stored element to read: not refused, not merged + assert client.updates() == [] + (types, body), = [args for name, args, _ in client.calls if name == "_async_create_asset"] + assert body["properties"]["additionalProperties"] == expected + assert p.parsed_output["attributes"]["Additional Properties"].get("document_value") is None # untouched + + # ------------------------------------------------------------------ Dashboard asset upsert @pytest.mark.asyncio From c1558639e34d9eaf4ab5fce1fe07fdce314b570b Mon Sep 17 00:00:00 2001 From: Dan Wolfson Date: Thu, 12 Nov 2026 14:49:42 +0000 Subject: [PATCH 04/19] Add Advanced-only MetadataExpert Dr.Egeria command family 16 commands wrapping pyegeria/omvs/metadata_expert.py: Create/Update/Delete Type Def, Create/Delete Enum Def, Count Metadata Elements, Publish Metadata Element, and Create/Update/Delete Instance, Link/Unlink Instances, Update Relationship, Classify/Reclassify/Declassify Instance. Adds processors, dispatcher registration, "Count" in STANDARD_VERBS, compact spec, generated report specs, Advanced templates and unit tests. Claude-Session: https://claude.ai/code/session_015pdMuS33mgrngrEv8FTfH1 Signed-off-by: Dan Wolfson --- .../commands_metadataexpert_compact.json | 1118 ++++++++++ md_processing/data/generated_format_sets.json | 1818 +++++++++++++++++ md_processing/dr_egeria.py | 19 + md_processing/v2/extraction.py | 2 + md_processing/v2/metadata_expert.py | 361 ++++ pyegeria/view/base_report_formats.py | 6 + pyegeria/view/dr_egeria_reports.py | 6 + pyegeria/view/seed/MetadataExpert.json | 236 +++ pyegeria/view/seed/manifest.json | 7 +- .../MetadataExpert/Classify_Instance.md | 34 + .../MetadataExpert/Count_Metadata_Elements.md | 30 + .../MetadataExpert/Create_Enum_Def.md | 280 +++ .../MetadataExpert/Create_Instance.md | 280 +++ .../MetadataExpert/Create_Type_Def.md | 340 +++ .../MetadataExpert/Declassify_Instance.md | 22 + .../MetadataExpert/Delete_Enum_Def.md | 22 + .../MetadataExpert/Delete_Instance.md | 26 + .../MetadataExpert/Delete_Type_Def.md | 22 + .../advanced/MetadataExpert/Link_Instances.md | 66 + .../Publish_Metadata_Element.md | 14 + .../MetadataExpert/Reclassify_Instance.md | 42 + .../MetadataExpert/Unlink_Instances.md | 50 + .../MetadataExpert/Update_Instance.md | 272 +++ .../MetadataExpert/Update_Relationship.md | 272 +++ .../MetadataExpert/Update_Type_Def.md | 288 +++ .../test_metadata_expert_processors.py | 88 + 26 files changed, 5718 insertions(+), 3 deletions(-) create mode 100644 md_processing/data/compact_commands/commands_metadataexpert_compact.json create mode 100644 md_processing/v2/metadata_expert.py create mode 100644 pyegeria/view/seed/MetadataExpert.json create mode 100644 sample-data/templates/advanced/MetadataExpert/Classify_Instance.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Count_Metadata_Elements.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Create_Enum_Def.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Create_Instance.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Create_Type_Def.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Declassify_Instance.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Delete_Enum_Def.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Delete_Instance.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Delete_Type_Def.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Link_Instances.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Publish_Metadata_Element.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Reclassify_Instance.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Unlink_Instances.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Update_Instance.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Update_Relationship.md create mode 100644 sample-data/templates/advanced/MetadataExpert/Update_Type_Def.md create mode 100644 tests/micro-tests/test_metadata_expert_processors.py diff --git a/md_processing/data/compact_commands/commands_metadataexpert_compact.json b/md_processing/data/compact_commands/commands_metadataexpert_compact.json new file mode 100644 index 00000000..ad54b79e --- /dev/null +++ b/md_processing/data/compact_commands/commands_metadataexpert_compact.json @@ -0,0 +1,1118 @@ +{ + "family": "MetadataExpert", + "exported": "", + "attribute_definitions": { + "Type Def Name": { + "variable_name": "type_def_name", + "inUpdate": true, + "attr_labels": "", + "examples": "Recipe", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Name of the open metadata type definition (entity, relationship or classification).", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Type Def GUID": { + "variable_name": "type_def_guid", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "GUID of the type definition. If omitted, it is looked up from the Type Def Name.", + "generated": false, + "style": "GUID", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Type Def Category": { + "variable_name": "type_def_category", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "Entity", + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ], + "existing_element": "", + "description": "Kind of type definition to create.", + "generated": false, + "style": "Valid Value", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Super Type": { + "variable_name": "super_type", + "inUpdate": true, + "attr_labels": "", + "examples": "Referenceable", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Name of the supertype (entity and classification definitions).", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Type Def Description": { + "variable_name": "type_def_description", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Description of the type definition.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Type Def Attributes": { + "variable_name": "type_def_attributes", + "inUpdate": true, + "attr_labels": "", + "examples": "servings: int", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "One attribute per line as 'attributeName: typeName'. typeName is a primitive type (string, int, long, boolean, date, float, double, short, byte, char, bigint, bigdecimal) or the name of an existing enum definition.", + "generated": false, + "style": "Dictionary", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Valid Entity Types": { + "variable_name": "valid_entity_types", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Classification definitions only: the entity types the classification can be attached to (one per line or comma separated).", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Propagatable": { + "variable_name": "propagatable", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Classification definitions only: whether the classification propagates.", + "generated": false, + "style": "Bool", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "End1 Entity Type": { + "variable_name": "end1_entity_type", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Relationship definitions only: entity type at end 1.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "End1 Attribute Name": { + "variable_name": "end1_attribute_name", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Relationship definitions only: name the relationship has at end 1.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "End2 Entity Type": { + "variable_name": "end2_entity_type", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Relationship definitions only: entity type at end 2.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "End2 Attribute Name": { + "variable_name": "end2_attribute_name", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Relationship definitions only: name the relationship has at end 2.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Apply To Version": { + "variable_name": "apply_to_version", + "inUpdate": true, + "attr_labels": "", + "examples": "1", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "The version of the type definition this update applies to.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Enum Def Name": { + "variable_name": "enum_def_name", + "inUpdate": true, + "attr_labels": "", + "examples": "CuisineType", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Name of the enum definition.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Enum Def GUID": { + "variable_name": "enum_def_guid", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "GUID of the enum definition. If omitted, it is looked up from the Enum Def Name.", + "generated": false, + "style": "GUID", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Enum Def Description": { + "variable_name": "enum_def_description", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Description of the enum definition.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Enum Values": { + "variable_name": "enum_values", + "inUpdate": true, + "attr_labels": "", + "examples": "Unclassified: The cuisine has not been recorded.", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "One enum value per line as 'value: description'. Ordinals are assigned 0, 1, 2... in line order.", + "generated": false, + "style": "Dictionary", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Enum Default Value": { + "variable_name": "enum_default_value", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Which of the Enum Values is the default (defaults to the first).", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Count Element Type Name": { + "variable_name": "count_element_type_name", + "inUpdate": true, + "attr_labels": "", + "examples": "GlossaryTerm", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Only count elements of this metadata element type (and subtypes).", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Count Search String": { + "variable_name": "count_search_string", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Only count elements matching this search string.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Count Push Down": { + "variable_name": "count_push_down", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "True: the repository counts rows itself (fast, skips per-element visibility checks). False: the server retrieves and counts matching elements. Omit for the server default.", + "generated": false, + "style": "Bool", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Metadata Element GUID": { + "variable_name": "metadata_element_guid", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "GUID of the metadata element.", + "generated": false, + "style": "GUID", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family." + }, + "Instance Type Name": { + "variable_name": "instance_type_name", + "inUpdate": true, + "attr_labels": "", + "examples": "GlossaryTerm", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Open metadata type name of the instance (element) to create.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Instance Properties": { + "variable_name": "instance_properties", + "inUpdate": true, + "attr_labels": "", + "examples": "qualifiedName: Term::example", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "One property per line as 'name: value'. true/false become boolean, whole numbers become int, anything else is a string.", + "generated": false, + "style": "Dictionary", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Replace Properties": { + "variable_name": "replace_properties", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "True: the supplied properties replace all existing ones. False (default): they are merged.", + "generated": false, + "style": "Bool", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Anchor GUID": { + "variable_name": "anchor_guid", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "GUID of the element that anchors the new instance.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Is Own Anchor": { + "variable_name": "is_own_anchor", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "true", + "valid_values": [], + "existing_element": "", + "description": "A flag indicating if the element is its own anchor or is anchored to a different element.", + "generated": false, + "style": "Bool", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "" + }, + "Parent GUID": { + "variable_name": "parent_guid", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "GUID of a parent element to link the new instance to.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Parent Relationship Type Name": { + "variable_name": "parent_relationship_type_name", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "The type of parent relationship.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "" + }, + "Delete Method": { + "variable_name": "delete_method", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "SOFT_DELETE", + "valid_values": [ + "SOFT_DELETE", + "PURGE", + "ARCHIVE", + "LOOK_FOR_LINEAGE" + ], + "existing_element": "", + "description": "How to delete.", + "generated": false, + "style": "Valid Value", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Relationship Type Name": { + "variable_name": "relationship_type_name", + "inUpdate": true, + "attr_labels": "", + "examples": "SemanticAssignment", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Open metadata type name of the relationship to create.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Element 1 GUID": { + "variable_name": "element_1_guid", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "GUID of the element at end 1 of the relationship.", + "generated": false, + "style": "GUID", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Element 2 GUID": { + "variable_name": "element_2_guid", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "GUID of the element at end 2 of the relationship.", + "generated": false, + "style": "GUID", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Relationship Properties": { + "variable_name": "relationship_properties", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "One property per line as 'name: value' (same typing rules as Instance Properties).", + "generated": false, + "style": "Dictionary", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Relationship GUID": { + "variable_name": "relationship_guid", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "GUID of the relationship.", + "generated": false, + "style": "GUID", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Classification Name": { + "variable_name": "classification_name", + "inUpdate": true, + "attr_labels": "", + "examples": "Confidentiality", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "Open metadata type name of the classification.", + "generated": false, + "style": "Simple", + "user_specified": true, + "unique": false, + "input_required": true, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Classification Properties": { + "variable_name": "classification_properties", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "", + "valid_values": [], + "existing_element": "", + "description": "One property per line as 'name: value' (same typing rules as Instance Properties).", + "generated": false, + "style": "Dictionary", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 0, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Parent at End1": { + "variable_name": "parent_at_end1", + "inUpdate": true, + "attr_labels": "", + "examples": "", + "default_value": "true", + "valid_values": [], + "existing_element": "", + "description": "A flag indicating if the parent is at end1 of the relationship", + "generated": false, + "style": "Bool", + "user_specified": true, + "unique": false, + "input_required": false, + "min_cardinality": 1, + "max_cardinality": 1, + "level": "Advanced", + "Journal Entry": "" + } + }, + "bundles": {}, + "commands": { + "Create Type Def": { + "display_name": "type_def", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Add a new open metadata type definition (entity, relationship or classification) to the type system. Not an upsert: types cannot be removed once instances exist.", + "verb": "Create", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Type Def Name", + "Type Def Category", + "Super Type", + "Type Def Description", + "Type Def Attributes", + "Valid Entity Types", + "Propagatable", + "End1 Entity Type", + "End1 Attribute Name", + "End2 Entity Type", + "End2 Attribute Name" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family. " + }, + "Update Type Def": { + "display_name": "type_def", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Patch a type definition that was added through the API. WARNING: Egeria currently rejects every patch (OMRS-REPOSITORY-400-069, ISSUE-124).", + "verb": "Update", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Type Def Name", + "Type Def GUID", + "Apply To Version", + "Type Def Description", + "Type Def Attributes" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family. " + }, + "Delete Type Def": { + "display_name": "type_def", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Delete a type definition that was added through the API. Fails while instances of the type exist or another type refers to it.", + "verb": "Delete", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Type Def Name", + "Type Def GUID" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family. " + }, + "Create Enum Def": { + "display_name": "enum_def", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Add a new enum definition, usable as an attribute type in type definitions. WARNING: an enum added through the API cannot be removed again (ISSUE-125).", + "verb": "Create", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Enum Def Name", + "Enum Def Description", + "Enum Values", + "Enum Default Value" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family. " + }, + "Delete Enum Def": { + "display_name": "enum_def", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Delete an enum definition. WARNING: currently fails on Egeria with a 500 'unknown TypeDef' (ISSUE-125).", + "verb": "Delete", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Enum Def Name", + "Enum Def GUID" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family. " + }, + "Count Metadata Elements": { + "display_name": "metadata_elements", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Return the number of metadata elements matching the criteria, without retrieving them.", + "verb": "Count", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Count Element Type Name", + "Count Search String", + "Count Push Down" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family. " + }, + "Publish Metadata Element": { + "display_name": "metadata_element", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Increase the visibility of a metadata element by updating its zone membership.", + "verb": "Publish", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Metadata Element GUID" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family. " + }, + "Update Instance": { + "display_name": "instance", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Update the properties of a metadata element (instance).", + "verb": "Update", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Metadata Element GUID", + "Instance Properties", + "Replace Properties" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Delete Instance": { + "display_name": "instance", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Delete a metadata element (instance).", + "verb": "Delete", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Metadata Element GUID", + "Delete Method" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Link Instances": { + "display_name": "instances", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Create a relationship between two metadata elements. Not deduplicated: running it twice may create two relationships.", + "verb": "Link", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Relationship Type Name", + "Element 1 GUID", + "Element 2 GUID", + "Relationship Properties" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Unlink Instances": { + "display_name": "instances", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Delete a relationship between two metadata elements.", + "verb": "Unlink", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Relationship GUID", + "Delete Method" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Update Relationship": { + "display_name": "relationship", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Update the properties of a relationship.", + "verb": "Update", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Relationship GUID", + "Relationship Properties", + "Replace Properties" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Classify Instance": { + "display_name": "instance", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Add a classification to a metadata element.", + "verb": "Classify", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Metadata Element GUID", + "Classification Name", + "Classification Properties" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Reclassify Instance": { + "display_name": "instance", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Change the properties of a classification already on a metadata element.", + "verb": "Reclassify", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Metadata Element GUID", + "Classification Name", + "Classification Properties", + "Replace Properties" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Declassify Instance": { + "display_name": "instance", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Remove a classification from a metadata element.", + "verb": "Declassify", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Metadata Element GUID", + "Classification Name" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + }, + "Create Instance": { + "display_name": "instance", + "qn_prefix": "", + "alternate_names": [], + "family": "MetadataExpert", + "description": "Create a metadata element (instance) of any open metadata type through the raw metadata-expert API. Not an upsert: every run creates a new element.", + "verb": "Create", + "upsert": false, + "attach": false, + "level": "Advanced", + "find_method": "", + "find_constraints": "", + "extra_find": "", + "extra_constraints": "", + "OM_TYPE": "", + "bundle": "", + "custom_attributes": [ + "Instance Type Name", + "Instance Properties", + "Anchor GUID", + "Is Own Anchor", + "Parent GUID", + "Parent Relationship Type Name", + "Parent at End1" + ], + "Journal Entry": "Added 2026-11-12 -- MetadataExpert family (instance commands)." + } + } +} diff --git a/md_processing/data/generated_format_sets.json b/md_processing/data/generated_format_sets.json index e69af05c..42cbe105 100644 --- a/md_processing/data/generated_format_sets.json +++ b/md_processing/data/generated_format_sets.json @@ -200035,6 +200035,1824 @@ "get_additional_props": null, "question_spec": null }, + "Type-Def-DrE-Basic": { + "target_type": "Type Def", + "heading": "Type-Def-DrE-Basic Attributes", + "description": "Auto-generated format for Type Def (Create, Basic).", + "aliases": [], + "annotations": {}, + "family": "MetadataExpert", + "formats": [ + { + "types": [ + "LIST" + ], + "attributes": [ + { + "name": "Type Def Name", + "key": "type_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Category", + "key": "type_def_category", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ] + }, + { + "name": "Super Type", + "key": "super_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Description", + "key": "type_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Attributes", + "key": "type_def_attributes", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Valid Entity Types", + "key": "valid_entity_types", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Propagatable", + "key": "propagatable", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End1 Entity Type", + "key": "end1_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End1 Attribute Name", + "key": "end1_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End2 Entity Type", + "key": "end2_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End2 Attribute Name", + "key": "end2_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Type Def Name", + "key": "type_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Category", + "key": "type_def_category", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Super Type", + "key": "super_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Description", + "key": "type_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Attributes", + "key": "type_def_attributes", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Valid Entity Types", + "key": "valid_entity_types", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Propagatable", + "key": "propagatable", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End1 Entity Type", + "key": "end1_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End1 Attribute Name", + "key": "end1_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End2 Entity Type", + "key": "end2_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End2 Attribute Name", + "key": "end2_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + }, + { + "types": [ + "ALL" + ], + "attributes": [ + { + "name": "Type Def Name", + "key": "type_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Category", + "key": "type_def_category", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ] + }, + { + "name": "Super Type", + "key": "super_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Description", + "key": "type_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Attributes", + "key": "type_def_attributes", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Valid Entity Types", + "key": "valid_entity_types", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Propagatable", + "key": "propagatable", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End1 Entity Type", + "key": "end1_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End1 Attribute Name", + "key": "end1_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End2 Entity Type", + "key": "end2_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End2 Attribute Name", + "key": "end2_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Type Def Name", + "key": "type_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Category", + "key": "type_def_category", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Super Type", + "key": "super_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Description", + "key": "type_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Attributes", + "key": "type_def_attributes", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Valid Entity Types", + "key": "valid_entity_types", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Propagatable", + "key": "propagatable", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End1 Entity Type", + "key": "end1_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End1 Attribute Name", + "key": "end1_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End2 Entity Type", + "key": "end2_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End2 Attribute Name", + "key": "end2_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + } + ], + "action": null, + "get_additional_props": null, + "question_spec": null + }, + "Type-Def-DrE-Advanced": { + "target_type": "Type Def", + "heading": "Type-Def-DrE-Advanced Attributes", + "description": "Auto-generated format for Type Def (Create, Advanced).", + "aliases": [], + "annotations": {}, + "family": "MetadataExpert", + "formats": [ + { + "types": [ + "LIST" + ], + "attributes": [ + { + "name": "Type Def Name", + "key": "type_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Category", + "key": "type_def_category", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ] + }, + { + "name": "Super Type", + "key": "super_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Description", + "key": "type_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Attributes", + "key": "type_def_attributes", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Valid Entity Types", + "key": "valid_entity_types", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Propagatable", + "key": "propagatable", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End1 Entity Type", + "key": "end1_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End1 Attribute Name", + "key": "end1_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End2 Entity Type", + "key": "end2_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End2 Attribute Name", + "key": "end2_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Type Def Name", + "key": "type_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Category", + "key": "type_def_category", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Super Type", + "key": "super_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Description", + "key": "type_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Attributes", + "key": "type_def_attributes", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Valid Entity Types", + "key": "valid_entity_types", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Propagatable", + "key": "propagatable", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End1 Entity Type", + "key": "end1_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End1 Attribute Name", + "key": "end1_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End2 Entity Type", + "key": "end2_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End2 Attribute Name", + "key": "end2_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + }, + { + "types": [ + "ALL" + ], + "attributes": [ + { + "name": "Type Def Name", + "key": "type_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Category", + "key": "type_def_category", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ] + }, + { + "name": "Super Type", + "key": "super_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Description", + "key": "type_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Type Def Attributes", + "key": "type_def_attributes", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Valid Entity Types", + "key": "valid_entity_types", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Propagatable", + "key": "propagatable", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End1 Entity Type", + "key": "end1_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End1 Attribute Name", + "key": "end1_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End2 Entity Type", + "key": "end2_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "End2 Attribute Name", + "key": "end2_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Type Def Name", + "key": "type_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Category", + "key": "type_def_category", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [ + "Entity", + "Relationship", + "Classification" + ], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Super Type", + "key": "super_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Description", + "key": "type_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Type Def Attributes", + "key": "type_def_attributes", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Valid Entity Types", + "key": "valid_entity_types", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Propagatable", + "key": "propagatable", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End1 Entity Type", + "key": "end1_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End1 Attribute Name", + "key": "end1_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End2 Entity Type", + "key": "end2_entity_type", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "End2 Attribute Name", + "key": "end2_attribute_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + } + ], + "action": null, + "get_additional_props": null, + "question_spec": null + }, + "Enum-Def-DrE-Basic": { + "target_type": "Enum Def", + "heading": "Enum-Def-DrE-Basic Attributes", + "description": "Auto-generated format for Enum Def (Create, Basic).", + "aliases": [], + "annotations": {}, + "family": "MetadataExpert", + "formats": [ + { + "types": [ + "LIST" + ], + "attributes": [ + { + "name": "Enum Def Name", + "key": "enum_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Def Description", + "key": "enum_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Values", + "key": "enum_values", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Default Value", + "key": "enum_default_value", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Enum Def Name", + "key": "enum_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Def Description", + "key": "enum_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Values", + "key": "enum_values", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Default Value", + "key": "enum_default_value", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + }, + { + "types": [ + "ALL" + ], + "attributes": [ + { + "name": "Enum Def Name", + "key": "enum_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Def Description", + "key": "enum_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Values", + "key": "enum_values", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Default Value", + "key": "enum_default_value", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Enum Def Name", + "key": "enum_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Def Description", + "key": "enum_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Values", + "key": "enum_values", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Default Value", + "key": "enum_default_value", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + } + ], + "action": null, + "get_additional_props": null, + "question_spec": null + }, + "Enum-Def-DrE-Advanced": { + "target_type": "Enum Def", + "heading": "Enum-Def-DrE-Advanced Attributes", + "description": "Auto-generated format for Enum Def (Create, Advanced).", + "aliases": [], + "annotations": {}, + "family": "MetadataExpert", + "formats": [ + { + "types": [ + "LIST" + ], + "attributes": [ + { + "name": "Enum Def Name", + "key": "enum_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Def Description", + "key": "enum_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Values", + "key": "enum_values", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Default Value", + "key": "enum_default_value", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Enum Def Name", + "key": "enum_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Def Description", + "key": "enum_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Values", + "key": "enum_values", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Default Value", + "key": "enum_default_value", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + }, + { + "types": [ + "ALL" + ], + "attributes": [ + { + "name": "Enum Def Name", + "key": "enum_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Def Description", + "key": "enum_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Values", + "key": "enum_values", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Enum Default Value", + "key": "enum_default_value", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Enum Def Name", + "key": "enum_def_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Def Description", + "key": "enum_def_description", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Values", + "key": "enum_values", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Enum Default Value", + "key": "enum_default_value", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + } + ], + "action": null, + "get_additional_props": null, + "question_spec": null + }, + "Instance-DrE-Basic": { + "target_type": "Instance", + "heading": "Instance-DrE-Basic Attributes", + "description": "Auto-generated format for Instance (Create, Basic).", + "aliases": [], + "annotations": {}, + "family": "MetadataExpert", + "formats": [ + { + "types": [ + "LIST" + ], + "attributes": [ + { + "name": "Instance Type Name", + "key": "instance_type_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Instance Properties", + "key": "instance_properties", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Anchor GUID", + "key": "anchor_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Is Own Anchor", + "key": "is_own_anchor", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Parent GUID", + "key": "parent_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Instance Type Name", + "key": "instance_type_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Instance Properties", + "key": "instance_properties", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Anchor GUID", + "key": "anchor_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Is Own Anchor", + "key": "is_own_anchor", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Parent GUID", + "key": "parent_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + }, + { + "types": [ + "ALL" + ], + "attributes": [ + { + "name": "Instance Type Name", + "key": "instance_type_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Instance Properties", + "key": "instance_properties", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Anchor GUID", + "key": "anchor_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Is Own Anchor", + "key": "is_own_anchor", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Parent GUID", + "key": "parent_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Instance Type Name", + "key": "instance_type_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Instance Properties", + "key": "instance_properties", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Anchor GUID", + "key": "anchor_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Is Own Anchor", + "key": "is_own_anchor", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Parent GUID", + "key": "parent_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + } + ], + "action": null, + "get_additional_props": null, + "question_spec": null + }, + "Instance-DrE-Advanced": { + "target_type": "Instance", + "heading": "Instance-DrE-Advanced Attributes", + "description": "Auto-generated format for Instance (Create, Advanced).", + "aliases": [], + "annotations": {}, + "family": "MetadataExpert", + "formats": [ + { + "types": [ + "LIST" + ], + "attributes": [ + { + "name": "Instance Type Name", + "key": "instance_type_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Instance Properties", + "key": "instance_properties", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Anchor GUID", + "key": "anchor_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Is Own Anchor", + "key": "is_own_anchor", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Parent GUID", + "key": "parent_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Instance Type Name", + "key": "instance_type_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Instance Properties", + "key": "instance_properties", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Anchor GUID", + "key": "anchor_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Is Own Anchor", + "key": "is_own_anchor", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Parent GUID", + "key": "parent_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + }, + { + "types": [ + "ALL" + ], + "attributes": [ + { + "name": "Instance Type Name", + "key": "instance_type_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Instance Properties", + "key": "instance_properties", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Anchor GUID", + "key": "anchor_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Is Own Anchor", + "key": "is_own_anchor", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + }, + { + "name": "Parent GUID", + "key": "parent_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [] + } + ], + "columns": [ + { + "name": "Instance Type Name", + "key": "instance_type_name", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Instance Properties", + "key": "instance_properties", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Anchor GUID", + "key": "anchor_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Is Own Anchor", + "key": "is_own_anchor", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + }, + { + "name": "Parent GUID", + "key": "parent_guid", + "value": null, + "format": false, + "detail_spec": null, + "valid_values": [], + "render": null, + "max_items": null, + "max_lines": null, + "label": null + } + ] + } + ], + "action": null, + "get_additional_props": null, + "question_spec": null + }, "Study-Project-DrE-Basic": { "target_type": "Study Project", "heading": "Study-Project-DrE-Basic Attributes", diff --git a/md_processing/dr_egeria.py b/md_processing/dr_egeria.py index 0019bdd0..0c7370f2 100644 --- a/md_processing/dr_egeria.py +++ b/md_processing/dr_egeria.py @@ -56,6 +56,10 @@ SubscriptionTypeProcessor, BitolDocumentProcessor, SchemaElementProcessor, SchemaTemplateProcessor, SchemaLinkProcessor, SchemaClassificationProcessor, ) +from md_processing.v2.metadata_expert import ( + TypeDefProcessor, EnumDefProcessor, CountMetadataElementsProcessor, PublishMetadataElementProcessor, + InstanceProcessor, InstanceRelationshipProcessor, InstanceClassificationProcessor, +) from pyegeria import settings, EgeriaTech, PyegeriaException, print_basic_exception, print_validation_error from pyegeria.core.config import settings, resolve_egeria_credentials @@ -432,6 +436,21 @@ def reg(base, cls): reg("Initiate Subscription", InitiateSubscriptionProcessor) reg("Cancel Subscription", CancelSubscriptionProcessor) + # MetadataExpert (Advanced): type system maintenance + raw element count/publish (metadata_expert.py) + for _verb in ("Create", "Update", "Delete"): + reg(f"{_verb} Type Def", TypeDefProcessor) + for _verb in ("Create", "Delete"): + reg(f"{_verb} Enum Def", EnumDefProcessor) + reg("Count Metadata Elements", CountMetadataElementsProcessor) + reg("Publish Metadata Element", PublishMetadataElementProcessor) + for _verb in ("Create", "Update", "Delete"): + reg(f"{_verb} Instance", InstanceProcessor) + reg("Link Instances", InstanceRelationshipProcessor) + reg("Unlink Instances", InstanceRelationshipProcessor) + reg("Update Relationship", InstanceRelationshipProcessor) + for _verb in ("Classify", "Reclassify", "Declassify"): + reg(f"{_verb} Instance", InstanceClassificationProcessor) + # Digital Products: subscription types and ODCS/ODPS Bitol documents (product_manager.py) reg("Create Subscription Type", SubscriptionTypeProcessor) for _bitol_verb in ("Import", "Publish"): diff --git a/md_processing/v2/extraction.py b/md_processing/v2/extraction.py index d41cf62d..dd92588b 100644 --- a/md_processing/v2/extraction.py +++ b/md_processing/v2/extraction.py @@ -39,6 +39,8 @@ # integration daemon). Without these the `## Import ...` / `## Publish ...` headings never match # cmd_header_rx and silently fall through as prose -- no error, no summary row. "Import", "Publish", + # MetadataExpert family: "Count Metadata Elements". + "Count", } # Commands that appear as a single word (no separate verb) and map to canonical verb+object diff --git a/md_processing/v2/metadata_expert.py b/md_processing/v2/metadata_expert.py new file mode 100644 index 00000000..9a419bea --- /dev/null +++ b/md_processing/v2/metadata_expert.py @@ -0,0 +1,361 @@ +""" +MetadataExpert processors for Dr.Egeria v2 (Advanced commands only). + +Maintenance of Egeria's open metadata *type system* plus two raw metadata-element operations, all backed +by ``pyegeria/omvs/metadata_expert.py``: + +- Create Type Def -> add_type_def (entity, relationship or classification definition) +- Update Type Def -> update_type_def (Egeria rejects every patch today: ISSUE-124) +- Delete Type Def -> delete_type_def +- Create Enum Def -> add_enum_def +- Delete Enum Def -> delete_enum_def (Egeria returns a 500: ISSUE-125; enums cannot be removed) +- Count Metadata Elements -> count_metadata_elements +- Publish Metadata Element -> publish_metadata_element +- Create/Update/Delete Instance -> create/update_metadata_element_properties/delete_metadata_element +- Link/Unlink Instances, Update Relationship -> create/delete/update_related_elements* +- Classify/Reclassify/Declassify Instance -> classify/reclassify/declassify_metadata_element + +Instance, relationship and classification properties are sent as typed property maps +(EntityElementProperties / RelationshipElementProperties / ClassificationElementProperties with a +propertyValueMap of PrimitiveTypePropertyValue), the shape shown in the SDK docstrings. NOT verified +against a live server (Egeria was read-only when these were written). + +Like the Automation family these are actions, not create-or-update of a named element: no as-is lookup +and no Create<->Update rewrite. +""" +import re +from typing import Any, Dict, List, Optional + +from loguru import logger + +from pyegeria import PyegeriaException +from md_processing.v2.processors import AsyncBaseCommandProcessor + +PRIMITIVE_TYPES = {"string", "int", "long", "boolean", "date", "float", "double", "short", "byte", "char", + "bigint", "bigdecimal", "object"} +_CATEGORY_CLASS = {"entity": "OpenMetadataEntityDef", "relationship": "OpenMetadataRelationshipDef", + "classification": "OpenMetadataClassificationDef"} + + +def _v(attributes: Dict[str, Any], name: str, default=None): + value = attributes.get(name, {}).get("value", default) + return default if value in (None, "") else value + + +def _names(value: Any) -> List[str]: + """A list-ish string (newline, comma or bullet separated) or list -> clean names.""" + if value is None: + return [] + items = value if isinstance(value, list) else re.split(r"[\n,]", str(value)) + return [str(i).strip().lstrip("-*• ").strip() for i in items if str(i).strip().lstrip("-*• ").strip()] + + +def _bool(value: Any) -> Optional[bool]: + if isinstance(value, bool) or value is None: + return value + text = str(value).strip().lower() + return True if text in ("true", "yes", "y", "1") else False if text in ("false", "no", "n", "0") else None + + +def _link(name: str) -> Dict[str, str]: + return {"name": name} + + +def _attribute_type(type_name: str) -> Dict[str, str]: + cls = "OpenMetadataPrimitiveDef" if type_name.lower() in PRIMITIVE_TYPES else "OpenMetadataEnumDef" + return {"class": cls, "name": type_name} + + +def attribute_definitions(attributes: Dict[str, Any]) -> List[Dict[str, Any]]: + """'Type Def Attributes' Dictionary (attributeName: typeName) -> attributeDefinitions.""" + return [{"attributeName": str(name), "attributeType": _attribute_type(str(type_name).strip())} + for name, type_name in (_v(attributes, "Type Def Attributes") or {}).items()] + + +def type_def_body(attributes: Dict[str, Any]) -> Dict[str, Any]: + category = str(_v(attributes, "Type Def Category", "Entity")).strip().lower() + if category not in _CATEGORY_CLASS: + raise PyegeriaException(f"Type Def Category must be Entity, Relationship or Classification, not '{category}'.") + body: Dict[str, Any] = {"class": _CATEGORY_CLASS[category], "name": _v(attributes, "Type Def Name")} + if _v(attributes, "Type Def Description"): + body["description"] = _v(attributes, "Type Def Description") + if _v(attributes, "Super Type"): + body["superType"] = _link(_v(attributes, "Super Type")) + if attribute_definitions(attributes): + body["attributeDefinitions"] = attribute_definitions(attributes) + if category == "classification": + valid = _names(_v(attributes, "Valid Entity Types")) + if valid: + body["validEntityDefs"] = [_link(n) for n in valid] + if _bool(_v(attributes, "Propagatable")) is not None: + body["propagatable"] = _bool(_v(attributes, "Propagatable")) + elif category == "relationship": + # Literal attribute names (not f-strings) so the attribute-consumption audit can see them. + for key, entity_attr, name_attr in (("endDef1", "End1 Entity Type", "End1 Attribute Name"), + ("endDef2", "End2 Entity Type", "End2 Attribute Name")): + entity, attr_name = _v(attributes, entity_attr), _v(attributes, name_attr) + if not entity or not attr_name: + raise PyegeriaException(f"A relationship definition needs {entity_attr} and {name_attr}.") + body[key] = {"entityType": _link(entity), "attributeName": attr_name} + return body + + +def enum_def_body(attributes: Dict[str, Any]) -> Dict[str, Any]: + values = _v(attributes, "Enum Values") or {} + if not values: + raise PyegeriaException("Enum Values is required: one 'value: description' per line.") + elements = [{"ordinal": i, "value": str(value), "description": str(description or "")} + for i, (value, description) in enumerate(values.items())] + default = _v(attributes, "Enum Default Value") or elements[0]["value"] + matches = [e for e in elements if e["value"] == default] + if not matches: + raise PyegeriaException(f"Enum Default Value '{default}' is not one of the Enum Values.") + body: Dict[str, Any] = {"class": "OpenMetadataEnumDef", "name": _v(attributes, "Enum Def Name"), + "elementDefs": elements, "defaultValue": matches[0]} + if _v(attributes, "Enum Def Description"): + body["description"] = _v(attributes, "Enum Def Description") + return body + + +class MetadataExpertProcessor(AsyncBaseCommandProcessor): + """Shared behaviour: actions with no as-is element and no upsert rewrite.""" + + def supports_target_element_lookup(self) -> bool: + return False + + async def fetch_as_is(self) -> Optional[Dict[str, Any]]: + return None + + @property + def expert(self): + return self.client.metadata_expert + + def _result(self, what: str, detail: str = "") -> str: + logger.success(f"{self.command.verb} {self.command.object_type}: {what}") + text = f"\n\n## {self.command.verb} {self.command.object_type}\n\n{what}" + return f"{text}: `{detail}`\n" if detail else f"{text}\n" + + async def _type_def(self, name: str) -> Dict[str, Any]: + found = await self.client.valid_metadata._async_get_typedef_by_name(name) + if not isinstance(found, dict) or not found.get("guid"): + raise PyegeriaException(f"Type definition '{name}' was not found.") + return found + + async def _enum_guid(self, name: str) -> str: + found = await self.client.valid_metadata._async_get_attribute_types(category="ENUM") + for item in found if isinstance(found, list) else []: + if isinstance(item, dict) and item.get("name") == name and item.get("guid"): + return item["guid"] + raise PyegeriaException(f"Enum definition '{name}' was not found.") + + +class TypeDefProcessor(MetadataExpertProcessor): + async def apply_changes(self) -> str: + attributes = self.parsed_output["attributes"] + name = _v(attributes, "Type Def Name") + if not name: + raise PyegeriaException("Type Def Name is required.") + verb = self.command.verb + if verb == "Create": + guid = await self.expert._async_add_type_def(type_def_body(attributes)) + self.parsed_output["guid"] = guid if isinstance(guid, str) else None + return self._result(f"Added type definition '{name}'", guid if isinstance(guid, str) else "") + guid = _v(attributes, "Type Def GUID") or (await self._type_def(name))["guid"] + if verb == "Delete": + await self.expert._async_delete_type_def(guid, name) + return self._result(f"Deleted type definition '{name}'", guid) + if verb == "Update": + patch = {"class": "OpenMetadataTypeDefPatch", "typeDefGUID": guid, "typeDefName": name, + "applyToVersion": int(_v(attributes, "Apply To Version"))} + if _v(attributes, "Type Def Description"): + patch["description"] = _v(attributes, "Type Def Description") + if attribute_definitions(attributes): + patch["attributeDefinitions"] = attribute_definitions(attributes) + await self.expert._async_update_type_def(patch) + return self._result(f"Updated type definition '{name}'", guid) + raise PyegeriaException(f"Unsupported verb '{verb}' for Type Def.") + + +class EnumDefProcessor(MetadataExpertProcessor): + async def apply_changes(self) -> str: + attributes = self.parsed_output["attributes"] + name = _v(attributes, "Enum Def Name") + if not name: + raise PyegeriaException("Enum Def Name is required.") + if self.command.verb == "Create": + guid = await self.expert._async_add_enum_def(enum_def_body(attributes)) + self.parsed_output["guid"] = guid if isinstance(guid, str) else None + return self._result(f"Added enum definition '{name}'", guid if isinstance(guid, str) else "") + if self.command.verb == "Delete": + guid = _v(attributes, "Enum Def GUID") or await self._enum_guid(name) + await self.expert._async_delete_enum_def(guid, name) + return self._result(f"Deleted enum definition '{name}'", guid) + raise PyegeriaException(f"Unsupported verb '{self.command.verb}' for Enum Def.") + + +class CountMetadataElementsProcessor(MetadataExpertProcessor): + async def apply_changes(self) -> str: + attributes = self.parsed_output["attributes"] + body: Dict[str, Any] = {"class": "FindRequestBody"} + if _v(attributes, "Count Element Type Name"): + body["metadataElementTypeName"] = _v(attributes, "Count Element Type Name") + if _v(attributes, "Count Search String"): + body["searchString"] = _v(attributes, "Count Search String") + count = await self.expert._async_count_metadata_elements( + body, push_down=_bool(_v(attributes, "Count Push Down"))) + return self._result("Matching metadata elements", str(count)) + + +class PublishMetadataElementProcessor(MetadataExpertProcessor): + async def apply_changes(self) -> str: + guid = self.parsed_output["attributes"].get("Metadata Element GUID", {}).get("value") + if not guid: + raise PyegeriaException("Metadata Element GUID is required.") + await self.expert._async_publish_metadata_element(guid) + self.parsed_output["guid"] = guid + return self._result("Published metadata element", guid) + + +# --- instances, relationships and classifications ------------------------------------------------- + +def _primitive(value: Any) -> Dict[str, Any]: + """Infer a PrimitiveTypePropertyValue from an authored string: true/false -> boolean, + whole number -> int, anything else -> string.""" + text = str(value).strip() + if text.lower() in ("true", "false"): + return {"class": "PrimitiveTypePropertyValue", "typeName": "boolean", "primitiveValue": text.lower() == "true"} + if re.fullmatch(r"-?\d+", text): + return {"class": "PrimitiveTypePropertyValue", "typeName": "int", "primitiveValue": int(text)} + return {"class": "PrimitiveTypePropertyValue", "typeName": "string", "primitiveValue": text} + + +def element_properties(properties: Optional[Dict[str, Any]], class_name: str) -> Optional[Dict[str, Any]]: + """'name: value' Dictionary -> {"class": class_name, "propertyValueMap": {...}}; None when empty.""" + if not properties: + return None + return {"class": class_name, "propertyValueMap": {str(k): _primitive(v) for k, v in properties.items()}} + + +def _require(attributes: Dict[str, Any], name: str) -> Any: + value = _v(attributes, name) + if value is None: + raise PyegeriaException(f"{name} is required.") + return value + + +def _delete_method(attributes: Dict[str, Any]) -> str: + return str(_v(attributes, "Delete Method", "SOFT_DELETE")).strip().upper() + + +def new_instance_body(attributes: Dict[str, Any]) -> Dict[str, Any]: + body: Dict[str, Any] = {"class": "NewOpenMetadataElementRequestBody", + "typeName": _require(attributes, "Instance Type Name")} + props = element_properties(_v(attributes, "Instance Properties"), "EntityElementProperties") + if props: + body["properties"] = props + if _v(attributes, "Anchor GUID"): + body["anchorGUID"] = _v(attributes, "Anchor GUID") + if _bool(_v(attributes, "Is Own Anchor")) is not None: + body["isOwnAnchor"] = _bool(_v(attributes, "Is Own Anchor")) + if _v(attributes, "Parent GUID"): + if not _v(attributes, "Parent Relationship Type Name"): + raise PyegeriaException("Parent Relationship Type Name is required when Parent GUID is given.") + body["parentGUID"] = _v(attributes, "Parent GUID") + body["parentRelationshipTypeName"] = _v(attributes, "Parent Relationship Type Name") + at_end_1 = _bool(_v(attributes, "Parent at End1")) + body["parentAtEnd1"] = True if at_end_1 is None else at_end_1 + return body + + +def update_properties_body(properties: Optional[Dict[str, Any]], class_name: str, + attributes: Dict[str, Any]) -> Dict[str, Any]: + props = element_properties(properties, class_name) + if not props: + raise PyegeriaException("At least one property is required.") + return {"class": "UpdatePropertiesRequestBody", "properties": props, + "replaceProperties": bool(_bool(_v(attributes, "Replace Properties")))} + + +def related_elements_body(attributes: Dict[str, Any]) -> Dict[str, Any]: + body: Dict[str, Any] = {"class": "NewRelatedElementsRequestBody", + "typeName": _require(attributes, "Relationship Type Name"), + "metadataElement1GUID": _require(attributes, "Element 1 GUID"), + "metadataElement2GUID": _require(attributes, "Element 2 GUID")} + props = element_properties(_v(attributes, "Relationship Properties"), "RelationshipElementProperties") + if props: + body["properties"] = props + return body + + +class InstanceProcessor(MetadataExpertProcessor): + """Create / Update / Delete Instance.""" + + async def apply_changes(self) -> str: + attributes = self.parsed_output["attributes"] + verb = self.command.verb + if verb == "Create": + guid = await self.expert._async_create_metadata_element(new_instance_body(attributes)) + self.parsed_output["guid"] = guid if isinstance(guid, str) else None + return self._result(f"Created {_v(attributes, 'Instance Type Name')} instance", guid if isinstance(guid, str) else "") + guid = _require(attributes, "Metadata Element GUID") + self.parsed_output["guid"] = guid + if verb == "Update": + await self.expert._async_update_metadata_element_properties( + guid, update_properties_body(_v(attributes, "Instance Properties"), "EntityElementProperties", attributes)) + return self._result("Updated instance", guid) + if verb == "Delete": + await self.expert._async_delete_metadata_element( + guid, {"class": "DeleteElementRequestBody", "deleteMethod": _delete_method(attributes)}) + return self._result("Deleted instance", guid) + raise PyegeriaException(f"Unsupported verb '{verb}' for Instance.") + + +class InstanceRelationshipProcessor(MetadataExpertProcessor): + """Link / Unlink Instances and Update Relationship.""" + + async def apply_changes(self) -> str: + attributes = self.parsed_output["attributes"] + verb, object_type = self.command.verb, self.command.object_type + if verb == "Link": + guid = await self.expert._async_create_related_elements(related_elements_body(attributes)) + self.parsed_output["guid"] = guid if isinstance(guid, str) else None + return self._result("Created relationship", guid if isinstance(guid, str) else "") + guid = _require(attributes, "Relationship GUID") + self.parsed_output["guid"] = guid + if verb == "Unlink": + await self.expert._async_delete_related_elements( + guid, {"class": "DeleteRelationshipRequestBody", "deleteMethod": _delete_method(attributes)}) + return self._result("Deleted relationship", guid) + if verb == "Update" and object_type == "Relationship": + await self.expert._async_update_related_elements_properties( + guid, update_properties_body(_v(attributes, "Relationship Properties"), + "RelationshipElementProperties", attributes)) + return self._result("Updated relationship", guid) + raise PyegeriaException(f"Unsupported command '{verb} {object_type}'.") + + +class InstanceClassificationProcessor(MetadataExpertProcessor): + """Classify / Reclassify / Declassify Instance.""" + + async def apply_changes(self) -> str: + attributes = self.parsed_output["attributes"] + guid = _require(attributes, "Metadata Element GUID") + name = _require(attributes, "Classification Name") + self.parsed_output["guid"] = guid + props = _v(attributes, "Classification Properties") + verb = self.command.verb + if verb == "Classify": + body: Dict[str, Any] = {"class": "NewClassificationRequestBody"} + cls_props = element_properties(props, "ClassificationElementProperties") + if cls_props: + body["properties"] = cls_props + await self.expert._async_classify_metadata_element(guid, name, body) + return self._result(f"Classified as {name}", guid) + if verb == "Reclassify": + await self.expert._async_reclassify_metadata_element( + guid, name, update_properties_body(props, "ClassificationElementProperties", attributes)) + return self._result(f"Reclassified {name}", guid) + if verb == "Declassify": + await self.expert._async_declassify_metadata_element(guid, name) + return self._result(f"Removed classification {name}", guid) + raise PyegeriaException(f"Unsupported verb '{verb}' for Instance classification.") diff --git a/pyegeria/view/base_report_formats.py b/pyegeria/view/base_report_formats.py index 87bf0eb8..5149259d 100644 --- a/pyegeria/view/base_report_formats.py +++ b/pyegeria/view/base_report_formats.py @@ -180,6 +180,8 @@ 'Element-DrE-Basic': FormatSet(target_type='Element', heading='Element-DrE-Basic Attributes', description='Auto-generated format for Element (Create, Basic).', family='Automation', formats=[Format(types=['LIST'], attributes=[Column(name='Template GUID', key='template_guid'), Column(name='Placeholder Property Values', key='placeholder_property_values'), Column(name='Template Properties', key='template_properties')]), Format(types=['ALL'], attributes=[Column(name='Template GUID', key='template_guid'), Column(name='Placeholder Property Values', key='placeholder_property_values'), Column(name='Template Properties', key='template_properties')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'OpenMetadataRoot', 'property_names': ['displayName', 'qualifiedName']})), 'Embedded-Process-DrE-Advanced': FormatSet(target_type='Embedded Process', heading='Embedded-Process-DrE-Advanced Attributes', description='Auto-generated format for Embedded Process (Create, Advanced).', family='Action Author', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Deployed Implementation Type', key='deployed_impl_type'), Column(name='Namespace Path', key='namespace_path'), Column(name='Resource Name', key='resource_name'), Column(name='Source', key='source'), Column(name='Formula', key='formula'), Column(name='Formula Type', key='formula_type'), Column(name='Expected Behaviour', key='expected_behaviour'), Column(name='Priority', key='priority'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_impl_type'), Column(name='Namespace Path', key='namespace_path'), Column(name='Resource Name', key='resource_name'), Column(name='Source', key='source'), Column(name='Formula', key='formula'), Column(name='Formula Type', key='formula_type'), Column(name='Expected Behaviour', key='expected_behaviour'), Column(name='Priority', key='priority'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'EmbeddedProcess', 'property_names': ['displayName', 'qualifiedName']})), 'Embedded-Process-DrE-Basic': FormatSet(target_type='Embedded Process', heading='Embedded-Process-DrE-Basic Attributes', description='Auto-generated format for Embedded Process (Create, Basic).', family='Action Author', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Deployed Implementation Type', key='deployed_impl_type'), Column(name='Namespace Path', key='namespace_path'), Column(name='Resource Name', key='resource_name'), Column(name='Priority', key='priority'), Column(name='Version Identifier', key='version_identifier'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_impl_type'), Column(name='Namespace Path', key='namespace_path'), Column(name='Resource Name', key='resource_name'), Column(name='Priority', key='priority')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'EmbeddedProcess', 'property_names': ['displayName', 'qualifiedName']})), + 'Enum-Def-DrE-Advanced': FormatSet(target_type='Enum Def', heading='Enum-Def-DrE-Advanced Attributes', description='Auto-generated format for Enum Def (Create, Advanced).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Enum Def Name', key='enum_def_name'), Column(name='Enum Def Description', key='enum_def_description'), Column(name='Enum Values', key='enum_values'), Column(name='Enum Default Value', key='enum_default_value')]), Format(types=['ALL'], attributes=[Column(name='Enum Def Name', key='enum_def_name'), Column(name='Enum Def Description', key='enum_def_description'), Column(name='Enum Values', key='enum_values'), Column(name='Enum Default Value', key='enum_default_value')])]), + 'Enum-Def-DrE-Basic': FormatSet(target_type='Enum Def', heading='Enum-Def-DrE-Basic Attributes', description='Auto-generated format for Enum Def (Create, Basic).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Enum Def Name', key='enum_def_name'), Column(name='Enum Def Description', key='enum_def_description'), Column(name='Enum Values', key='enum_values'), Column(name='Enum Default Value', key='enum_default_value')]), Format(types=['ALL'], attributes=[Column(name='Enum Def Name', key='enum_def_name'), Column(name='Enum Def Description', key='enum_def_description'), Column(name='Enum Values', key='enum_values'), Column(name='Enum Default Value', key='enum_default_value')])]), 'Event-Set-DrE-Advanced': FormatSet(target_type='Event Set', heading='Event-Set-DrE-Advanced Attributes', description='Auto-generated format for Event Set (Create, Advanced).', family='Collections', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Purpose', key='purpose'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='CollectionManager.find_collections', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'EventSet'})), 'Event-Set-DrE-Basic': FormatSet(target_type='Event Set', heading='Event-Set-DrE-Basic Attributes', description='Auto-generated format for Event Set (Create, Basic).', family='Collections', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='Version Identifier', key='version_identifier'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Purpose', key='purpose')])], action=ActionParameter(function='CollectionManager.find_collections', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'EventSet'})), 'Experiment-DrE-Advanced': FormatSet(target_type='Experiment', heading='Experiment-DrE-Advanced Attributes', description='Auto-generated format for Experiment (Create, Advanced).', family='Projects', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Authors', key='authors'), Column(name='Actual Completion Date', key='actual_completion_date'), Column(name='Actual Start Date', key='actual_start_date'), Column(name='Mission', key='mission'), Column(name='Planned Completion Date', key='planned_completion_date'), Column(name='Planned Start Date', key='planned_start_date'), Column(name='Priority', key='priority'), Column(name='Project Approach', key='approach'), Column(name='Project Health', key='project_health'), Column(name='Project Identifier', key='project_identifier'), Column(name='Project Management Style', key='management_style'), Column(name='Project Phase', key='project_phase'), Column(name='Project Results Usage', key='results_usage'), Column(name='Project Scope', key='project_scope'), Column(name='Project Type', key='project_type', valid_values=['Project', 'Campaign', 'Task', 'PersonalProject', 'StudyProject', 'Experiment']), Column(name='Purposes', key='purposes'), Column(name='Sub-Projects', key='sub_projects'), Column(name='Success Criteria', key='success_criteria'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Project Status', key='project_status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Actual Completion Date', key='actual_completion_date'), Column(name='Actual Start Date', key='actual_start_date'), Column(name='Mission', key='mission'), Column(name='Planned Completion Date', key='planned_completion_date'), Column(name='Planned Start Date', key='planned_start_date'), Column(name='Priority', key='priority'), Column(name='Project Approach', key='approach'), Column(name='Project Health', key='project_health'), Column(name='Project Identifier', key='project_identifier'), Column(name='Project Management Style', key='management_style'), Column(name='Project Phase', key='project_phase'), Column(name='Project Results Usage', key='results_usage'), Column(name='Project Scope', key='project_scope'), Column(name='Project Status', key='project_status'), Column(name='Project Type', key='project_type', valid_values=['Project', 'Campaign', 'Task', 'PersonalProject', 'StudyProject', 'Experiment']), Column(name='Purposes', key='purposes'), Column(name='Sub-Projects', key='sub_projects'), Column(name='Success Criteria', key='success_criteria'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='ProjectManager.find_projects', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'include_only_classified_elements': ['Experiment']})), @@ -246,6 +248,8 @@ 'Informal-Tag-DrE-Basic': FormatSet(target_type='Informal Tag', heading='Informal-Tag-DrE-Basic Attributes', description='Auto-generated format for Informal Tag (Create, Basic).', family='Feedback', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Version Identifier', key='version_identifier'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier')])], action=ActionParameter(function='ServerClient.find_tags', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'])), 'Information-Supply-Chain-DrE-Advanced': FormatSet(target_type='Information Supply Chain', heading='Information-Supply-Chain-DrE-Advanced Attributes', description='Auto-generated format for Information Supply Chain (Create, Advanced).', family='Solution Architect', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='Estimated Volumetrics', key='estimated_volumetrics'), Column(name='In Information Supply Chain', key='in_supply_chain'), Column(name='Integration Style', key='integration_style'), Column(name='Nested Information Supply Chains', key='nested_info_supply_chains'), Column(name='Purposes', key='purposes'), Column(name='Scope', key='scope'), Column(name='Implemented By', key='implemented_by'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Purpose', key='purpose'), Column(name='Estimated Volumetrics', key='estimated_volumetrics'), Column(name='In Information Supply Chain', key='in_supply_chain'), Column(name='Integration Style', key='integration_style'), Column(name='Nested Information Supply Chains', key='nested_info_supply_chains'), Column(name='Purposes', key='purposes'), Column(name='Scope', key='scope'), Column(name='Implemented By', key='implemented_by'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='ISC Implementation Graph', key='iscImplementationMermaidGraph'), Column(name='ISC Data Mesh Graph', key='iscDataMeshMermaidGraph'), Column(name='ISC System Fabric Graph', key='iscSystemFabricMermaidGraph'), Column(name='ISC Data Fabric Graph', key='iscDataFabricMermaidGraph'), Column(name='ISC Data Mapping Graph', key='iscDataMappingMermaidGraph')]), Format(types=['MERMAID'], attributes=[Column(name='ISC Implementation Graph', key='iscImplementationMermaidGraph'), Column(name='ISC Data Mesh Graph', key='iscDataMeshMermaidGraph'), Column(name='ISC System Fabric Graph', key='iscSystemFabricMermaidGraph'), Column(name='ISC Data Fabric Graph', key='iscDataFabricMermaidGraph'), Column(name='ISC Data Mapping Graph', key='iscDataMappingMermaidGraph')])], action=ActionParameter(function='SolutionArchitect.find_information_supply_chains', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'])), 'Information-Supply-Chain-DrE-Basic': FormatSet(target_type='Information Supply Chain', heading='Information-Supply-Chain-DrE-Basic Attributes', description='Auto-generated format for Information Supply Chain (Create, Basic).', family='Solution Architect', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='In Information Supply Chain', key='in_supply_chain'), Column(name='Integration Style', key='integration_style'), Column(name='Nested Information Supply Chains', key='nested_info_supply_chains'), Column(name='Purposes', key='purposes'), Column(name='Scope', key='scope'), Column(name='Implemented By', key='implemented_by'), Column(name='Version Identifier', key='version_identifier'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Purpose', key='purpose'), Column(name='In Information Supply Chain', key='in_supply_chain'), Column(name='Integration Style', key='integration_style'), Column(name='Nested Information Supply Chains', key='nested_info_supply_chains'), Column(name='Purposes', key='purposes'), Column(name='Scope', key='scope'), Column(name='Implemented By', key='implemented_by'), Column(name='ISC Implementation Graph', key='iscImplementationMermaidGraph'), Column(name='ISC Data Mesh Graph', key='iscDataMeshMermaidGraph'), Column(name='ISC System Fabric Graph', key='iscSystemFabricMermaidGraph'), Column(name='ISC Data Fabric Graph', key='iscDataFabricMermaidGraph'), Column(name='ISC Data Mapping Graph', key='iscDataMappingMermaidGraph')]), Format(types=['MERMAID'], attributes=[Column(name='ISC Implementation Graph', key='iscImplementationMermaidGraph'), Column(name='ISC Data Mesh Graph', key='iscDataMeshMermaidGraph'), Column(name='ISC System Fabric Graph', key='iscSystemFabricMermaidGraph'), Column(name='ISC Data Fabric Graph', key='iscDataFabricMermaidGraph'), Column(name='ISC Data Mapping Graph', key='iscDataMappingMermaidGraph')])], action=ActionParameter(function='SolutionArchitect.find_information_supply_chains', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'])), + 'Instance-DrE-Advanced': FormatSet(target_type='Instance', heading='Instance-DrE-Advanced Attributes', description='Auto-generated format for Instance (Create, Advanced).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Instance Type Name', key='instance_type_name'), Column(name='Instance Properties', key='instance_properties'), Column(name='Anchor GUID', key='anchor_guid'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Parent GUID', key='parent_guid')]), Format(types=['ALL'], attributes=[Column(name='Instance Type Name', key='instance_type_name'), Column(name='Instance Properties', key='instance_properties'), Column(name='Anchor GUID', key='anchor_guid'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Parent GUID', key='parent_guid')])]), + 'Instance-DrE-Basic': FormatSet(target_type='Instance', heading='Instance-DrE-Basic Attributes', description='Auto-generated format for Instance (Create, Basic).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Instance Type Name', key='instance_type_name'), Column(name='Instance Properties', key='instance_properties'), Column(name='Anchor GUID', key='anchor_guid'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Parent GUID', key='parent_guid')]), Format(types=['ALL'], attributes=[Column(name='Instance Type Name', key='instance_type_name'), Column(name='Instance Properties', key='instance_properties'), Column(name='Anchor GUID', key='anchor_guid'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Parent GUID', key='parent_guid')])]), 'IT-Profile-Role-DrE-Advanced': FormatSet(target_type='IT Profile Role', heading='IT-Profile-Role-DrE-Advanced Attributes', description='Auto-generated format for IT Profile Role (Create, Advanced).', family='Actor Manager', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Scope', key='scope'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Scope', key='scope'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='ActorManager.find_actor_roles', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'ITProfileRole'})), 'IT-Profile-Role-DrE-Basic': FormatSet(target_type='IT Profile Role', heading='IT-Profile-Role-DrE-Basic Attributes', description='Auto-generated format for IT Profile Role (Create, Basic).', family='Actor Manager', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Scope', key='scope'), Column(name='Version Identifier', key='version_identifier'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Scope', key='scope')])], action=ActionParameter(function='ActorManager.find_actor_roles', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'ITProfileRole'})), 'IT-Subsystem-DrE-Advanced': FormatSet(target_type='IT Subsystem', heading='IT-Subsystem-DrE-Advanced Attributes', description='Auto-generated format for IT Subsystem (Create, Advanced).', family='Collections', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Purpose', key='purpose'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='CollectionManager.find_collections', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'ITSubsystem'})), @@ -386,6 +390,8 @@ 'Threat-DrE-Basic': FormatSet(target_type='Threat', heading='Threat-DrE-Basic Attributes', description='Auto-generated format for Threat (Create, Basic).', family='Governance Officer', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Authors', key='authors'), Column(name='Domain Identifier', key='domain_identifier', valid_values=['All Domains', 'Data', 'Privacy', 'Security', 'IT Infrastructure', 'Software Development', 'Corporate', 'Asset Management', 'Other']), Column(name='Implications', key='implications'), Column(name='Importance', key='importance'), Column(name='Outcomes', key='outcomes'), Column(name='Results', key='results'), Column(name='Scope', key='scope'), Column(name='Summary', key='summary'), Column(name='Usage', key='usage'), Column(name='Version Identifier', key='version_identifier'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Domain Identifier', key='domain_identifier', valid_values=['All Domains', 'Data', 'Privacy', 'Security', 'IT Infrastructure', 'Software Development', 'Corporate', 'Asset Management', 'Other']), Column(name='Implications', key='implications'), Column(name='Importance', key='importance'), Column(name='Outcomes', key='outcomes'), Column(name='Results', key='results'), Column(name='Scope', key='scope'), Column(name='Summary', key='summary'), Column(name='Usage', key='usage')])], action=ActionParameter(function='GovernanceOfficer.find_governance_definitions', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'Threat'})), 'ToDo-DrE-Advanced': FormatSet(target_type='ToDo', heading='ToDo-DrE-Advanced Attributes', description='Auto-generated format for ToDo (Create, Advanced).', family='Actor Manager', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Description', key='description'), Column(name='Situation', key='situation'), Column(name='Objective', key='objective'), Column(name='Priority', key='priority'), Column(name='Activity Status', key='activity_status', valid_values=['REQUESTED', 'APPROVED', 'WAITING', 'ACTIVATING', 'IN_PROGRESS', 'PAUSED', 'COMPLETED', 'INVALID', 'IGNORED', 'FAILED', 'CANCELLED', 'ABANDONED', 'OTHER'])]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Display Name', key='display_name'), Column(name='Description', key='description'), Column(name='Situation', key='situation'), Column(name='Objective', key='objective'), Column(name='Priority', key='priority'), Column(name='Activity Status', key='activity_status', valid_values=['REQUESTED', 'APPROVED', 'WAITING', 'ACTIVATING', 'IN_PROGRESS', 'PAUSED', 'COMPLETED', 'INVALID', 'IGNORED', 'FAILED', 'CANCELLED', 'ABANDONED', 'OTHER'])])]), 'ToDo-DrE-Basic': FormatSet(target_type='ToDo', heading='ToDo-DrE-Basic Attributes', description='Auto-generated format for ToDo (Create, Basic).', family='Actor Manager', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Description', key='description'), Column(name='Situation', key='situation'), Column(name='Objective', key='objective'), Column(name='Priority', key='priority'), Column(name='Activity Status', key='activity_status', valid_values=['REQUESTED', 'APPROVED', 'WAITING', 'ACTIVATING', 'IN_PROGRESS', 'PAUSED', 'COMPLETED', 'INVALID', 'IGNORED', 'FAILED', 'CANCELLED', 'ABANDONED', 'OTHER'])]), Format(types=['ALL'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Description', key='description'), Column(name='Situation', key='situation'), Column(name='Objective', key='objective'), Column(name='Priority', key='priority'), Column(name='Activity Status', key='activity_status', valid_values=['REQUESTED', 'APPROVED', 'WAITING', 'ACTIVATING', 'IN_PROGRESS', 'PAUSED', 'COMPLETED', 'INVALID', 'IGNORED', 'FAILED', 'CANCELLED', 'ABANDONED', 'OTHER'])])]), + 'Type-Def-DrE-Advanced': FormatSet(target_type='Type Def', heading='Type-Def-DrE-Advanced Attributes', description='Auto-generated format for Type Def (Create, Advanced).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Type Def Name', key='type_def_name'), Column(name='Type Def Category', key='type_def_category', valid_values=['Entity', 'Relationship', 'Classification']), Column(name='Super Type', key='super_type'), Column(name='Type Def Description', key='type_def_description'), Column(name='Type Def Attributes', key='type_def_attributes'), Column(name='Valid Entity Types', key='valid_entity_types'), Column(name='Propagatable', key='propagatable'), Column(name='End1 Entity Type', key='end1_entity_type'), Column(name='End1 Attribute Name', key='end1_attribute_name'), Column(name='End2 Entity Type', key='end2_entity_type'), Column(name='End2 Attribute Name', key='end2_attribute_name')]), Format(types=['ALL'], attributes=[Column(name='Type Def Name', key='type_def_name'), Column(name='Type Def Category', key='type_def_category', valid_values=['Entity', 'Relationship', 'Classification']), Column(name='Super Type', key='super_type'), Column(name='Type Def Description', key='type_def_description'), Column(name='Type Def Attributes', key='type_def_attributes'), Column(name='Valid Entity Types', key='valid_entity_types'), Column(name='Propagatable', key='propagatable'), Column(name='End1 Entity Type', key='end1_entity_type'), Column(name='End1 Attribute Name', key='end1_attribute_name'), Column(name='End2 Entity Type', key='end2_entity_type'), Column(name='End2 Attribute Name', key='end2_attribute_name')])]), + 'Type-Def-DrE-Basic': FormatSet(target_type='Type Def', heading='Type-Def-DrE-Basic Attributes', description='Auto-generated format for Type Def (Create, Basic).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Type Def Name', key='type_def_name'), Column(name='Type Def Category', key='type_def_category', valid_values=['Entity', 'Relationship', 'Classification']), Column(name='Super Type', key='super_type'), Column(name='Type Def Description', key='type_def_description'), Column(name='Type Def Attributes', key='type_def_attributes'), Column(name='Valid Entity Types', key='valid_entity_types'), Column(name='Propagatable', key='propagatable'), Column(name='End1 Entity Type', key='end1_entity_type'), Column(name='End1 Attribute Name', key='end1_attribute_name'), Column(name='End2 Entity Type', key='end2_entity_type'), Column(name='End2 Attribute Name', key='end2_attribute_name')]), Format(types=['ALL'], attributes=[Column(name='Type Def Name', key='type_def_name'), Column(name='Type Def Category', key='type_def_category', valid_values=['Entity', 'Relationship', 'Classification']), Column(name='Super Type', key='super_type'), Column(name='Type Def Description', key='type_def_description'), Column(name='Type Def Attributes', key='type_def_attributes'), Column(name='Valid Entity Types', key='valid_entity_types'), Column(name='Propagatable', key='propagatable'), Column(name='End1 Entity Type', key='end1_entity_type'), Column(name='End1 Attribute Name', key='end1_attribute_name'), Column(name='End2 Entity Type', key='end2_entity_type'), Column(name='End2 Attribute Name', key='end2_attribute_name')])]), 'UC-Catalog-Element-DrE-Advanced': FormatSet(target_type='UC Catalog Element', heading='UC-Catalog-Element-DrE-Advanced Attributes', description='Auto-generated format for UC Catalog Element (Create, Advanced).', family='Asset Maker', formats=[Format(types=['LIST'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Deployed Implementation Type', key='deployed_implementation_type'), Column(name='Version Identifier', key='version_identifier')]), Format(types=['ALL'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_implementation_type')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type', 'deployed_implementation_type'], spec_params={'default_deployed_implementation_type': 'Unity Catalog Catalog', 'metadata_element_type': 'SoftwareCapability', 'property_names': ['displayName', 'qualifiedName']})), 'UC-Catalog-Element-DrE-Basic': FormatSet(target_type='UC Catalog Element', heading='UC-Catalog-Element-DrE-Basic Attributes', description='Auto-generated format for UC Catalog Element (Create, Basic).', family='Asset Maker', formats=[Format(types=['LIST'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Deployed Implementation Type', key='deployed_implementation_type'), Column(name='Version Identifier', key='version_identifier')]), Format(types=['ALL'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_implementation_type')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type', 'deployed_implementation_type'], spec_params={'default_deployed_implementation_type': 'Unity Catalog Catalog', 'metadata_element_type': 'SoftwareCapability', 'property_names': ['displayName', 'qualifiedName']})), 'UC-Function-Element-DrE-Advanced': FormatSet(target_type='UC Function Element', heading='UC-Function-Element-DrE-Advanced Attributes', description='Auto-generated format for UC Function Element (Create, Advanced).', family='Asset Maker', formats=[Format(types=['LIST'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='UC Schema Name', key='uc_schema'), Column(name='UC Function Name', key='uc_function'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Deployed Implementation Type', key='deployed_implementation_type'), Column(name='Version Identifier', key='version_identifier')]), Format(types=['ALL'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='UC Schema Name', key='uc_schema'), Column(name='UC Function Name', key='uc_function'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_implementation_type')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type', 'deployed_implementation_type'], spec_params={'default_deployed_implementation_type': 'Unity Catalog Function', 'metadata_element_type': 'DeployedAPI', 'property_names': ['displayName', 'qualifiedName']})), diff --git a/pyegeria/view/dr_egeria_reports.py b/pyegeria/view/dr_egeria_reports.py index a3973cdf..70151e1b 100644 --- a/pyegeria/view/dr_egeria_reports.py +++ b/pyegeria/view/dr_egeria_reports.py @@ -82,6 +82,8 @@ 'Element-DrE-Basic': FormatSet(target_type='Element', heading='Element-DrE-Basic Attributes', description='Auto-generated format for Element (Create, Basic).', family='Automation', formats=[Format(types=['LIST'], attributes=[Column(name='Template GUID', key='template_guid'), Column(name='Placeholder Property Values', key='placeholder_property_values'), Column(name='Template Properties', key='template_properties')]), Format(types=['ALL'], attributes=[Column(name='Template GUID', key='template_guid'), Column(name='Placeholder Property Values', key='placeholder_property_values'), Column(name='Template Properties', key='template_properties')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'OpenMetadataRoot', 'property_names': ['displayName', 'qualifiedName']})), 'Embedded-Process-DrE-Advanced': FormatSet(target_type='Embedded Process', heading='Embedded-Process-DrE-Advanced Attributes', description='Auto-generated format for Embedded Process (Create, Advanced).', family='Action Author', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Deployed Implementation Type', key='deployed_impl_type'), Column(name='Namespace Path', key='namespace_path'), Column(name='Resource Name', key='resource_name'), Column(name='Source', key='source'), Column(name='Formula', key='formula'), Column(name='Formula Type', key='formula_type'), Column(name='Expected Behaviour', key='expected_behaviour'), Column(name='Priority', key='priority'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_impl_type'), Column(name='Namespace Path', key='namespace_path'), Column(name='Resource Name', key='resource_name'), Column(name='Source', key='source'), Column(name='Formula', key='formula'), Column(name='Formula Type', key='formula_type'), Column(name='Expected Behaviour', key='expected_behaviour'), Column(name='Priority', key='priority'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'EmbeddedProcess', 'property_names': ['displayName', 'qualifiedName']})), 'Embedded-Process-DrE-Basic': FormatSet(target_type='Embedded Process', heading='Embedded-Process-DrE-Basic Attributes', description='Auto-generated format for Embedded Process (Create, Basic).', family='Action Author', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Deployed Implementation Type', key='deployed_impl_type'), Column(name='Namespace Path', key='namespace_path'), Column(name='Resource Name', key='resource_name'), Column(name='Priority', key='priority'), Column(name='Version Identifier', key='version_identifier'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_impl_type'), Column(name='Namespace Path', key='namespace_path'), Column(name='Resource Name', key='resource_name'), Column(name='Priority', key='priority')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'EmbeddedProcess', 'property_names': ['displayName', 'qualifiedName']})), + 'Enum-Def-DrE-Advanced': FormatSet(target_type='Enum Def', heading='Enum-Def-DrE-Advanced Attributes', description='Auto-generated format for Enum Def (Create, Advanced).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Enum Def Name', key='enum_def_name'), Column(name='Enum Def Description', key='enum_def_description'), Column(name='Enum Values', key='enum_values'), Column(name='Enum Default Value', key='enum_default_value')]), Format(types=['ALL'], attributes=[Column(name='Enum Def Name', key='enum_def_name'), Column(name='Enum Def Description', key='enum_def_description'), Column(name='Enum Values', key='enum_values'), Column(name='Enum Default Value', key='enum_default_value')])]), + 'Enum-Def-DrE-Basic': FormatSet(target_type='Enum Def', heading='Enum-Def-DrE-Basic Attributes', description='Auto-generated format for Enum Def (Create, Basic).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Enum Def Name', key='enum_def_name'), Column(name='Enum Def Description', key='enum_def_description'), Column(name='Enum Values', key='enum_values'), Column(name='Enum Default Value', key='enum_default_value')]), Format(types=['ALL'], attributes=[Column(name='Enum Def Name', key='enum_def_name'), Column(name='Enum Def Description', key='enum_def_description'), Column(name='Enum Values', key='enum_values'), Column(name='Enum Default Value', key='enum_default_value')])]), 'Event-Set-DrE-Advanced': FormatSet(target_type='Event Set', heading='Event-Set-DrE-Advanced Attributes', description='Auto-generated format for Event Set (Create, Advanced).', family='Collections', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Purpose', key='purpose'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='CollectionManager.find_collections', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'EventSet'})), 'Event-Set-DrE-Basic': FormatSet(target_type='Event Set', heading='Event-Set-DrE-Basic Attributes', description='Auto-generated format for Event Set (Create, Basic).', family='Collections', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='Version Identifier', key='version_identifier'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Purpose', key='purpose')])], action=ActionParameter(function='CollectionManager.find_collections', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'EventSet'})), 'Experiment-DrE-Advanced': FormatSet(target_type='Experiment', heading='Experiment-DrE-Advanced Attributes', description='Auto-generated format for Experiment (Create, Advanced).', family='Projects', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Authors', key='authors'), Column(name='Actual Completion Date', key='actual_completion_date'), Column(name='Actual Start Date', key='actual_start_date'), Column(name='Mission', key='mission'), Column(name='Planned Completion Date', key='planned_completion_date'), Column(name='Planned Start Date', key='planned_start_date'), Column(name='Priority', key='priority'), Column(name='Project Approach', key='approach'), Column(name='Project Health', key='project_health'), Column(name='Project Identifier', key='project_identifier'), Column(name='Project Management Style', key='management_style'), Column(name='Project Phase', key='project_phase'), Column(name='Project Results Usage', key='results_usage'), Column(name='Project Scope', key='project_scope'), Column(name='Project Type', key='project_type', valid_values=['Project', 'Campaign', 'Task', 'PersonalProject', 'StudyProject', 'Experiment']), Column(name='Purposes', key='purposes'), Column(name='Sub-Projects', key='sub_projects'), Column(name='Success Criteria', key='success_criteria'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Project Status', key='project_status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Actual Completion Date', key='actual_completion_date'), Column(name='Actual Start Date', key='actual_start_date'), Column(name='Mission', key='mission'), Column(name='Planned Completion Date', key='planned_completion_date'), Column(name='Planned Start Date', key='planned_start_date'), Column(name='Priority', key='priority'), Column(name='Project Approach', key='approach'), Column(name='Project Health', key='project_health'), Column(name='Project Identifier', key='project_identifier'), Column(name='Project Management Style', key='management_style'), Column(name='Project Phase', key='project_phase'), Column(name='Project Results Usage', key='results_usage'), Column(name='Project Scope', key='project_scope'), Column(name='Project Status', key='project_status'), Column(name='Project Type', key='project_type', valid_values=['Project', 'Campaign', 'Task', 'PersonalProject', 'StudyProject', 'Experiment']), Column(name='Purposes', key='purposes'), Column(name='Sub-Projects', key='sub_projects'), Column(name='Success Criteria', key='success_criteria'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='ProjectManager.find_projects', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'include_only_classified_elements': ['Experiment']})), @@ -148,6 +150,8 @@ 'Informal-Tag-DrE-Basic': FormatSet(target_type='Informal Tag', heading='Informal-Tag-DrE-Basic Attributes', description='Auto-generated format for Informal Tag (Create, Basic).', family='Feedback', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Version Identifier', key='version_identifier'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier')])], action=ActionParameter(function='ServerClient.find_tags', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'])), 'Information-Supply-Chain-DrE-Advanced': FormatSet(target_type='Information Supply Chain', heading='Information-Supply-Chain-DrE-Advanced Attributes', description='Auto-generated format for Information Supply Chain (Create, Advanced).', family='Solution Architect', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='Estimated Volumetrics', key='estimated_volumetrics'), Column(name='In Information Supply Chain', key='in_supply_chain'), Column(name='Integration Style', key='integration_style'), Column(name='Nested Information Supply Chains', key='nested_info_supply_chains'), Column(name='Purposes', key='purposes'), Column(name='Scope', key='scope'), Column(name='Implemented By', key='implemented_by'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Purpose', key='purpose'), Column(name='Estimated Volumetrics', key='estimated_volumetrics'), Column(name='In Information Supply Chain', key='in_supply_chain'), Column(name='Integration Style', key='integration_style'), Column(name='Nested Information Supply Chains', key='nested_info_supply_chains'), Column(name='Purposes', key='purposes'), Column(name='Scope', key='scope'), Column(name='Implemented By', key='implemented_by'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='ISC Implementation Graph', key='iscImplementationMermaidGraph'), Column(name='ISC Data Mesh Graph', key='iscDataMeshMermaidGraph'), Column(name='ISC System Fabric Graph', key='iscSystemFabricMermaidGraph'), Column(name='ISC Data Fabric Graph', key='iscDataFabricMermaidGraph'), Column(name='ISC Data Mapping Graph', key='iscDataMappingMermaidGraph')]), Format(types=['MERMAID'], attributes=[Column(name='ISC Implementation Graph', key='iscImplementationMermaidGraph'), Column(name='ISC Data Mesh Graph', key='iscDataMeshMermaidGraph'), Column(name='ISC System Fabric Graph', key='iscSystemFabricMermaidGraph'), Column(name='ISC Data Fabric Graph', key='iscDataFabricMermaidGraph'), Column(name='ISC Data Mapping Graph', key='iscDataMappingMermaidGraph')])], action=ActionParameter(function='SolutionArchitect.find_information_supply_chains', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'])), 'Information-Supply-Chain-DrE-Basic': FormatSet(target_type='Information Supply Chain', heading='Information-Supply-Chain-DrE-Basic Attributes', description='Auto-generated format for Information Supply Chain (Create, Basic).', family='Solution Architect', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='In Information Supply Chain', key='in_supply_chain'), Column(name='Integration Style', key='integration_style'), Column(name='Nested Information Supply Chains', key='nested_info_supply_chains'), Column(name='Purposes', key='purposes'), Column(name='Scope', key='scope'), Column(name='Implemented By', key='implemented_by'), Column(name='Version Identifier', key='version_identifier'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Purpose', key='purpose'), Column(name='In Information Supply Chain', key='in_supply_chain'), Column(name='Integration Style', key='integration_style'), Column(name='Nested Information Supply Chains', key='nested_info_supply_chains'), Column(name='Purposes', key='purposes'), Column(name='Scope', key='scope'), Column(name='Implemented By', key='implemented_by'), Column(name='ISC Implementation Graph', key='iscImplementationMermaidGraph'), Column(name='ISC Data Mesh Graph', key='iscDataMeshMermaidGraph'), Column(name='ISC System Fabric Graph', key='iscSystemFabricMermaidGraph'), Column(name='ISC Data Fabric Graph', key='iscDataFabricMermaidGraph'), Column(name='ISC Data Mapping Graph', key='iscDataMappingMermaidGraph')]), Format(types=['MERMAID'], attributes=[Column(name='ISC Implementation Graph', key='iscImplementationMermaidGraph'), Column(name='ISC Data Mesh Graph', key='iscDataMeshMermaidGraph'), Column(name='ISC System Fabric Graph', key='iscSystemFabricMermaidGraph'), Column(name='ISC Data Fabric Graph', key='iscDataFabricMermaidGraph'), Column(name='ISC Data Mapping Graph', key='iscDataMappingMermaidGraph')])], action=ActionParameter(function='SolutionArchitect.find_information_supply_chains', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'])), + 'Instance-DrE-Advanced': FormatSet(target_type='Instance', heading='Instance-DrE-Advanced Attributes', description='Auto-generated format for Instance (Create, Advanced).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Instance Type Name', key='instance_type_name'), Column(name='Instance Properties', key='instance_properties'), Column(name='Anchor GUID', key='anchor_guid'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Parent GUID', key='parent_guid')]), Format(types=['ALL'], attributes=[Column(name='Instance Type Name', key='instance_type_name'), Column(name='Instance Properties', key='instance_properties'), Column(name='Anchor GUID', key='anchor_guid'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Parent GUID', key='parent_guid')])]), + 'Instance-DrE-Basic': FormatSet(target_type='Instance', heading='Instance-DrE-Basic Attributes', description='Auto-generated format for Instance (Create, Basic).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Instance Type Name', key='instance_type_name'), Column(name='Instance Properties', key='instance_properties'), Column(name='Anchor GUID', key='anchor_guid'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Parent GUID', key='parent_guid')]), Format(types=['ALL'], attributes=[Column(name='Instance Type Name', key='instance_type_name'), Column(name='Instance Properties', key='instance_properties'), Column(name='Anchor GUID', key='anchor_guid'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Parent GUID', key='parent_guid')])]), 'IT-Profile-Role-DrE-Advanced': FormatSet(target_type='IT Profile Role', heading='IT-Profile-Role-DrE-Advanced Attributes', description='Auto-generated format for IT Profile Role (Create, Advanced).', family='Actor Manager', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Scope', key='scope'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Scope', key='scope'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='ActorManager.find_actor_roles', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'ITProfileRole'})), 'IT-Profile-Role-DrE-Basic': FormatSet(target_type='IT Profile Role', heading='IT-Profile-Role-DrE-Basic Attributes', description='Auto-generated format for IT Profile Role (Create, Basic).', family='Actor Manager', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Scope', key='scope'), Column(name='Version Identifier', key='version_identifier'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Scope', key='scope')])], action=ActionParameter(function='ActorManager.find_actor_roles', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'ITProfileRole'})), 'IT-Subsystem-DrE-Advanced': FormatSet(target_type='IT Subsystem', heading='IT-Subsystem-DrE-Advanced Attributes', description='Auto-generated format for IT Subsystem (Create, Advanced).', family='Collections', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='Authors', key='authors'), Column(name='Purpose', key='purpose'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties'), Column(name='Version Identifier', key='version_identifier'), Column(name='Status', key='status'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Glossary Term', key='glossary_term'), Column(name='Is Own Anchor', key='is_own_anchor'), Column(name='Status', key='status'), Column(name='Zone Membership', key='zone_membership'), Column(name='Additional Properties', key='additional_properties'), Column(name='Category', key='category'), Column(name='Confidence Classification', key='confidence_classification', valid_values=['UNCLASSIFIED', 'AD_HOC', 'TRANSACTIONAL', 'AUTHORITATIVE', 'DERIVED', 'OBSOLETE', 'OTHER']), Column(name='Confidentiality Classification', key='confidentiality_classification', valid_values=['UNCLASSIFIED', 'INTERNAL', 'CONFIDENTIAL', 'SENSITIVE', 'RESTRICTED', 'OTHER']), Column(name='Criticality Classification', key='criticality_classification', valid_values=['UNCLASSIFIED', 'MARGINAL', 'IMPORTANT', 'CRITICAL', 'CATASTROPHIC', 'OTHER']), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Identifier', key='identifier'), Column(name='Impact Classification', key='impact_classification', valid_values=['UNCLASSIFIED', 'LOW', 'MEDIUM', 'HIGH', 'OTHER']), Column(name='Legal', key='legal'), Column(name='Policy Management Point', key='policy_management_point'), Column(name='Qualified Name', key='qualified_name'), Column(name='Retention Classification', key='retention_classification', valid_values=['UNCLASSIFIED', 'TEMPORARY', 'PROJECT_LIFETIME', 'TEAM_LIFETIME', 'CONTRACT_LIFETIME', 'REGULATED_LIFETIME', 'TIMEBOXED_LIFETIME', 'OTHER']), Column(name='Security Tags', key='security_tags'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='User Defined Content Status', key='user_defined_content_status'), Column(name='Purpose', key='purpose'), Column(name='User Defined Status', key='user_defined_status'), Column(name='Classifications', key='classifications'), Column(name='Anchor Scope Name', key='anchor_scope_guid'), Column(name='Supplementary Properties', key='supplementary_properties')])], action=ActionParameter(function='CollectionManager.find_collections', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'ITSubsystem'})), @@ -288,6 +292,8 @@ 'Threat-DrE-Basic': FormatSet(target_type='Threat', heading='Threat-DrE-Basic Attributes', description='Auto-generated format for Threat (Create, Basic).', family='Governance Officer', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Qualified Name', key='qualified_name'), Column(name='GUID', key='guid'), Column(name='Zone Membership', key='zone_membership'), Column(name='Description', key='description'), Column(name='Legal', key='legal'), Column(name='Authors', key='authors'), Column(name='Domain Identifier', key='domain_identifier', valid_values=['All Domains', 'Data', 'Privacy', 'Security', 'IT Infrastructure', 'Software Development', 'Corporate', 'Asset Management', 'Other']), Column(name='Implications', key='implications'), Column(name='Importance', key='importance'), Column(name='Outcomes', key='outcomes'), Column(name='Results', key='results'), Column(name='Scope', key='scope'), Column(name='Summary', key='summary'), Column(name='Usage', key='usage'), Column(name='Version Identifier', key='version_identifier'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Category', key='category')]), Format(types=['ALL'], attributes=[Column(name='Zone Membership', key='zone_membership'), Column(name='Category', key='category'), Column(name='Description', key='description'), Column(name='Display Name', key='display_name'), Column(name='GUID', key='guid'), Column(name='Legal', key='legal'), Column(name='Qualified Name', key='qualified_name'), Column(name='URL', key='url'), Column(name='Version Identifier', key='version_identifier'), Column(name='Authors', key='authors'), Column(name='Content Status', key='content_status', valid_values=['DRAFT', 'PREPARED', 'PROPOSED', 'APPROVED', 'REJECTED', 'ACTIVE', 'DEPRECATED', 'OTHER']), Column(name='Domain Identifier', key='domain_identifier', valid_values=['All Domains', 'Data', 'Privacy', 'Security', 'IT Infrastructure', 'Software Development', 'Corporate', 'Asset Management', 'Other']), Column(name='Implications', key='implications'), Column(name='Importance', key='importance'), Column(name='Outcomes', key='outcomes'), Column(name='Results', key='results'), Column(name='Scope', key='scope'), Column(name='Summary', key='summary'), Column(name='Usage', key='usage')])], action=ActionParameter(function='GovernanceOfficer.find_governance_definitions', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type'], spec_params={'metadata_element_type': 'Threat'})), 'ToDo-DrE-Advanced': FormatSet(target_type='ToDo', heading='ToDo-DrE-Advanced Attributes', description='Auto-generated format for ToDo (Create, Advanced).', family='Actor Manager', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Description', key='description'), Column(name='Situation', key='situation'), Column(name='Objective', key='objective'), Column(name='Priority', key='priority'), Column(name='Activity Status', key='activity_status', valid_values=['REQUESTED', 'APPROVED', 'WAITING', 'ACTIVATING', 'IN_PROGRESS', 'PAUSED', 'COMPLETED', 'INVALID', 'IGNORED', 'FAILED', 'CANCELLED', 'ABANDONED', 'OTHER'])]), Format(types=['ALL'], attributes=[Column(name='Effective From', key='effective_from'), Column(name='Effective Time', key='effective_time'), Column(name='Effective To', key='effective_to'), Column(name='Display Name', key='display_name'), Column(name='Description', key='description'), Column(name='Situation', key='situation'), Column(name='Objective', key='objective'), Column(name='Priority', key='priority'), Column(name='Activity Status', key='activity_status', valid_values=['REQUESTED', 'APPROVED', 'WAITING', 'ACTIVATING', 'IN_PROGRESS', 'PAUSED', 'COMPLETED', 'INVALID', 'IGNORED', 'FAILED', 'CANCELLED', 'ABANDONED', 'OTHER'])])]), 'ToDo-DrE-Basic': FormatSet(target_type='ToDo', heading='ToDo-DrE-Basic Attributes', description='Auto-generated format for ToDo (Create, Basic).', family='Actor Manager', formats=[Format(types=['LIST'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Description', key='description'), Column(name='Situation', key='situation'), Column(name='Objective', key='objective'), Column(name='Priority', key='priority'), Column(name='Activity Status', key='activity_status', valid_values=['REQUESTED', 'APPROVED', 'WAITING', 'ACTIVATING', 'IN_PROGRESS', 'PAUSED', 'COMPLETED', 'INVALID', 'IGNORED', 'FAILED', 'CANCELLED', 'ABANDONED', 'OTHER'])]), Format(types=['ALL'], attributes=[Column(name='Display Name', key='display_name'), Column(name='Description', key='description'), Column(name='Situation', key='situation'), Column(name='Objective', key='objective'), Column(name='Priority', key='priority'), Column(name='Activity Status', key='activity_status', valid_values=['REQUESTED', 'APPROVED', 'WAITING', 'ACTIVATING', 'IN_PROGRESS', 'PAUSED', 'COMPLETED', 'INVALID', 'IGNORED', 'FAILED', 'CANCELLED', 'ABANDONED', 'OTHER'])])]), + 'Type-Def-DrE-Advanced': FormatSet(target_type='Type Def', heading='Type-Def-DrE-Advanced Attributes', description='Auto-generated format for Type Def (Create, Advanced).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Type Def Name', key='type_def_name'), Column(name='Type Def Category', key='type_def_category', valid_values=['Entity', 'Relationship', 'Classification']), Column(name='Super Type', key='super_type'), Column(name='Type Def Description', key='type_def_description'), Column(name='Type Def Attributes', key='type_def_attributes'), Column(name='Valid Entity Types', key='valid_entity_types'), Column(name='Propagatable', key='propagatable'), Column(name='End1 Entity Type', key='end1_entity_type'), Column(name='End1 Attribute Name', key='end1_attribute_name'), Column(name='End2 Entity Type', key='end2_entity_type'), Column(name='End2 Attribute Name', key='end2_attribute_name')]), Format(types=['ALL'], attributes=[Column(name='Type Def Name', key='type_def_name'), Column(name='Type Def Category', key='type_def_category', valid_values=['Entity', 'Relationship', 'Classification']), Column(name='Super Type', key='super_type'), Column(name='Type Def Description', key='type_def_description'), Column(name='Type Def Attributes', key='type_def_attributes'), Column(name='Valid Entity Types', key='valid_entity_types'), Column(name='Propagatable', key='propagatable'), Column(name='End1 Entity Type', key='end1_entity_type'), Column(name='End1 Attribute Name', key='end1_attribute_name'), Column(name='End2 Entity Type', key='end2_entity_type'), Column(name='End2 Attribute Name', key='end2_attribute_name')])]), + 'Type-Def-DrE-Basic': FormatSet(target_type='Type Def', heading='Type-Def-DrE-Basic Attributes', description='Auto-generated format for Type Def (Create, Basic).', family='MetadataExpert', formats=[Format(types=['LIST'], attributes=[Column(name='Type Def Name', key='type_def_name'), Column(name='Type Def Category', key='type_def_category', valid_values=['Entity', 'Relationship', 'Classification']), Column(name='Super Type', key='super_type'), Column(name='Type Def Description', key='type_def_description'), Column(name='Type Def Attributes', key='type_def_attributes'), Column(name='Valid Entity Types', key='valid_entity_types'), Column(name='Propagatable', key='propagatable'), Column(name='End1 Entity Type', key='end1_entity_type'), Column(name='End1 Attribute Name', key='end1_attribute_name'), Column(name='End2 Entity Type', key='end2_entity_type'), Column(name='End2 Attribute Name', key='end2_attribute_name')]), Format(types=['ALL'], attributes=[Column(name='Type Def Name', key='type_def_name'), Column(name='Type Def Category', key='type_def_category', valid_values=['Entity', 'Relationship', 'Classification']), Column(name='Super Type', key='super_type'), Column(name='Type Def Description', key='type_def_description'), Column(name='Type Def Attributes', key='type_def_attributes'), Column(name='Valid Entity Types', key='valid_entity_types'), Column(name='Propagatable', key='propagatable'), Column(name='End1 Entity Type', key='end1_entity_type'), Column(name='End1 Attribute Name', key='end1_attribute_name'), Column(name='End2 Entity Type', key='end2_entity_type'), Column(name='End2 Attribute Name', key='end2_attribute_name')])]), 'UC-Catalog-Element-DrE-Advanced': FormatSet(target_type='UC Catalog Element', heading='UC-Catalog-Element-DrE-Advanced Attributes', description='Auto-generated format for UC Catalog Element (Create, Advanced).', family='Asset Maker', formats=[Format(types=['LIST'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Deployed Implementation Type', key='deployed_implementation_type'), Column(name='Version Identifier', key='version_identifier')]), Format(types=['ALL'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_implementation_type')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type', 'deployed_implementation_type'], spec_params={'default_deployed_implementation_type': 'Unity Catalog Catalog', 'metadata_element_type': 'SoftwareCapability', 'property_names': ['displayName', 'qualifiedName']})), 'UC-Catalog-Element-DrE-Basic': FormatSet(target_type='UC Catalog Element', heading='UC-Catalog-Element-DrE-Basic Attributes', description='Auto-generated format for UC Catalog Element (Create, Basic).', family='Asset Maker', formats=[Format(types=['LIST'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Deployed Implementation Type', key='deployed_implementation_type'), Column(name='Version Identifier', key='version_identifier')]), Format(types=['ALL'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_implementation_type')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type', 'deployed_implementation_type'], spec_params={'default_deployed_implementation_type': 'Unity Catalog Catalog', 'metadata_element_type': 'SoftwareCapability', 'property_names': ['displayName', 'qualifiedName']})), 'UC-Function-Element-DrE-Advanced': FormatSet(target_type='UC Function Element', heading='UC-Function-Element-DrE-Advanced Attributes', description='Auto-generated format for UC Function Element (Create, Advanced).', family='Asset Maker', formats=[Format(types=['LIST'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='UC Schema Name', key='uc_schema'), Column(name='UC Function Name', key='uc_function'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Deployed Implementation Type', key='deployed_implementation_type'), Column(name='Version Identifier', key='version_identifier')]), Format(types=['ALL'], attributes=[Column(name='UC Catalog Name', key='uc_catalog'), Column(name='UC Schema Name', key='uc_schema'), Column(name='UC Function Name', key='uc_function'), Column(name='Network Address', key='network_address'), Column(name='Description', key='description'), Column(name='Version Identifier', key='version_identifier'), Column(name='Deployed Implementation Type', key='deployed_implementation_type')])], action=ActionParameter(function='ClassificationExplorer.find_elements_by_property_value', required_params=['search_string'], optional_params=['sequencing_order', 'sequencing_property', 'page_size', 'start_from', 'starts_with', 'ends_with', 'ignore_case', 'classification_names', 'metadata_element_subtypes', 'metadata_element_type', 'deployed_implementation_type'], spec_params={'default_deployed_implementation_type': 'Unity Catalog Function', 'metadata_element_type': 'DeployedAPI', 'property_names': ['displayName', 'qualifiedName']})), diff --git a/pyegeria/view/seed/MetadataExpert.json b/pyegeria/view/seed/MetadataExpert.json new file mode 100644 index 00000000..5b678391 --- /dev/null +++ b/pyegeria/view/seed/MetadataExpert.json @@ -0,0 +1,236 @@ +{ + "format": "pyegeria-seed/1", + "family": "MetadataExpert", + "specs": [ + { + "label": "Enum-Def-DrE-Advanced", + "envelope": { + "heading": "Enum-Def-DrE-Advanced Attributes", + "description": "Auto-generated format for Enum Def (Create, Advanced).", + "family": "MetadataExpert", + "target_type_name": "Enum Def", + "aliases": ["Enum Def DrE Advanced"] + }, + "microflow": { + "format": "microflow/1", + "params": {}, + "stages": [], + "formatters": { + "LIST": { + "columns": [ + {"field": "enum_def_name", "label": "Enum Def Name"}, + {"field": "enum_def_description", "label": "Enum Def Description"}, + {"field": "enum_values", "label": "Enum Values"}, + {"field": "enum_default_value", "label": "Enum Default Value"} + ] + }, + "ALL": { + "columns": [ + {"field": "enum_def_name", "label": "Enum Def Name"}, + {"field": "enum_def_description", "label": "Enum Def Description"}, + {"field": "enum_values", "label": "Enum Values"}, + {"field": "enum_default_value", "label": "Enum Default Value"} + ] + } + } + } + }, + { + "label": "Enum-Def-DrE-Basic", + "envelope": { + "heading": "Enum-Def-DrE-Basic Attributes", + "description": "Auto-generated format for Enum Def (Create, Basic).", + "family": "MetadataExpert", + "target_type_name": "Enum Def", + "aliases": ["Enum Def DrE Basic"] + }, + "microflow": { + "format": "microflow/1", + "params": {}, + "stages": [], + "formatters": { + "LIST": { + "columns": [ + {"field": "enum_def_name", "label": "Enum Def Name"}, + {"field": "enum_def_description", "label": "Enum Def Description"}, + {"field": "enum_values", "label": "Enum Values"}, + {"field": "enum_default_value", "label": "Enum Default Value"} + ] + }, + "ALL": { + "columns": [ + {"field": "enum_def_name", "label": "Enum Def Name"}, + {"field": "enum_def_description", "label": "Enum Def Description"}, + {"field": "enum_values", "label": "Enum Values"}, + {"field": "enum_default_value", "label": "Enum Default Value"} + ] + } + } + } + }, + { + "label": "Instance-DrE-Advanced", + "envelope": { + "heading": "Instance-DrE-Advanced Attributes", + "description": "Auto-generated format for Instance (Create, Advanced).", + "family": "MetadataExpert", + "target_type_name": "Instance", + "aliases": ["Instance DrE Advanced"] + }, + "microflow": { + "format": "microflow/1", + "params": {}, + "stages": [], + "formatters": { + "LIST": { + "columns": [ + {"field": "instance_type_name", "label": "Instance Type Name"}, + {"field": "instance_properties", "label": "Instance Properties"}, + {"field": "anchor_guid", "label": "Anchor GUID"}, + {"field": "is_own_anchor", "label": "Is Own Anchor"}, + {"field": "parent_guid", "label": "Parent GUID"} + ] + }, + "ALL": { + "columns": [ + {"field": "instance_type_name", "label": "Instance Type Name"}, + {"field": "instance_properties", "label": "Instance Properties"}, + {"field": "anchor_guid", "label": "Anchor GUID"}, + {"field": "is_own_anchor", "label": "Is Own Anchor"}, + {"field": "parent_guid", "label": "Parent GUID"} + ] + } + } + } + }, + { + "label": "Instance-DrE-Basic", + "envelope": { + "heading": "Instance-DrE-Basic Attributes", + "description": "Auto-generated format for Instance (Create, Basic).", + "family": "MetadataExpert", + "target_type_name": "Instance", + "aliases": ["Instance DrE Basic"] + }, + "microflow": { + "format": "microflow/1", + "params": {}, + "stages": [], + "formatters": { + "LIST": { + "columns": [ + {"field": "instance_type_name", "label": "Instance Type Name"}, + {"field": "instance_properties", "label": "Instance Properties"}, + {"field": "anchor_guid", "label": "Anchor GUID"}, + {"field": "is_own_anchor", "label": "Is Own Anchor"}, + {"field": "parent_guid", "label": "Parent GUID"} + ] + }, + "ALL": { + "columns": [ + {"field": "instance_type_name", "label": "Instance Type Name"}, + {"field": "instance_properties", "label": "Instance Properties"}, + {"field": "anchor_guid", "label": "Anchor GUID"}, + {"field": "is_own_anchor", "label": "Is Own Anchor"}, + {"field": "parent_guid", "label": "Parent GUID"} + ] + } + } + } + }, + { + "label": "Type-Def-DrE-Advanced", + "envelope": { + "heading": "Type-Def-DrE-Advanced Attributes", + "description": "Auto-generated format for Type Def (Create, Advanced).", + "family": "MetadataExpert", + "target_type_name": "Type Def", + "aliases": ["Type Def DrE Advanced"] + }, + "microflow": { + "format": "microflow/1", + "params": {}, + "stages": [], + "formatters": { + "LIST": { + "columns": [ + {"field": "type_def_name", "label": "Type Def Name"}, + {"field": "type_def_category", "label": "Type Def Category", "valid_values": ["Entity", "Relationship", "Classification"]}, + {"field": "super_type", "label": "Super Type"}, + {"field": "type_def_description", "label": "Type Def Description"}, + {"field": "type_def_attributes", "label": "Type Def Attributes"}, + {"field": "valid_entity_types", "label": "Valid Entity Types"}, + {"field": "propagatable", "label": "Propagatable"}, + {"field": "end1_entity_type", "label": "End1 Entity Type"}, + {"field": "end1_attribute_name", "label": "End1 Attribute Name"}, + {"field": "end2_entity_type", "label": "End2 Entity Type"}, + {"field": "end2_attribute_name", "label": "End2 Attribute Name"} + ] + }, + "ALL": { + "columns": [ + {"field": "type_def_name", "label": "Type Def Name"}, + {"field": "type_def_category", "label": "Type Def Category", "valid_values": ["Entity", "Relationship", "Classification"]}, + {"field": "super_type", "label": "Super Type"}, + {"field": "type_def_description", "label": "Type Def Description"}, + {"field": "type_def_attributes", "label": "Type Def Attributes"}, + {"field": "valid_entity_types", "label": "Valid Entity Types"}, + {"field": "propagatable", "label": "Propagatable"}, + {"field": "end1_entity_type", "label": "End1 Entity Type"}, + {"field": "end1_attribute_name", "label": "End1 Attribute Name"}, + {"field": "end2_entity_type", "label": "End2 Entity Type"}, + {"field": "end2_attribute_name", "label": "End2 Attribute Name"} + ] + } + } + } + }, + { + "label": "Type-Def-DrE-Basic", + "envelope": { + "heading": "Type-Def-DrE-Basic Attributes", + "description": "Auto-generated format for Type Def (Create, Basic).", + "family": "MetadataExpert", + "target_type_name": "Type Def", + "aliases": ["Type Def DrE Basic"] + }, + "microflow": { + "format": "microflow/1", + "params": {}, + "stages": [], + "formatters": { + "LIST": { + "columns": [ + {"field": "type_def_name", "label": "Type Def Name"}, + {"field": "type_def_category", "label": "Type Def Category", "valid_values": ["Entity", "Relationship", "Classification"]}, + {"field": "super_type", "label": "Super Type"}, + {"field": "type_def_description", "label": "Type Def Description"}, + {"field": "type_def_attributes", "label": "Type Def Attributes"}, + {"field": "valid_entity_types", "label": "Valid Entity Types"}, + {"field": "propagatable", "label": "Propagatable"}, + {"field": "end1_entity_type", "label": "End1 Entity Type"}, + {"field": "end1_attribute_name", "label": "End1 Attribute Name"}, + {"field": "end2_entity_type", "label": "End2 Entity Type"}, + {"field": "end2_attribute_name", "label": "End2 Attribute Name"} + ] + }, + "ALL": { + "columns": [ + {"field": "type_def_name", "label": "Type Def Name"}, + {"field": "type_def_category", "label": "Type Def Category", "valid_values": ["Entity", "Relationship", "Classification"]}, + {"field": "super_type", "label": "Super Type"}, + {"field": "type_def_description", "label": "Type Def Description"}, + {"field": "type_def_attributes", "label": "Type Def Attributes"}, + {"field": "valid_entity_types", "label": "Valid Entity Types"}, + {"field": "propagatable", "label": "Propagatable"}, + {"field": "end1_entity_type", "label": "End1 Entity Type"}, + {"field": "end1_attribute_name", "label": "End1 Attribute Name"}, + {"field": "end2_entity_type", "label": "End2 Entity Type"}, + {"field": "end2_attribute_name", "label": "End2 Attribute Name"} + ] + } + } + } + } + ] +} diff --git a/pyegeria/view/seed/manifest.json b/pyegeria/view/seed/manifest.json index 113e3044..70e41925 100644 --- a/pyegeria/view/seed/manifest.json +++ b/pyegeria/view/seed/manifest.json @@ -1,8 +1,8 @@ { "format": "pyegeria-seed/1", "description": "pyegeria's shipped report specs (the builtin tier). Generated by `python -m pyegeria.view.seed build` from the Python constants; do not edit by hand.", - "census": {"total": 439, "runnable": 378, "unrunnable": 0, "format_only": 61}, - "families": 39, + "census": {"total": 445, "runnable": 378, "unrunnable": 0, "format_only": 67}, + "families": 40, "files": [ {"file": "Action Author.json", "family": "Action Author", "count": 8}, {"file": "Actor Manager.json", "family": "Actor Manager", "count": 21}, @@ -28,6 +28,7 @@ {"file": "Glossary.json", "family": "Glossary", "count": 6}, {"file": "GlossaryManager.json", "family": "GlossaryManager", "count": 1}, {"file": "Governance Officer.json", "family": "Governance Officer", "count": 66}, + {"file": "MetadataExpert.json", "family": "MetadataExpert", "count": 6}, {"file": "My Profile.json", "family": "My Profile", "count": 3}, {"file": "MyProfile.json", "family": "MyProfile", "count": 13}, {"file": "Platform.json", "family": "Platform", "count": 2}, @@ -44,5 +45,5 @@ {"file": "Valid-Values.json", "family": "Valid-Values", "count": 1}, {"file": "Views & Reports.json", "family": "Views & Reports", "count": 12} ], - "order": ["Referenceable", "ToDo-DrE", "Meeting-DrE", "Review-DrE", "Default", "Comment-by-Element", "Element-By-Owner", "Actor-Profiles", "Actor-Profiles-Assigned-MD", "Profile-Team-Detail", "Actor-Roles", "Team-Members", "Team-Member-Role-Detail", "User-Identities", "Perspectives", "Skills", "My-User", "My-User-MD", "My-User-Contribution-Record-Detail", "My-User-Note-Logs-Detail", "My-User-Activities", "My-User-Blogs", "My-User-Journals", "My-User-Contact-Detail", "My-User-Roles-Detail", "My-User-Teams-Detail", "My-User-Projects-Detail", "My-User-Communities-Detail", "My-User-ToDos", "Org-Chart", "TypeDef", "Valid-Values", "Engine-Actions", "Asset-Graph", "Asset-Lineage-Hops", "Common-Mermaid", "Common-Mermaid-Prop-Value", "Tech-Type-Elements", "Search-Keywords", "Tech-Type-Details", "Tech-Type-Details-MD", "Catalog-Template-Detail", "Governance-Action-Processes-Detail", "Place-Holder-Property-Detail", "External-Reference-Detail", "Governance-Action-Steps-Detail", "Action-Targets-Detail", "Action-Request-Sources-Detail", "Catalog-Target", "Tech-Type-Processes", "Tech-Types", "Platforms", "OMAGServers", "IntegrationConnectors", "Journal-Entry-DrE", "Informal-Tags-DrE", "ExternalReference", "ExternalIdentifier", "RelatedMedia", "CitedDocument", "Projects", "Glossaries", "Glossary-Terms", "Help-Terms", "Collections", "Collection-MindMap", "BasicCollections", "Folders", "BusinessCapabilities", "Security-Findings", "Penetration-Test-Findings", "Security-Posture", "Statement-of-Applicability-Controls", "Statement-of-Applicability-Implementation-Summary", "Collection Members", "Solution-Blueprint-Mermaid", "Solution-Blueprint", "Registered-Services", "Severity-Definitions", "Asset-Types", "Digital-Product-Catalog", "Digital-Product-Catalog-MyE", "Digital-Products", "Digital-Products-MyE", "Digital-Products-Slim", "Agreements", "Data-Dictionaries", "Data-Specifications", "Data-Structures", "Data-Fields", "Data-Classes", "Data-Value-Spec", "Report-Specs", "Measurement-Specifications", "Dashboards", "External-References", "Governance Basics", "Governance Definitions", "Governance Def", "Governance-Controls", "Governance-Zones", "Governance-Process", "Governance-Zone-Overview-Charts", "Secrets-Collection-User-Profile-Charts", "Valid-Value-Def", "License-Type", "Governance Policies", "Activity-Entry-DrE-Advanced", "Activity-Entry-DrE-Basic", "Agreement-DrE-Advanced", "Agreement-DrE-Basic", "Blog-Entry-DrE-Advanced", "Blog-Entry-DrE-Basic", "Business-Capability-DrE-Advanced", "Business-Capability-DrE-Basic", "Business-Imperative-DrE-Advanced", "Business-Imperative-DrE-Basic", "Campaign-DrE-Advanced", "Campaign-DrE-Basic", "Certification-Type-DrE-Advanced", "Certification-Type-DrE-Basic", "Cited-Document-DrE-Advanced", "Cited-Document-DrE-Basic", "Collection-DrE-Advanced", "Collection-DrE-Basic", "Collection-Folder-DrE-Advanced", "Collection-Folder-DrE-Basic", "Comment-DrE-Advanced", "Comment-DrE-Basic", "Concept-Bead-Attribute-DrE-Advanced", "Concept-Bead-Attribute-DrE-Basic", "Concept-Bead-DrE-Advanced", "Concept-Bead-DrE-Basic", "Concept-Bead-Relationship-DrE-Advanced", "Concept-Bead-Relationship-DrE-Basic", "Concept-Model-DrE-Advanced", "Concept-Model-DrE-Basic", "Context-Event-Collection-DrE-Advanced", "Context-Event-Collection-DrE-Basic", "CSV-Data-File-Element-DrE-Advanced", "CSV-Data-File-Element-DrE-Basic", "CSV-File-DrE-Advanced", "CSV-File-DrE-Basic", "Dashboard-DrE-Advanced", "Dashboard-DrE-Basic", "Dashboard-Sheet-DrE-Advanced", "Dashboard-Sheet-DrE-Basic", "Data-Class-DrE-Advanced", "Data-Class-DrE-Basic", "Data-Dictionary-DrE-Advanced", "Data-Dictionary-DrE-Basic", "Data-Field-DrE-Advanced", "Data-Field-DrE-Basic", "Data-Grain-DrE-Advanced", "Data-Grain-DrE-Basic", "Data-Lens-DrE-Advanced", "Data-Lens-DrE-Basic", "Data-Processing-Purpose-DrE-Advanced", "Data-Processing-Purpose-DrE-Basic", "Data-Sharing-Agreement-DrE-Advanced", "Data-Sharing-Agreement-DrE-Basic", "Data-Sharing-Hub-DrE-Advanced", "Data-Sharing-Hub-DrE-Basic", "Data-Sharing-Request-DrE-Advanced", "Data-Sharing-Request-DrE-Basic", "Data-Spec-DrE-Advanced", "Data-Spec-DrE-Basic", "Data-Structure-DrE-Advanced", "Data-Structure-DrE-Basic", "Data-Value-Specification-DrE-Advanced", "Data-Value-Specification-DrE-Basic", "Design-Pattern-DrE-Advanced", "Design-Pattern-DrE-Basic", "Digital-Product-Catalog-DrE-Advanced", "Digital-Product-Catalog-DrE-Basic", "Digital-Product-DrE-Advanced", "Digital-Product-DrE-Basic", "Digital-Subscription-DrE-Advanced", "Digital-Subscription-DrE-Basic", "Display-Data-Container-DrE-Advanced", "Display-Data-Container-DrE-Basic", "Display-Data-Field-DrE-Advanced", "Display-Data-Field-DrE-Basic", "Element-DrE-Advanced", "Element-DrE-Basic", "Embedded-Process-DrE-Advanced", "Embedded-Process-DrE-Basic", "Event-Set-DrE-Advanced", "Event-Set-DrE-Basic", "Experiment-DrE-Advanced", "Experiment-DrE-Basic", "External-Data-Source-DrE-Advanced", "External-Data-Source-DrE-Basic", "External-Model-Source-DrE-Advanced", "External-Model-Source-DrE-Basic", "External-Reference-DrE-Advanced", "External-Reference-DrE-Basic", "External-Source-Code-DrE-Advanced", "External-Source-Code-DrE-Basic", "External-Standard-DrE-Advanced", "External-Standard-DrE-Basic", "Folder-Element-DrE-Advanced", "Folder-Element-DrE-Basic", "Folio-DrE-Advanced", "Folio-DrE-Basic", "Glossary-DrE-Advanced", "Glossary-DrE-Basic", "Glossary-Project-DrE-Advanced", "Glossary-Project-DrE-Basic", "Glossary-Term-DrE-Advanced", "Glossary-Term-DrE-Basic", "Governance-Action-Process-DrE-Advanced", "Governance-Action-Process-DrE-Basic", "Governance-Action-Process-Step-DrE-Advanced", "Governance-Action-Process-Step-DrE-Basic", "Governance-Action-Type-DrE-Advanced", "Governance-Action-Type-DrE-Basic", "Governance-Approach-DrE-Advanced", "Governance-Approach-DrE-Basic", "Governance-Control-DrE-Advanced", "Governance-Control-DrE-Basic", "Governance-Definition-DrE-Advanced", "Governance-Definition-DrE-Basic", "Governance-Driver-DrE-Advanced", "Governance-Driver-DrE-Basic", "Governance-Metric-DrE-Advanced", "Governance-Metric-DrE-Basic", "Governance-Obligation-DrE-Advanced", "Governance-Obligation-DrE-Basic", "Governance-Policy-DrE-Advanced", "Governance-Policy-DrE-Basic", "Governance-Principle-DrE-Advanced", "Governance-Principle-DrE-Basic", "Governance-Procedure-DrE-Advanced", "Governance-Procedure-DrE-Basic", "Governance-Project-DrE-Advanced", "Governance-Project-DrE-Basic", "Governance-Responsibility-DrE-Advanced", "Governance-Responsibility-DrE-Basic", "Governance-Role-DrE-Advanced", "Governance-Role-DrE-Basic", "Governance-Rule-DrE-Advanced", "Governance-Rule-DrE-Basic", "Governance-Strategy-DrE-Advanced", "Governance-Strategy-DrE-Basic", "Governance-Zone-DrE-Advanced", "Governance-Zone-DrE-Basic", "Home-Collection-DrE-Advanced", "Home-Collection-DrE-Basic", "Informal-Tag-DrE-Advanced", "Informal-Tag-DrE-Basic", "Information-Supply-Chain-DrE-Advanced", "Information-Supply-Chain-DrE-Basic", "IT-Profile-Role-DrE-Advanced", "IT-Profile-Role-DrE-Basic", "IT-Subsystem-DrE-Advanced", "IT-Subsystem-DrE-Basic", "Journal-Entry-DrE-Advanced", "Journal-Entry-DrE-Basic", "Kafka-Server-Element-DrE-Advanced", "Kafka-Server-Element-DrE-Basic", "License-Type-DrE-Advanced", "License-Type-DrE-Basic", "Like-DrE-Advanced", "Like-DrE-Basic", "Measurement-Specification-DrE-Advanced", "Measurement-Specification-DrE-Basic", "Meeting-DrE-Advanced", "Meeting-DrE-Basic", "Methodology-DrE-Advanced", "Methodology-DrE-Basic", "Namespace-DrE-Advanced", "Namespace-DrE-Basic", "Naming-Standard-Rule-DrE-Advanced", "Naming-Standard-Rule-DrE-Basic", "Naming-Standard-Rule-Set-DrE-Advanced", "Naming-Standard-Rule-Set-DrE-Basic", "Note-DrE-Advanced", "Note-DrE-Basic", "Notification-Type-DrE-Advanced", "Notification-Type-DrE-Basic", "Organization-DrE-Advanced", "Organization-DrE-Basic", "Penetration-Test-Finding-DrE-Advanced", "Penetration-Test-Finding-DrE-Basic", "Person-DrE-Advanced", "Person-DrE-Basic", "Person-Role-DrE-Advanced", "Person-Role-DrE-Basic", "Personal-Project-DrE-Advanced", "Personal-Project-DrE-Basic", "Perspective-DrE-Advanced", "Perspective-DrE-Basic", "Postgres-Database-Element-DrE-Advanced", "Postgres-Database-Element-DrE-Basic", "Postgres-Server-Element-DrE-Advanced", "Postgres-Server-Element-DrE-Basic", "Project-DrE-Advanced", "Project-DrE-Basic", "Question-DrE-Advanced", "Question-DrE-Basic", "Question-Spec-DrE-Advanced", "Question-Spec-DrE-Basic", "Rating-DrE-Advanced", "Rating-DrE-Basic", "Recent-Access-DrE-Advanced", "Recent-Access-DrE-Basic", "Reference-Data-Set-DrE-Advanced", "Reference-Data-Set-DrE-Basic", "Reference-Data-Value-DrE-Advanced", "Reference-Data-Value-DrE-Basic", "Reference-List-DrE-Advanced", "Reference-List-DrE-Basic", "Regulation-Article-DrE-Advanced", "Regulation-Article-DrE-Basic", "Regulation-DrE-Advanced", "Regulation-DrE-Basic", "Related-Media-DrE-Advanced", "Related-Media-DrE-Basic", "Report-DrE-Advanced", "Report-DrE-Basic", "Report-Spec-DrE-Advanced", "Report-Spec-DrE-Basic", "Report-Type-DrE-Advanced", "Report-Type-DrE-Basic", "Results-Set-DrE-Advanced", "Results-Set-DrE-Basic", "Review-DrE-Advanced", "Review-DrE-Basic", "Risk-DrE-Advanced", "Risk-DrE-Basic", "Root-Collection-DrE-Advanced", "Root-Collection-DrE-Basic", "Saved-Query-DrE-Advanced", "Saved-Query-DrE-Basic", "Schema-Attribute-DrE-Advanced", "Schema-Attribute-DrE-Basic", "Schema-Attribute-From-Template-DrE-Advanced", "Schema-Attribute-From-Template-DrE-Basic", "Schema-Type-DrE-Advanced", "Schema-Type-DrE-Basic", "Schema-Type-From-Template-DrE-Advanced", "Schema-Type-From-Template-DrE-Basic", "Secrets-Store-Element-DrE-Advanced", "Secrets-Store-Element-DrE-Basic", "Security-Access-Control-DrE-Advanced", "Security-Access-Control-DrE-Basic", "Security-Finding-DrE-Advanced", "Security-Finding-DrE-Basic", "Security-Group-DrE-Advanced", "Security-Group-DrE-Basic", "Security-List-DrE-Advanced", "Security-List-DrE-Basic", "Security-Posture-Summary-DrE-Advanced", "Security-Posture-Summary-DrE-Basic", "Security-Role-DrE-Advanced", "Security-Role-DrE-Basic", "Service-Level-Objective-DrE-Advanced", "Service-Level-Objective-DrE-Basic", "Skill-DrE-Advanced", "Skill-DrE-Basic", "Skill-Set-DrE-Advanced", "Skill-Set-DrE-Basic", "Software-Archive-DrE-Advanced", "Software-Archive-DrE-Basic", "Solution-Blueprint-DrE-Advanced", "Solution-Blueprint-DrE-Basic", "Solution-Component-DrE-Advanced", "Solution-Component-DrE-Basic", "Solution-Role-DrE-Advanced", "Solution-Role-DrE-Basic", "Statement-of-Applicability-DrE-Advanced", "Statement-of-Applicability-DrE-Basic", "Study-Project-DrE-Advanced", "Study-Project-DrE-Basic", "Subject-Area-DrE-Advanced", "Subject-Area-DrE-Basic", "Subscription-Type-DrE-Advanced", "Subscription-Type-DrE-Basic", "Survey-Report-DrE-Advanced", "Survey-Report-DrE-Basic", "Task-DrE-Advanced", "Task-DrE-Basic", "Team-DrE-Advanced", "Team-DrE-Basic", "Team-Role-DrE-Advanced", "Team-Role-DrE-Basic", "Terms-and-Conditions-DrE-Advanced", "Terms-and-Conditions-DrE-Basic", "Threat-DrE-Advanced", "Threat-DrE-Basic", "ToDo-DrE-Advanced", "ToDo-DrE-Basic", "UC-Catalog-Element-DrE-Advanced", "UC-Catalog-Element-DrE-Basic", "UC-Function-Element-DrE-Advanced", "UC-Function-Element-DrE-Basic", "UC-Schema-Element-DrE-Advanced", "UC-Schema-Element-DrE-Basic", "UC-Server-Element-DrE-Advanced", "UC-Server-Element-DrE-Basic", "UC-Table-Element-DrE-Advanced", "UC-Table-Element-DrE-Basic", "UC-Volume-Element-DrE-Advanced", "UC-Volume-Element-DrE-Basic", "Vulnerability-Finding-DrE-Advanced", "Vulnerability-Finding-DrE-Basic", "Work-Item-List-DrE-Advanced", "Work-Item-List-DrE-Basic", "Working-Set-DrE-Advanced", "Working-Set-DrE-Basic", "Analytic Demo - Element Count by Type", "Analytic Demo - Assets by Type Breakdown", "Analytic Demo - Ownership Coverage", "Analytic Demo - Business Value Signals", "Analytic Demo - Governance Coverage", "Analytic Demo - Certifications and Exceptions", "Analytic Demo - People and Community", "Analytic Demo - Feedback Summary", "Analytic Demo - Usage Context: Supply Chains & Blueprints", "Analytic Demo - Semantic Grounding", "Analytic Demo - AI Context Readiness", "Analytic Demo - AI-Ready Assets", "Analytic Demo - Catalog Growth Trend", "Analytic Demo - Term Definition Completeness", "Analytic Demo - Active Contributors", "Analytic Demo - Assets by Type Total (Composite)", "Analytic Demo - Count by Property", "Analytic Demo - Contextualised Coverage", "Analytic Demo - Karma Leaderboard", "Analytic Demo - Engagement Over Time", "Analytic Demo - Orphan Glossary Terms", "Analytic Demo - Stale Assets", "Analytic Demo - Metric Trend (Governance Coverage)", "Questions", "Report-Types", "Question-Specs", "DCAT Catalog", "DCAT Catalog (Turtle)"] + "order": ["Referenceable", "ToDo-DrE", "Meeting-DrE", "Review-DrE", "Default", "Comment-by-Element", "Element-By-Owner", "Actor-Profiles", "Actor-Profiles-Assigned-MD", "Profile-Team-Detail", "Actor-Roles", "Team-Members", "Team-Member-Role-Detail", "User-Identities", "Perspectives", "Skills", "My-User", "My-User-MD", "My-User-Contribution-Record-Detail", "My-User-Note-Logs-Detail", "My-User-Activities", "My-User-Blogs", "My-User-Journals", "My-User-Contact-Detail", "My-User-Roles-Detail", "My-User-Teams-Detail", "My-User-Projects-Detail", "My-User-Communities-Detail", "My-User-ToDos", "Org-Chart", "TypeDef", "Valid-Values", "Engine-Actions", "Asset-Graph", "Asset-Lineage-Hops", "Common-Mermaid", "Common-Mermaid-Prop-Value", "Tech-Type-Elements", "Search-Keywords", "Tech-Type-Details", "Tech-Type-Details-MD", "Catalog-Template-Detail", "Governance-Action-Processes-Detail", "Place-Holder-Property-Detail", "External-Reference-Detail", "Governance-Action-Steps-Detail", "Action-Targets-Detail", "Action-Request-Sources-Detail", "Catalog-Target", "Tech-Type-Processes", "Tech-Types", "Platforms", "OMAGServers", "IntegrationConnectors", "Journal-Entry-DrE", "Informal-Tags-DrE", "ExternalReference", "ExternalIdentifier", "RelatedMedia", "CitedDocument", "Projects", "Glossaries", "Glossary-Terms", "Help-Terms", "Collections", "Collection-MindMap", "BasicCollections", "Folders", "BusinessCapabilities", "Security-Findings", "Penetration-Test-Findings", "Security-Posture", "Statement-of-Applicability-Controls", "Statement-of-Applicability-Implementation-Summary", "Collection Members", "Solution-Blueprint-Mermaid", "Solution-Blueprint", "Registered-Services", "Severity-Definitions", "Asset-Types", "Digital-Product-Catalog", "Digital-Product-Catalog-MyE", "Digital-Products", "Digital-Products-MyE", "Digital-Products-Slim", "Agreements", "Data-Dictionaries", "Data-Specifications", "Data-Structures", "Data-Fields", "Data-Classes", "Data-Value-Spec", "Report-Specs", "Measurement-Specifications", "Dashboards", "External-References", "Governance Basics", "Governance Definitions", "Governance Def", "Governance-Controls", "Governance-Zones", "Governance-Process", "Governance-Zone-Overview-Charts", "Secrets-Collection-User-Profile-Charts", "Valid-Value-Def", "License-Type", "Governance Policies", "Activity-Entry-DrE-Advanced", "Activity-Entry-DrE-Basic", "Agreement-DrE-Advanced", "Agreement-DrE-Basic", "Blog-Entry-DrE-Advanced", "Blog-Entry-DrE-Basic", "Business-Capability-DrE-Advanced", "Business-Capability-DrE-Basic", "Business-Imperative-DrE-Advanced", "Business-Imperative-DrE-Basic", "Campaign-DrE-Advanced", "Campaign-DrE-Basic", "Certification-Type-DrE-Advanced", "Certification-Type-DrE-Basic", "Cited-Document-DrE-Advanced", "Cited-Document-DrE-Basic", "Collection-DrE-Advanced", "Collection-DrE-Basic", "Collection-Folder-DrE-Advanced", "Collection-Folder-DrE-Basic", "Comment-DrE-Advanced", "Comment-DrE-Basic", "Concept-Bead-Attribute-DrE-Advanced", "Concept-Bead-Attribute-DrE-Basic", "Concept-Bead-DrE-Advanced", "Concept-Bead-DrE-Basic", "Concept-Bead-Relationship-DrE-Advanced", "Concept-Bead-Relationship-DrE-Basic", "Concept-Model-DrE-Advanced", "Concept-Model-DrE-Basic", "Context-Event-Collection-DrE-Advanced", "Context-Event-Collection-DrE-Basic", "CSV-Data-File-Element-DrE-Advanced", "CSV-Data-File-Element-DrE-Basic", "CSV-File-DrE-Advanced", "CSV-File-DrE-Basic", "Dashboard-DrE-Advanced", "Dashboard-DrE-Basic", "Dashboard-Sheet-DrE-Advanced", "Dashboard-Sheet-DrE-Basic", "Data-Class-DrE-Advanced", "Data-Class-DrE-Basic", "Data-Dictionary-DrE-Advanced", "Data-Dictionary-DrE-Basic", "Data-Field-DrE-Advanced", "Data-Field-DrE-Basic", "Data-Grain-DrE-Advanced", "Data-Grain-DrE-Basic", "Data-Lens-DrE-Advanced", "Data-Lens-DrE-Basic", "Data-Processing-Purpose-DrE-Advanced", "Data-Processing-Purpose-DrE-Basic", "Data-Sharing-Agreement-DrE-Advanced", "Data-Sharing-Agreement-DrE-Basic", "Data-Sharing-Hub-DrE-Advanced", "Data-Sharing-Hub-DrE-Basic", "Data-Sharing-Request-DrE-Advanced", "Data-Sharing-Request-DrE-Basic", "Data-Spec-DrE-Advanced", "Data-Spec-DrE-Basic", "Data-Structure-DrE-Advanced", "Data-Structure-DrE-Basic", "Data-Value-Specification-DrE-Advanced", "Data-Value-Specification-DrE-Basic", "Design-Pattern-DrE-Advanced", "Design-Pattern-DrE-Basic", "Digital-Product-Catalog-DrE-Advanced", "Digital-Product-Catalog-DrE-Basic", "Digital-Product-DrE-Advanced", "Digital-Product-DrE-Basic", "Digital-Subscription-DrE-Advanced", "Digital-Subscription-DrE-Basic", "Display-Data-Container-DrE-Advanced", "Display-Data-Container-DrE-Basic", "Display-Data-Field-DrE-Advanced", "Display-Data-Field-DrE-Basic", "Element-DrE-Advanced", "Element-DrE-Basic", "Embedded-Process-DrE-Advanced", "Embedded-Process-DrE-Basic", "Enum-Def-DrE-Advanced", "Enum-Def-DrE-Basic", "Event-Set-DrE-Advanced", "Event-Set-DrE-Basic", "Experiment-DrE-Advanced", "Experiment-DrE-Basic", "External-Data-Source-DrE-Advanced", "External-Data-Source-DrE-Basic", "External-Model-Source-DrE-Advanced", "External-Model-Source-DrE-Basic", "External-Reference-DrE-Advanced", "External-Reference-DrE-Basic", "External-Source-Code-DrE-Advanced", "External-Source-Code-DrE-Basic", "External-Standard-DrE-Advanced", "External-Standard-DrE-Basic", "Folder-Element-DrE-Advanced", "Folder-Element-DrE-Basic", "Folio-DrE-Advanced", "Folio-DrE-Basic", "Glossary-DrE-Advanced", "Glossary-DrE-Basic", "Glossary-Project-DrE-Advanced", "Glossary-Project-DrE-Basic", "Glossary-Term-DrE-Advanced", "Glossary-Term-DrE-Basic", "Governance-Action-Process-DrE-Advanced", "Governance-Action-Process-DrE-Basic", "Governance-Action-Process-Step-DrE-Advanced", "Governance-Action-Process-Step-DrE-Basic", "Governance-Action-Type-DrE-Advanced", "Governance-Action-Type-DrE-Basic", "Governance-Approach-DrE-Advanced", "Governance-Approach-DrE-Basic", "Governance-Control-DrE-Advanced", "Governance-Control-DrE-Basic", "Governance-Definition-DrE-Advanced", "Governance-Definition-DrE-Basic", "Governance-Driver-DrE-Advanced", "Governance-Driver-DrE-Basic", "Governance-Metric-DrE-Advanced", "Governance-Metric-DrE-Basic", "Governance-Obligation-DrE-Advanced", "Governance-Obligation-DrE-Basic", "Governance-Policy-DrE-Advanced", "Governance-Policy-DrE-Basic", "Governance-Principle-DrE-Advanced", "Governance-Principle-DrE-Basic", "Governance-Procedure-DrE-Advanced", "Governance-Procedure-DrE-Basic", "Governance-Project-DrE-Advanced", "Governance-Project-DrE-Basic", "Governance-Responsibility-DrE-Advanced", "Governance-Responsibility-DrE-Basic", "Governance-Role-DrE-Advanced", "Governance-Role-DrE-Basic", "Governance-Rule-DrE-Advanced", "Governance-Rule-DrE-Basic", "Governance-Strategy-DrE-Advanced", "Governance-Strategy-DrE-Basic", "Governance-Zone-DrE-Advanced", "Governance-Zone-DrE-Basic", "Home-Collection-DrE-Advanced", "Home-Collection-DrE-Basic", "Informal-Tag-DrE-Advanced", "Informal-Tag-DrE-Basic", "Information-Supply-Chain-DrE-Advanced", "Information-Supply-Chain-DrE-Basic", "Instance-DrE-Advanced", "Instance-DrE-Basic", "IT-Profile-Role-DrE-Advanced", "IT-Profile-Role-DrE-Basic", "IT-Subsystem-DrE-Advanced", "IT-Subsystem-DrE-Basic", "Journal-Entry-DrE-Advanced", "Journal-Entry-DrE-Basic", "Kafka-Server-Element-DrE-Advanced", "Kafka-Server-Element-DrE-Basic", "License-Type-DrE-Advanced", "License-Type-DrE-Basic", "Like-DrE-Advanced", "Like-DrE-Basic", "Measurement-Specification-DrE-Advanced", "Measurement-Specification-DrE-Basic", "Meeting-DrE-Advanced", "Meeting-DrE-Basic", "Methodology-DrE-Advanced", "Methodology-DrE-Basic", "Namespace-DrE-Advanced", "Namespace-DrE-Basic", "Naming-Standard-Rule-DrE-Advanced", "Naming-Standard-Rule-DrE-Basic", "Naming-Standard-Rule-Set-DrE-Advanced", "Naming-Standard-Rule-Set-DrE-Basic", "Note-DrE-Advanced", "Note-DrE-Basic", "Notification-Type-DrE-Advanced", "Notification-Type-DrE-Basic", "Organization-DrE-Advanced", "Organization-DrE-Basic", "Penetration-Test-Finding-DrE-Advanced", "Penetration-Test-Finding-DrE-Basic", "Person-DrE-Advanced", "Person-DrE-Basic", "Person-Role-DrE-Advanced", "Person-Role-DrE-Basic", "Personal-Project-DrE-Advanced", "Personal-Project-DrE-Basic", "Perspective-DrE-Advanced", "Perspective-DrE-Basic", "Postgres-Database-Element-DrE-Advanced", "Postgres-Database-Element-DrE-Basic", "Postgres-Server-Element-DrE-Advanced", "Postgres-Server-Element-DrE-Basic", "Project-DrE-Advanced", "Project-DrE-Basic", "Question-DrE-Advanced", "Question-DrE-Basic", "Question-Spec-DrE-Advanced", "Question-Spec-DrE-Basic", "Rating-DrE-Advanced", "Rating-DrE-Basic", "Recent-Access-DrE-Advanced", "Recent-Access-DrE-Basic", "Reference-Data-Set-DrE-Advanced", "Reference-Data-Set-DrE-Basic", "Reference-Data-Value-DrE-Advanced", "Reference-Data-Value-DrE-Basic", "Reference-List-DrE-Advanced", "Reference-List-DrE-Basic", "Regulation-Article-DrE-Advanced", "Regulation-Article-DrE-Basic", "Regulation-DrE-Advanced", "Regulation-DrE-Basic", "Related-Media-DrE-Advanced", "Related-Media-DrE-Basic", "Report-DrE-Advanced", "Report-DrE-Basic", "Report-Spec-DrE-Advanced", "Report-Spec-DrE-Basic", "Report-Type-DrE-Advanced", "Report-Type-DrE-Basic", "Results-Set-DrE-Advanced", "Results-Set-DrE-Basic", "Review-DrE-Advanced", "Review-DrE-Basic", "Risk-DrE-Advanced", "Risk-DrE-Basic", "Root-Collection-DrE-Advanced", "Root-Collection-DrE-Basic", "Saved-Query-DrE-Advanced", "Saved-Query-DrE-Basic", "Schema-Attribute-DrE-Advanced", "Schema-Attribute-DrE-Basic", "Schema-Attribute-From-Template-DrE-Advanced", "Schema-Attribute-From-Template-DrE-Basic", "Schema-Type-DrE-Advanced", "Schema-Type-DrE-Basic", "Schema-Type-From-Template-DrE-Advanced", "Schema-Type-From-Template-DrE-Basic", "Secrets-Store-Element-DrE-Advanced", "Secrets-Store-Element-DrE-Basic", "Security-Access-Control-DrE-Advanced", "Security-Access-Control-DrE-Basic", "Security-Finding-DrE-Advanced", "Security-Finding-DrE-Basic", "Security-Group-DrE-Advanced", "Security-Group-DrE-Basic", "Security-List-DrE-Advanced", "Security-List-DrE-Basic", "Security-Posture-Summary-DrE-Advanced", "Security-Posture-Summary-DrE-Basic", "Security-Role-DrE-Advanced", "Security-Role-DrE-Basic", "Service-Level-Objective-DrE-Advanced", "Service-Level-Objective-DrE-Basic", "Skill-DrE-Advanced", "Skill-DrE-Basic", "Skill-Set-DrE-Advanced", "Skill-Set-DrE-Basic", "Software-Archive-DrE-Advanced", "Software-Archive-DrE-Basic", "Solution-Blueprint-DrE-Advanced", "Solution-Blueprint-DrE-Basic", "Solution-Component-DrE-Advanced", "Solution-Component-DrE-Basic", "Solution-Role-DrE-Advanced", "Solution-Role-DrE-Basic", "Statement-of-Applicability-DrE-Advanced", "Statement-of-Applicability-DrE-Basic", "Study-Project-DrE-Advanced", "Study-Project-DrE-Basic", "Subject-Area-DrE-Advanced", "Subject-Area-DrE-Basic", "Subscription-Type-DrE-Advanced", "Subscription-Type-DrE-Basic", "Survey-Report-DrE-Advanced", "Survey-Report-DrE-Basic", "Task-DrE-Advanced", "Task-DrE-Basic", "Team-DrE-Advanced", "Team-DrE-Basic", "Team-Role-DrE-Advanced", "Team-Role-DrE-Basic", "Terms-and-Conditions-DrE-Advanced", "Terms-and-Conditions-DrE-Basic", "Threat-DrE-Advanced", "Threat-DrE-Basic", "ToDo-DrE-Advanced", "ToDo-DrE-Basic", "Type-Def-DrE-Advanced", "Type-Def-DrE-Basic", "UC-Catalog-Element-DrE-Advanced", "UC-Catalog-Element-DrE-Basic", "UC-Function-Element-DrE-Advanced", "UC-Function-Element-DrE-Basic", "UC-Schema-Element-DrE-Advanced", "UC-Schema-Element-DrE-Basic", "UC-Server-Element-DrE-Advanced", "UC-Server-Element-DrE-Basic", "UC-Table-Element-DrE-Advanced", "UC-Table-Element-DrE-Basic", "UC-Volume-Element-DrE-Advanced", "UC-Volume-Element-DrE-Basic", "Vulnerability-Finding-DrE-Advanced", "Vulnerability-Finding-DrE-Basic", "Work-Item-List-DrE-Advanced", "Work-Item-List-DrE-Basic", "Working-Set-DrE-Advanced", "Working-Set-DrE-Basic", "Analytic Demo - Element Count by Type", "Analytic Demo - Assets by Type Breakdown", "Analytic Demo - Ownership Coverage", "Analytic Demo - Business Value Signals", "Analytic Demo - Governance Coverage", "Analytic Demo - Certifications and Exceptions", "Analytic Demo - People and Community", "Analytic Demo - Feedback Summary", "Analytic Demo - Usage Context: Supply Chains & Blueprints", "Analytic Demo - Semantic Grounding", "Analytic Demo - AI Context Readiness", "Analytic Demo - AI-Ready Assets", "Analytic Demo - Catalog Growth Trend", "Analytic Demo - Term Definition Completeness", "Analytic Demo - Active Contributors", "Analytic Demo - Assets by Type Total (Composite)", "Analytic Demo - Count by Property", "Analytic Demo - Contextualised Coverage", "Analytic Demo - Karma Leaderboard", "Analytic Demo - Engagement Over Time", "Analytic Demo - Orphan Glossary Terms", "Analytic Demo - Stale Assets", "Analytic Demo - Metric Trend (Governance Coverage)", "Questions", "Report-Types", "Question-Specs", "DCAT Catalog", "DCAT Catalog (Turtle)"] } diff --git a/sample-data/templates/advanced/MetadataExpert/Classify_Instance.md b/sample-data/templates/advanced/MetadataExpert/Classify_Instance.md new file mode 100644 index 00000000..f1f5a55d --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Classify_Instance.md @@ -0,0 +1,34 @@ +___ + +## Classify Instance +> Add a classification to a metadata element. + +### Metadata Element GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the metadata element. + + +### Classification Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Open metadata type name of the classification. + + +### Classification Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: One property per line as 'name: value' (same typing rules as Instance Properties). + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Count_Metadata_Elements.md b/sample-data/templates/advanced/MetadataExpert/Count_Metadata_Elements.md new file mode 100644 index 00000000..5079dc44 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Count_Metadata_Elements.md @@ -0,0 +1,30 @@ +___ + +## Count Metadata Elements +> Return the number of metadata elements matching the criteria, without retrieving them. + +### Count Element Type Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Only count elements of this metadata element type (and subtypes). + + +### Count Search String +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Only count elements matching this search string. + + +### Count Push Down +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: True: the repository counts rows itself (fast, skips per-element visibility checks). False: the server retrieves and counts matching elements. Omit for the server default. + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Create_Enum_Def.md b/sample-data/templates/advanced/MetadataExpert/Create_Enum_Def.md new file mode 100644 index 00000000..fc6c952c --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Create_Enum_Def.md @@ -0,0 +1,280 @@ +___ + +## Create Enum Def +> Add a new enum definition, usable as an attribute type in type definitions. WARNING: an enum added through the API cannot be removed again (ISSUE-125). + +### Enum Def Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Name of the enum definition. + + +### Enum Values +> **Input Required**: True + +> **Attribute Type**: Dictionary + +> **Description**: One enum value per line as 'value: description'. Ordinals are assigned 0, 1, 2... in line order. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Category +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A user specified category name that can be used for example, to define product types or agreement types. + +> **Alternative Labels**: Category Name + + +### Qualified Name +> **Input Required**: False + +> **Attribute Type**: QN + +> **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified. + + +### Journal Entry +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: + + +### Version Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Published product version identifier. + +> **Alternative Labels**: Version + +> **Default Value**: 1.0 + + +### Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: role identifier + +> **Alternative Labels**: ID + + +### GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: A system generated unique identifier. + +> **Alternative Labels**: Guid; guid + + +### URL +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Link to supporting information + + +### Search Keywords +> **Input Required**: False + +> **Attribute Type**: Simple List + +> **Description**: Keywords to facilitate finding the element + + +### Enum Def Description +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Description of the enum definition. + + +### Enum Default Value +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Which of the Enum Values is the default (defaults to the first). + + +### Status +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: The status of the digital product. There is a list of valid values that this conforms to. + +> **Default Value**: ACTIVE + + +### User Defined Status +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Only valid if Status is set to OTHER. User defined & managed status values. + + +### Classifications +> **Input Required**: false + +> **Attribute Type**: Named DICT + +> **Description**: Optionally specify the initial classifications for a collection. Multiple classifications can be specified. + +> **Alternative Labels**: classification + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Is Own Anchor +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Generally True. + +> **Alternative Labels**: Own Anchor + +> **Default Value**: True + + +### Anchor ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Anchor identity for the collection. Typically a qualified name but if display name is unique then it could be used (not recommended) + + +### Parent ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Unique name of the parent element. + +> **Alternative Labels**: Parent; + + +### Parent Relationship Type Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: The kind of the relationship to the parent element. + + +### Anchor Scope Name +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Optional qualified name of an anchor scope. + + +### Parent at End1 +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Is the parent at end1 of the relationship? + +> **Default Value**: True + + +### Effective Time +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: An ISO-8601 string representing the time to use for evaluating effectivity of the elements related to this one. + + +### Effective From +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element becomes effective (visible). + + +### Effective To +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element is no longer effective (visible). + + +### Merge Update +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: If True, only those attributes specified in the update will be updated; If False, any attributes not provided during the update will be set to None. + +> **Alternative Labels**: Merge + +> **Default Value**: True + + +### Additional Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: Additional user defined values organized as name value pairs in a dictionary. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### External Source GUID +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Identifier of an external source that is associated with this element. + + +### External Source Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Name of an external element that is associated with this element. + + +### Supplementary Properties +> **Input Required**: False + +> **Attribute Type**: Named DICT + +> **Description**: Provide supplementary information to the element using the structure of a glossary term + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Create_Instance.md b/sample-data/templates/advanced/MetadataExpert/Create_Instance.md new file mode 100644 index 00000000..dd558203 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Create_Instance.md @@ -0,0 +1,280 @@ +___ + +## Create Instance +> Create a metadata element (instance) of any open metadata type through the raw metadata-expert API. Not an upsert: every run creates a new element. + +### Instance Type Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Open metadata type name of the instance (element) to create. + + +### Category +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A user specified category name that can be used for example, to define product types or agreement types. + +> **Alternative Labels**: Category Name + + +### Qualified Name +> **Input Required**: False + +> **Attribute Type**: QN + +> **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified. + + +### Journal Entry +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: + + +### Version Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Published product version identifier. + +> **Alternative Labels**: Version + +> **Default Value**: 1.0 + + +### Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: role identifier + +> **Alternative Labels**: ID + + +### GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: A system generated unique identifier. + +> **Alternative Labels**: Guid; guid + + +### URL +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Link to supporting information + + +### Search Keywords +> **Input Required**: False + +> **Attribute Type**: Simple List + +> **Description**: Keywords to facilitate finding the element + + +### Instance Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: One property per line as 'name: value'. true/false become boolean, whole numbers become int, anything else is a string. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Anchor GUID +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: GUID of the element that anchors the new instance. + + +### Is Own Anchor +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: A flag indicating if the element is its own anchor or is anchored to a different element. + +> **Alternative Labels**: Own Anchor + +> **Default Value**: true + + +### Parent GUID +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: GUID of a parent element to link the new instance to. + + +### Parent Relationship Type Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: The type of parent relationship. + + +### Parent at End1 +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: A flag indicating if the parent is at end1 of the relationship + +> **Default Value**: true + + +### Status +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: The status of the digital product. There is a list of valid values that this conforms to. + +> **Default Value**: ACTIVE + + +### User Defined Status +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Only valid if Status is set to OTHER. User defined & managed status values. + + +### Classifications +> **Input Required**: false + +> **Attribute Type**: Named DICT + +> **Description**: Optionally specify the initial classifications for a collection. Multiple classifications can be specified. + +> **Alternative Labels**: classification + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Anchor ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Anchor identity for the collection. Typically a qualified name but if display name is unique then it could be used (not recommended) + + +### Parent ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Unique name of the parent element. + +> **Alternative Labels**: Parent; + + +### Anchor Scope Name +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Optional qualified name of an anchor scope. + + +### Effective Time +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: An ISO-8601 string representing the time to use for evaluating effectivity of the elements related to this one. + + +### Effective From +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element becomes effective (visible). + + +### Effective To +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element is no longer effective (visible). + + +### Merge Update +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: If True, only those attributes specified in the update will be updated; If False, any attributes not provided during the update will be set to None. + +> **Alternative Labels**: Merge + +> **Default Value**: True + + +### Additional Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: Additional user defined values organized as name value pairs in a dictionary. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### External Source GUID +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Identifier of an external source that is associated with this element. + + +### External Source Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Name of an external element that is associated with this element. + + +### Supplementary Properties +> **Input Required**: False + +> **Attribute Type**: Named DICT + +> **Description**: Provide supplementary information to the element using the structure of a glossary term + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Create_Type_Def.md b/sample-data/templates/advanced/MetadataExpert/Create_Type_Def.md new file mode 100644 index 00000000..ea8478e6 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Create_Type_Def.md @@ -0,0 +1,340 @@ +___ + +## Create Type Def +> Add a new open metadata type definition (entity, relationship or classification) to the type system. Not an upsert: types cannot be removed once instances exist. + +### Type Def Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Name of the open metadata type definition (entity, relationship or classification). + + +### Category +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A user specified category name that can be used for example, to define product types or agreement types. + +> **Alternative Labels**: Category Name + + +### Qualified Name +> **Input Required**: False + +> **Attribute Type**: QN + +> **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified. + + +### Journal Entry +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: + + +### Version Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Published product version identifier. + +> **Alternative Labels**: Version + +> **Default Value**: 1.0 + + +### Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: role identifier + +> **Alternative Labels**: ID + + +### GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: A system generated unique identifier. + +> **Alternative Labels**: Guid; guid + + +### URL +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Link to supporting information + + +### Search Keywords +> **Input Required**: False + +> **Attribute Type**: Simple List + +> **Description**: Keywords to facilitate finding the element + + +### Type Def Category +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: Kind of type definition to create. + +> **Valid Values**: Entity,Relationship,Classification + +> **Default Value**: Entity + + +### Super Type +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Name of the supertype (entity and classification definitions). + + +### Type Def Description +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Description of the type definition. + + +### Type Def Attributes +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: One attribute per line as 'attributeName: typeName'. typeName is a primitive type (string, int, long, boolean, date, float, double, short, byte, char, bigint, bigdecimal) or the name of an existing enum definition. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Valid Entity Types +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Classification definitions only: the entity types the classification can be attached to (one per line or comma separated). + + +### Propagatable +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Classification definitions only: whether the classification propagates. + + +### End1 Entity Type +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Relationship definitions only: entity type at end 1. + + +### End1 Attribute Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Relationship definitions only: name the relationship has at end 1. + + +### End2 Entity Type +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Relationship definitions only: entity type at end 2. + + +### End2 Attribute Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Relationship definitions only: name the relationship has at end 2. + + +### Status +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: The status of the digital product. There is a list of valid values that this conforms to. + +> **Default Value**: ACTIVE + + +### User Defined Status +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Only valid if Status is set to OTHER. User defined & managed status values. + + +### Classifications +> **Input Required**: false + +> **Attribute Type**: Named DICT + +> **Description**: Optionally specify the initial classifications for a collection. Multiple classifications can be specified. + +> **Alternative Labels**: classification + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Is Own Anchor +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Generally True. + +> **Alternative Labels**: Own Anchor + +> **Default Value**: True + + +### Anchor ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Anchor identity for the collection. Typically a qualified name but if display name is unique then it could be used (not recommended) + + +### Parent ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Unique name of the parent element. + +> **Alternative Labels**: Parent; + + +### Parent Relationship Type Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: The kind of the relationship to the parent element. + + +### Anchor Scope Name +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Optional qualified name of an anchor scope. + + +### Parent at End1 +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Is the parent at end1 of the relationship? + +> **Default Value**: True + + +### Effective Time +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: An ISO-8601 string representing the time to use for evaluating effectivity of the elements related to this one. + + +### Effective From +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element becomes effective (visible). + + +### Effective To +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element is no longer effective (visible). + + +### Merge Update +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: If True, only those attributes specified in the update will be updated; If False, any attributes not provided during the update will be set to None. + +> **Alternative Labels**: Merge + +> **Default Value**: True + + +### Additional Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: Additional user defined values organized as name value pairs in a dictionary. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### External Source GUID +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Identifier of an external source that is associated with this element. + + +### External Source Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Name of an external element that is associated with this element. + + +### Supplementary Properties +> **Input Required**: False + +> **Attribute Type**: Named DICT + +> **Description**: Provide supplementary information to the element using the structure of a glossary term + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Declassify_Instance.md b/sample-data/templates/advanced/MetadataExpert/Declassify_Instance.md new file mode 100644 index 00000000..750a393f --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Declassify_Instance.md @@ -0,0 +1,22 @@ +___ + +## Declassify Instance +> Remove a classification from a metadata element. + +### Metadata Element GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the metadata element. + + +### Classification Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Open metadata type name of the classification. + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Delete_Enum_Def.md b/sample-data/templates/advanced/MetadataExpert/Delete_Enum_Def.md new file mode 100644 index 00000000..ce9b3602 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Delete_Enum_Def.md @@ -0,0 +1,22 @@ +___ + +## Delete Enum Def +> Delete an enum definition. WARNING: currently fails on Egeria with a 500 'unknown TypeDef' (ISSUE-125). + +### Enum Def Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Name of the enum definition. + + +### Enum Def GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: GUID of the enum definition. If omitted, it is looked up from the Enum Def Name. + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Delete_Instance.md b/sample-data/templates/advanced/MetadataExpert/Delete_Instance.md new file mode 100644 index 00000000..33bf8c12 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Delete_Instance.md @@ -0,0 +1,26 @@ +___ + +## Delete Instance +> Delete a metadata element (instance). + +### Metadata Element GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the metadata element. + + +### Delete Method +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: How to delete. + +> **Valid Values**: SOFT_DELETE,PURGE,ARCHIVE,LOOK_FOR_LINEAGE + +> **Default Value**: SOFT_DELETE + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Delete_Type_Def.md b/sample-data/templates/advanced/MetadataExpert/Delete_Type_Def.md new file mode 100644 index 00000000..96e7ff04 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Delete_Type_Def.md @@ -0,0 +1,22 @@ +___ + +## Delete Type Def +> Delete a type definition that was added through the API. Fails while instances of the type exist or another type refers to it. + +### Type Def Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Name of the open metadata type definition (entity, relationship or classification). + + +### Type Def GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: GUID of the type definition. If omitted, it is looked up from the Type Def Name. + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Link_Instances.md b/sample-data/templates/advanced/MetadataExpert/Link_Instances.md new file mode 100644 index 00000000..15b70b31 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Link_Instances.md @@ -0,0 +1,66 @@ +___ + +## Link Instances +> Create a relationship between two metadata elements. Not deduplicated: running it twice may create two relationships. + +### Relationship Type Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Open metadata type name of the relationship to create. + + +### Element 1 GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the element at end 1 of the relationship. + + +### Element 2 GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the element at end 2 of the relationship. + + +### Relationship Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: One property per line as 'name: value' (same typing rules as Instance Properties). + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Effective Time +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: An ISO-8601 string representing the time to use for evaluating effectivity of the elements related to this one. + + +### Effective From +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element becomes effective (visible). + + +### Effective To +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element is no longer effective (visible). + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Publish_Metadata_Element.md b/sample-data/templates/advanced/MetadataExpert/Publish_Metadata_Element.md new file mode 100644 index 00000000..bb71bd62 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Publish_Metadata_Element.md @@ -0,0 +1,14 @@ +___ + +## Publish Metadata Element +> Increase the visibility of a metadata element by updating its zone membership. + +### Metadata Element GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the metadata element. + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Reclassify_Instance.md b/sample-data/templates/advanced/MetadataExpert/Reclassify_Instance.md new file mode 100644 index 00000000..7cf680b8 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Reclassify_Instance.md @@ -0,0 +1,42 @@ +___ + +## Reclassify Instance +> Change the properties of a classification already on a metadata element. + +### Metadata Element GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the metadata element. + + +### Classification Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Open metadata type name of the classification. + + +### Classification Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: One property per line as 'name: value' (same typing rules as Instance Properties). + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Replace Properties +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: True: the supplied properties replace all existing ones. False (default): they are merged. + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Unlink_Instances.md b/sample-data/templates/advanced/MetadataExpert/Unlink_Instances.md new file mode 100644 index 00000000..b6681262 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Unlink_Instances.md @@ -0,0 +1,50 @@ +___ + +## Unlink Instances +> Delete a relationship between two metadata elements. + +### Relationship GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the relationship. + + +### Delete Method +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: How to delete. + +> **Valid Values**: SOFT_DELETE,PURGE,ARCHIVE,LOOK_FOR_LINEAGE + +> **Default Value**: SOFT_DELETE + + +### Effective Time +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: An ISO-8601 string representing the time to use for evaluating effectivity of the elements related to this one. + + +### Effective From +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element becomes effective (visible). + + +### Effective To +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element is no longer effective (visible). + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Update_Instance.md b/sample-data/templates/advanced/MetadataExpert/Update_Instance.md new file mode 100644 index 00000000..c60f2a5f --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Update_Instance.md @@ -0,0 +1,272 @@ +___ + +## Update Instance +> Update the properties of a metadata element (instance). + +### Metadata Element GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the metadata element. + + +### Category +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A user specified category name that can be used for example, to define product types or agreement types. + +> **Alternative Labels**: Category Name + + +### Qualified Name +> **Input Required**: False + +> **Attribute Type**: QN + +> **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified. + + +### Journal Entry +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: + + +### Version Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Published product version identifier. + +> **Alternative Labels**: Version + +> **Default Value**: 1.0 + + +### Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: role identifier + +> **Alternative Labels**: ID + + +### GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: A system generated unique identifier. + +> **Alternative Labels**: Guid; guid + + +### URL +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Link to supporting information + + +### Search Keywords +> **Input Required**: False + +> **Attribute Type**: Simple List + +> **Description**: Keywords to facilitate finding the element + + +### Instance Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: One property per line as 'name: value'. true/false become boolean, whole numbers become int, anything else is a string. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Replace Properties +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: True: the supplied properties replace all existing ones. False (default): they are merged. + + +### Status +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: The status of the digital product. There is a list of valid values that this conforms to. + +> **Default Value**: ACTIVE + + +### User Defined Status +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Only valid if Status is set to OTHER. User defined & managed status values. + + +### Classifications +> **Input Required**: false + +> **Attribute Type**: Named DICT + +> **Description**: Optionally specify the initial classifications for a collection. Multiple classifications can be specified. + +> **Alternative Labels**: classification + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Is Own Anchor +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Generally True. + +> **Alternative Labels**: Own Anchor + +> **Default Value**: True + + +### Anchor ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Anchor identity for the collection. Typically a qualified name but if display name is unique then it could be used (not recommended) + + +### Parent ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Unique name of the parent element. + +> **Alternative Labels**: Parent; + + +### Parent Relationship Type Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: The kind of the relationship to the parent element. + + +### Anchor Scope Name +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Optional qualified name of an anchor scope. + + +### Parent at End1 +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Is the parent at end1 of the relationship? + +> **Default Value**: True + + +### Effective Time +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: An ISO-8601 string representing the time to use for evaluating effectivity of the elements related to this one. + + +### Effective From +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element becomes effective (visible). + + +### Effective To +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element is no longer effective (visible). + + +### Merge Update +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: If True, only those attributes specified in the update will be updated; If False, any attributes not provided during the update will be set to None. + +> **Alternative Labels**: Merge + +> **Default Value**: True + + +### Additional Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: Additional user defined values organized as name value pairs in a dictionary. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### External Source GUID +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Identifier of an external source that is associated with this element. + + +### External Source Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Name of an external element that is associated with this element. + + +### Supplementary Properties +> **Input Required**: False + +> **Attribute Type**: Named DICT + +> **Description**: Provide supplementary information to the element using the structure of a glossary term + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Update_Relationship.md b/sample-data/templates/advanced/MetadataExpert/Update_Relationship.md new file mode 100644 index 00000000..2bad5f6f --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Update_Relationship.md @@ -0,0 +1,272 @@ +___ + +## Update Relationship +> Update the properties of a relationship. + +### Relationship GUID +> **Input Required**: True + +> **Attribute Type**: GUID + +> **Description**: GUID of the relationship. + + +### Category +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A user specified category name that can be used for example, to define product types or agreement types. + +> **Alternative Labels**: Category Name + + +### Qualified Name +> **Input Required**: False + +> **Attribute Type**: QN + +> **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified. + + +### Journal Entry +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: + + +### Version Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Published product version identifier. + +> **Alternative Labels**: Version + +> **Default Value**: 1.0 + + +### Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: role identifier + +> **Alternative Labels**: ID + + +### GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: A system generated unique identifier. + +> **Alternative Labels**: Guid; guid + + +### URL +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Link to supporting information + + +### Search Keywords +> **Input Required**: False + +> **Attribute Type**: Simple List + +> **Description**: Keywords to facilitate finding the element + + +### Relationship Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: One property per line as 'name: value' (same typing rules as Instance Properties). + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Replace Properties +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: True: the supplied properties replace all existing ones. False (default): they are merged. + + +### Status +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: The status of the digital product. There is a list of valid values that this conforms to. + +> **Default Value**: ACTIVE + + +### User Defined Status +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Only valid if Status is set to OTHER. User defined & managed status values. + + +### Classifications +> **Input Required**: false + +> **Attribute Type**: Named DICT + +> **Description**: Optionally specify the initial classifications for a collection. Multiple classifications can be specified. + +> **Alternative Labels**: classification + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Is Own Anchor +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Generally True. + +> **Alternative Labels**: Own Anchor + +> **Default Value**: True + + +### Anchor ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Anchor identity for the collection. Typically a qualified name but if display name is unique then it could be used (not recommended) + + +### Parent ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Unique name of the parent element. + +> **Alternative Labels**: Parent; + + +### Parent Relationship Type Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: The kind of the relationship to the parent element. + + +### Anchor Scope Name +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Optional qualified name of an anchor scope. + + +### Parent at End1 +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Is the parent at end1 of the relationship? + +> **Default Value**: True + + +### Effective Time +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: An ISO-8601 string representing the time to use for evaluating effectivity of the elements related to this one. + + +### Effective From +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element becomes effective (visible). + + +### Effective To +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element is no longer effective (visible). + + +### Merge Update +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: If True, only those attributes specified in the update will be updated; If False, any attributes not provided during the update will be set to None. + +> **Alternative Labels**: Merge + +> **Default Value**: True + + +### Additional Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: Additional user defined values organized as name value pairs in a dictionary. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### External Source GUID +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Identifier of an external source that is associated with this element. + + +### External Source Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Name of an external element that is associated with this element. + + +### Supplementary Properties +> **Input Required**: False + +> **Attribute Type**: Named DICT + +> **Description**: Provide supplementary information to the element using the structure of a glossary term + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +___ diff --git a/sample-data/templates/advanced/MetadataExpert/Update_Type_Def.md b/sample-data/templates/advanced/MetadataExpert/Update_Type_Def.md new file mode 100644 index 00000000..b76420a1 --- /dev/null +++ b/sample-data/templates/advanced/MetadataExpert/Update_Type_Def.md @@ -0,0 +1,288 @@ +___ + +## Update Type Def +> Patch a type definition that was added through the API. WARNING: Egeria currently rejects every patch (OMRS-REPOSITORY-400-069, ISSUE-124). + +### Type Def Name +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: Name of the open metadata type definition (entity, relationship or classification). + + +### Apply To Version +> **Input Required**: True + +> **Attribute Type**: Simple + +> **Description**: The version of the type definition this update applies to. + + +### Category +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A user specified category name that can be used for example, to define product types or agreement types. + +> **Alternative Labels**: Category Name + + +### Qualified Name +> **Input Required**: False + +> **Attribute Type**: QN + +> **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified. + + +### Journal Entry +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: + + +### Version Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Published product version identifier. + +> **Alternative Labels**: Version + +> **Default Value**: 1.0 + + +### Identifier +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: role identifier + +> **Alternative Labels**: ID + + +### GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: A system generated unique identifier. + +> **Alternative Labels**: Guid; guid + + +### URL +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Link to supporting information + + +### Search Keywords +> **Input Required**: False + +> **Attribute Type**: Simple List + +> **Description**: Keywords to facilitate finding the element + + +### Type Def GUID +> **Input Required**: False + +> **Attribute Type**: GUID + +> **Description**: GUID of the type definition. If omitted, it is looked up from the Type Def Name. + + +### Type Def Description +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Description of the type definition. + + +### Type Def Attributes +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: One attribute per line as 'attributeName: typeName'. typeName is a primitive type (string, int, long, boolean, date, float, double, short, byte, char, bigint, bigdecimal) or the name of an existing enum definition. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Status +> **Input Required**: False + +> **Attribute Type**: Valid Value + +> **Description**: The status of the digital product. There is a list of valid values that this conforms to. + +> **Default Value**: ACTIVE + + +### User Defined Status +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Only valid if Status is set to OTHER. User defined & managed status values. + + +### Classifications +> **Input Required**: false + +> **Attribute Type**: Named DICT + +> **Description**: Optionally specify the initial classifications for a collection. Multiple classifications can be specified. + +> **Alternative Labels**: classification + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### Is Own Anchor +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Generally True. + +> **Alternative Labels**: Own Anchor + +> **Default Value**: True + + +### Anchor ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Anchor identity for the collection. Typically a qualified name but if display name is unique then it could be used (not recommended) + + +### Parent ID +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Unique name of the parent element. + +> **Alternative Labels**: Parent; + + +### Parent Relationship Type Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: The kind of the relationship to the parent element. + + +### Anchor Scope Name +> **Input Required**: False + +> **Attribute Type**: Reference Name + +> **Description**: Optional qualified name of an anchor scope. + + +### Parent at End1 +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: Is the parent at end1 of the relationship? + +> **Default Value**: True + + +### Effective Time +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: An ISO-8601 string representing the time to use for evaluating effectivity of the elements related to this one. + + +### Effective From +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element becomes effective (visible). + + +### Effective To +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: A string in ISO-8601 format that defines the when an element is no longer effective (visible). + + +### Merge Update +> **Input Required**: False + +> **Attribute Type**: Bool + +> **Description**: If True, only those attributes specified in the update will be updated; If False, any attributes not provided during the update will be set to None. + +> **Alternative Labels**: Merge + +> **Default Value**: True + + +### Additional Properties +> **Input Required**: False + +> **Attribute Type**: Dictionary + +> **Description**: Additional user defined values organized as name value pairs in a dictionary. + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +### External Source GUID +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Identifier of an external source that is associated with this element. + + +### External Source Name +> **Input Required**: False + +> **Attribute Type**: Simple + +> **Description**: Name of an external element that is associated with this element. + + +### Supplementary Properties +> **Input Required**: False + +> **Attribute Type**: Named DICT + +> **Description**: Provide supplementary information to the element using the structure of a glossary term + +> | Parameter Name | Parameter Value | +> |---|---| +> | example_key | example_value | + + +___ diff --git a/tests/micro-tests/test_metadata_expert_processors.py b/tests/micro-tests/test_metadata_expert_processors.py new file mode 100644 index 00000000..9a2cf0a3 --- /dev/null +++ b/tests/micro-tests/test_metadata_expert_processors.py @@ -0,0 +1,88 @@ +"""Body builders for the MetadataExpert Dr.Egeria family (no live server).""" +import pytest + +from pyegeria import PyegeriaException +from md_processing.v2.metadata_expert import enum_def_body, type_def_body +from md_processing.v2.extraction import STANDARD_VERBS + +pytestmark = pytest.mark.unit + + +def attrs(**kw): + return {k.replace("_", " "): {"value": v} for k, v in kw.items()} + + +def test_entity_def_body(): + body = type_def_body({ + "Type Def Name": {"value": "Recipe"}, "Super Type": {"value": "Referenceable"}, + "Type Def Attributes": {"value": {"servings": "int", "cuisine": "CuisineType"}}}) + assert body["class"] == "OpenMetadataEntityDef" and body["superType"] == {"name": "Referenceable"} + types = {a["attributeName"]: a["attributeType"] for a in body["attributeDefinitions"]} + assert types["servings"] == {"class": "OpenMetadataPrimitiveDef", "name": "int"} + assert types["cuisine"] == {"class": "OpenMetadataEnumDef", "name": "CuisineType"} + + +def test_classification_def_body(): + body = type_def_body({ + "Type Def Name": {"value": "Vegan"}, "Type Def Category": {"value": "Classification"}, + "Valid Entity Types": {"value": "Recipe, Dish"}, "Propagatable": {"value": "true"}}) + assert body["class"] == "OpenMetadataClassificationDef" + assert body["validEntityDefs"] == [{"name": "Recipe"}, {"name": "Dish"}] and body["propagatable"] is True + + +def test_relationship_def_needs_both_ends(): + base = {"Type Def Name": {"value": "Uses"}, "Type Def Category": {"value": "Relationship"}, + "End1 Entity Type": {"value": "Recipe"}, "End1 Attribute Name": {"value": "usedBy"}} + with pytest.raises(PyegeriaException): + type_def_body(base) + body = type_def_body({**base, "End2 Entity Type": {"value": "Ingredient"}, "End2 Attribute Name": {"value": "uses"}}) + assert body["endDef2"] == {"entityType": {"name": "Ingredient"}, "attributeName": "uses"} + + +def test_enum_def_body_ordinals_and_default(): + body = enum_def_body({"Enum Def Name": {"value": "Cuisine"}, + "Enum Values": {"value": {"Unknown": "not recorded", "Other": "elsewhere"}}, + "Enum Default Value": {"value": "Other"}}) + assert [e["ordinal"] for e in body["elementDefs"]] == [0, 1] + assert body["defaultValue"]["value"] == "Other" + with pytest.raises(PyegeriaException): + enum_def_body({"Enum Def Name": {"value": "X"}, "Enum Values": {"value": {"a": ""}}, + "Enum Default Value": {"value": "zzz"}}) + + +def test_count_is_a_recognised_verb(): + assert "Count" in STANDARD_VERBS + + +from md_processing.v2.metadata_expert import (element_properties, new_instance_body, related_elements_body, + update_properties_body) + + +def test_property_types_are_inferred(): + pm = element_properties({"a": "true", "b": "42", "c": "hello"}, "EntityElementProperties") + assert pm["class"] == "EntityElementProperties" + assert pm["propertyValueMap"]["a"]["typeName"] == "boolean" and pm["propertyValueMap"]["a"]["primitiveValue"] is True + assert pm["propertyValueMap"]["b"]["primitiveValue"] == 42 + assert pm["propertyValueMap"]["c"]["typeName"] == "string" + assert element_properties({}, "EntityElementProperties") is None + + +def test_new_instance_body_parent_needs_relationship_type(): + base = {"Instance Type Name": {"value": "GlossaryTerm"}, + "Instance Properties": {"value": {"qualifiedName": "T::1"}}, "Parent GUID": {"value": "g1"}} + with pytest.raises(PyegeriaException): + new_instance_body(base) + body = new_instance_body({**base, "Parent Relationship Type Name": {"value": "CollectionMembership"}}) + assert body["parentGUID"] == "g1" and body["parentAtEnd1"] is True and body["typeName"] == "GlossaryTerm" + + +def test_related_and_update_bodies(): + body = related_elements_body({"Relationship Type Name": {"value": "SemanticAssignment"}, + "Element 1 GUID": {"value": "a"}, "Element 2 GUID": {"value": "b"}}) + assert body["metadataElement1GUID"] == "a" and "properties" not in body + with pytest.raises(PyegeriaException): + related_elements_body({"Relationship Type Name": {"value": "X"}, "Element 1 GUID": {"value": "a"}}) + upd = update_properties_body({"k": "v"}, "RelationshipElementProperties", {"Replace Properties": {"value": "true"}}) + assert upd["replaceProperties"] is True + with pytest.raises(PyegeriaException): + update_properties_body({}, "EntityElementProperties", {}) From 6e24c0fcd29f08a07a2b70d95560413e28457883 Mon Sep 17 00:00:00 2001 From: Dan Wolfson Date: Thu, 12 Nov 2026 20:17:35 -0600 Subject: [PATCH 05/19] pyegeria.authoring: the authoring API, phase 1 (specs, Reports, sheets) One typed authoring path for report specs, Reports and dashboard sheets (BRIEF-PYEGERIA-AUTHORING-API-PHASE1-2026-11-13), grown from report_spec_publish (Stage 1a). It never authenticates: every Egeria read uses the caller's client, every write the caller's runner, as the user. - models: SpecDraft / ReportDraft / SheetDraft (Draft union by kind), ValidationResult, Diff, AuthoringGates. - drafts: new_draft, new_from (prototype or template, derived_from recorded), DraftStore with EgeriaDraftStore (D16: the element itself, zoned private to the author, written as the author, prune_drafts(30) as the author, promotion clears the zone; zone name a parameter) and LocalDraftStore (tests, offline). - serialize: deterministic Dr.Egeria markdown; never a Parent ID; spec rows shared with build_publish_document; every Report parameter explicit. - validate: structural, semantic (target type and column attributes from the Properties-class catalog, load-time spec resolution, parameter names and types, placements resolve as the user), then Dr.Egeria validate via a runner. Never raises; says what it did not check. - preview: runs the draft's own FormatSet as the caller via the executor's run dict, never registered; capped and said; sheets resolved without fetching. - diff: breaking = removed column/placement, changed parameter type, changed target type (and a changed analytic routine). - lifecycle: load_held, history, publish_plan / withdraw_plan for all three kinds (consumer folders checked; restricted publish and built-ins refused in words), apply (run_document: confirm + digest). - versions (D14): a pinned spec version resolved as the user from the spec element's history, never through the fetched-name map. - D7: reportParameters and the camelCase copy are both written (switch kept, PYEGERIA_REPORT_CAMEL_PARAMS, default both). - runner: in-process Dr.Egeria runner as the client's user. - mcp_tools: authoring_* tools registered on pyegeria's MCP server; authoring_apply needs confirmed + digest + an as-user credential and refuses the server's service account. Tests: 59 new (CDO map round trip, Stage 1a golden, catalog-health sheet read-back replayed from a scratch capture, D7 consistency, D14, D16, MCP refusals, no Parent ID, preview side effects). Signed-off-by: Dan Wolfson --- md_processing/v2/report.py | 5 + pyegeria/authoring/__init__.py | 41 + pyegeria/authoring/diff.py | 100 + pyegeria/authoring/drafts.py | 400 + pyegeria/authoring/lifecycle.py | 352 + pyegeria/authoring/mcp_tools.py | 235 + pyegeria/authoring/models.py | 221 + pyegeria/authoring/preview.py | 170 + pyegeria/authoring/runner.py | 51 + pyegeria/authoring/serialize.py | 236 + pyegeria/authoring/validate.py | 298 + pyegeria/authoring/versions.py | 78 + pyegeria/core/mcp_server.py | 5 + pyegeria/view/report_spec_publish.py | 36 +- .../authoring/catalog_health_scratch.json | 7228 +++++++++++++++++ tests/micro-tests/test_authoring_api.py | 694 ++ .../test_authoring_held_fixture.py | 105 + 17 files changed, 10243 insertions(+), 12 deletions(-) create mode 100644 pyegeria/authoring/__init__.py create mode 100644 pyegeria/authoring/diff.py create mode 100644 pyegeria/authoring/drafts.py create mode 100644 pyegeria/authoring/lifecycle.py create mode 100644 pyegeria/authoring/mcp_tools.py create mode 100644 pyegeria/authoring/models.py create mode 100644 pyegeria/authoring/preview.py create mode 100644 pyegeria/authoring/runner.py create mode 100644 pyegeria/authoring/serialize.py create mode 100644 pyegeria/authoring/validate.py create mode 100644 pyegeria/authoring/versions.py create mode 100644 tests/micro-tests/data/authoring/catalog_health_scratch.json create mode 100644 tests/micro-tests/test_authoring_api.py create mode 100644 tests/micro-tests/test_authoring_held_fixture.py diff --git a/md_processing/v2/report.py b/md_processing/v2/report.py index 7160e6a4..9cc4463d 100644 --- a/md_processing/v2/report.py +++ b/md_processing/v2/report.py @@ -173,6 +173,11 @@ def _report_additional_properties(attributes: Dict[str, Any]) -> Dict[str, str]: user_extra = attributes.get("Additional Properties", {}).get("value") if isinstance(user_extra, dict): merged.update({str(k): str(v) for k, v in user_extra.items() if v is not None}) + from pyegeria.authoring.models import camel_copy_env + if not camel_copy_env(): + # D7 switch (PYEGERIA_REPORT_CAMEL_PARAMS=0): the parameters live only in the typed reportParameters + # document; additionalProperties keeps the author's own keys. + return merged # Arbitrary report-spec-specific params (e.g. {"collection_guid": "..."} # for the "Collection Members" report) that aren't part of the standard diff --git a/pyegeria/authoring/__init__.py b/pyegeria/authoring/__init__.py new file mode 100644 index 00000000..bc3866c6 --- /dev/null +++ b/pyegeria/authoring/__init__.py @@ -0,0 +1,41 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the ODPi Egeria project. +"""pyegeria.authoring: one typed authoring path for report specs, Reports and dashboard sheets (phase 1). + +Grown from `pyegeria.view.report_spec_publish` (Stage 1a). Dr.Egeria markdown stays the serialization: +the API writes and checks it, so authors don't have to. It never authenticates: the caller passes a +client signed in as the user, and a runner that runs documents as the user. + + draft = new_draft("report", display_name=..., spec=..., parameters={...}) + validate(draft, client) # structural, semantic, Dr.Egeria (with run=) + preview(draft, client=client) # a capped sample, run as the user; nothing registered + diff(old, new) # breaking changes flagged + plan = publish_plan(draft, folders=[...]) + apply(plan, step="process", run=run, confirmed=True, digest=plan["digest"]) + +The undecided gates (D7, D14, D16, D4) are switches: see `AuthoringGates`. +""" +from pyegeria.authoring.diff import diff +from pyegeria.authoring.drafts import ( + TEMPLATES, DraftStore, EgeriaDraftStore, LocalDraftStore, async_new_from, draft_store, new_draft, new_from, +) +from pyegeria.authoring.lifecycle import ( + KNOWN_CONSUMERS, apply, async_history, async_load_held, history, load_held, publish_plan, withdraw_plan, +) +from pyegeria.authoring.models import ( + AuthoringGates, AuthoringRefused, Change, Diff, Draft, ReportDraft, SheetDraft, SheetPlacement, SpecDraft, + ValidationResult, as_draft, default_gates, +) +from pyegeria.authoring.preview import async_preview, preview +from pyegeria.authoring.runner import inprocess_runner +from pyegeria.authoring.serialize import has_parent_id, report_parameter_maps, serialize +from pyegeria.authoring.validate import async_validate, validate + +__all__ = [ + "AuthoringGates", "AuthoringRefused", "Change", "Diff", "Draft", "DraftStore", "EgeriaDraftStore", + "KNOWN_CONSUMERS", "LocalDraftStore", "ReportDraft", "SheetDraft", "SheetPlacement", "SpecDraft", "TEMPLATES", + "ValidationResult", "apply", "as_draft", "async_history", "async_load_held", "async_new_from", "async_preview", + "async_validate", "default_gates", "diff", "draft_store", "has_parent_id", "history", "inprocess_runner", + "load_held", "new_draft", "new_from", "preview", "publish_plan", "report_parameter_maps", "serialize", + "validate", "withdraw_plan", +] diff --git a/pyegeria/authoring/diff.py b/pyegeria/authoring/diff.py new file mode 100644 index 00000000..0f2462f2 --- /dev/null +++ b/pyegeria/authoring/diff.py @@ -0,0 +1,100 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the ODPi Egeria project. +"""diff(a, b): a structured comparison of two drafts of the same kind. + +Areas: field, column, parameter, analytic parameter, placement. **Breaking** (needs confirming before a +promote, design note §1d): a removed column or placement, a changed parameter type, a changed target type. +A changed analytic routine is flagged breaking too: everything that reads the spec's columns depends on it. +""" +from __future__ import annotations + +from typing import Any, Dict, List, Tuple + +from pyegeria.authoring.models import AuthoringRefused, Change, Diff, ReportDraft, SheetDraft, SpecDraft, as_draft + + +def _fields(diff: Diff, a: Any, b: Any, names: List[str], breaking: Tuple[str, ...] = ()) -> None: + for name in names: + before, after = getattr(a, name, None), getattr(b, name, None) + if before != after: + diff.changes.append(Change(area="field", name=name, change="changed", before=before, after=after, + breaking=name in breaking, + why="the elements it runs over change" if name in breaking else None)) + + +def _columns(fs) -> Dict[str, Dict[str, Any]]: + """{key: {"name", "formats": [...], ...}} across every format row.""" + out: Dict[str, Dict[str, Any]] = {} + for fmt in fs.formats or []: + types = list(getattr(fmt, "types", None) or []) + for col in getattr(fmt, "attributes", None) or []: + data = col if isinstance(col, dict) else col.model_dump(exclude_none=True) + key = data.get("key") + if not key: + continue + entry = out.setdefault(key, {**{k: v for k, v in data.items() if k != "key"}, "formats": []}) + entry["formats"] = sorted(set(entry["formats"]) | set(types)) + return out + + +def _keyed(diff: Diff, area: str, before: Dict[str, Any], after: Dict[str, Any], *, removed_breaks: bool, + type_breaks: bool = False) -> None: + for key in sorted(set(before) | set(after)): + if key not in after: + diff.changes.append(Change(area=area, name=key, change="removed", before=before[key], + breaking=removed_breaks, + why=f"anything that reads this {area} loses it" if removed_breaks else None)) + elif key not in before: + diff.changes.append(Change(area=area, name=key, change="added", after=after[key])) + elif before[key] != after[key]: + typed = type_breaks and type(before[key]) is not type(after[key]) + diff.changes.append(Change(area=area, name=key, change="changed", before=before[key], after=after[key], + breaking=typed, + why=f"its type changed ({type(before[key]).__name__} -> " + f"{type(after[key]).__name__})" if typed else None)) + + +def _action(fs) -> Dict[str, Any]: + action = fs.action + if action is None: + return {} + return action if isinstance(action, dict) else action.model_dump(exclude_none=True) + + +def diff(a: Any, b: Any) -> Diff: + a, b = as_draft(a), as_draft(b) + if a.kind != b.kind: + raise AuthoringRefused(f"Two drafts of the same kind are compared, not a {a.kind} and a {b.kind}.") + d = Diff() + if isinstance(a, SpecDraft): + _fields(d, a, b, ["label", "qualified_name"]) + _fields(d, a.format_set, b.format_set, ["target_type", "heading", "description", "family", "aliases"], + breaking=("target_type",)) + _keyed(d, "column", _columns(a.format_set), _columns(b.format_set), removed_breaks=True) + act_a, act_b = _action(a.format_set), _action(b.format_set) + for name in ("function", "analytic_function"): + if act_a.get(name) != act_b.get(name): + routine = name == "analytic_function" + d.changes.append(Change(area="field", name=f"action.{name}", change="changed", before=act_a.get(name), + after=act_b.get(name), breaking=routine, + why="a different routine produces different columns" if routine else None)) + params_a = {p: "required" for p in act_a.get("required_params") or []} + params_a.update({p: "optional" for p in act_a.get("optional_params") or []}) + params_b = {p: "required" for p in act_b.get("required_params") or []} + params_b.update({p: "optional" for p in act_b.get("optional_params") or []}) + _keyed(d, "parameter", params_a, params_b, removed_breaks=False) + return d + if isinstance(a, ReportDraft): + _fields(d, a, b, ["display_name", "qualified_name", "description", "spec", "output_format", "pinned_version"]) + _keyed(d, "parameter", a.parameters, b.parameters, removed_breaks=False, type_breaks=True) + _keyed(d, "analytic parameter", a.analytic_params, b.analytic_params, removed_breaks=False, type_breaks=True) + return d + _fields(d, a, b, ["name", "heading", "description", "family", "perspectives"]) + pa = {p.name: p.model_dump(exclude={"name"}) for p in a.placements} + pb = {p.name: p.model_dump(exclude={"name"}) for p in b.placements} + _keyed(d, "placement", pa, pb, removed_breaks=True) + order_a = [p.name for p in a.placements if p.name in pb] + order_b = [p.name for p in b.placements if p.name in pa] + if order_a != order_b: + d.changes.append(Change(area="placement", name="(order)", change="changed", before=order_a, after=order_b)) + return d diff --git a/pyegeria/authoring/drafts.py b/pyegeria/authoring/drafts.py new file mode 100644 index 00000000..ffaf00df --- /dev/null +++ b/pyegeria/authoring/drafts.py @@ -0,0 +1,400 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the ODPi Egeria project. +"""Making drafts, and keeping them (D16). + +- `new_draft(kind, **fields)`: a new draft of a kind. +- `new_from(prototype=(kind, label) | template=name, new_label=...)`: a copy of an existing artifact (or a + template), renamed, with `derived_from` recorded. A spec prototype is read from pyegeria's registry (read + only, nothing registered); a held Report or sheet is read from Egeria as the caller (`client`). +- `DraftStore`: where drafts are kept (D16, decided: Egeria, private, 30-day prune). `EgeriaDraftStore`, the + default for apps, keeps the draft as the element itself in the author's private zone; `LocalDraftStore` + (a directory per user, given by the caller) is for tests and offline use. +""" +from __future__ import annotations + +import copy +import json +import os +import re +from pathlib import Path +from typing import Any, Dict, List, Optional, Protocol, Tuple, Union + +from pyegeria.authoring.models import ( + KINDS, AuthoringRefused, ReportDraft, SheetDraft, SheetPlacement, SpecDraft, as_draft, draft_key, +) +from pyegeria.view._output_format_models import Column, Format, FormatSet + +AnyDraft = Union[SpecDraft, ReportDraft, SheetDraft] + + +def new_draft(kind: str, **fields: Any) -> AnyDraft: + """A new draft of `kind` ("spec", "report" or "sheet") from its fields. A spec takes `label` and + `format_set` (a FormatSet or its dict).""" + if kind not in KINDS: + raise AuthoringRefused(f"A draft is one of {', '.join(KINDS)}, not {kind!r}.") + return as_draft({"kind": kind, **fields}) + + +# ── Templates (the built-in tier: blanks with guidance) ────────────────────── + +def _template_spec(label: str) -> SpecDraft: + fs = FormatSet(target_type="Referenceable", heading=label, description="Describe what this report answers.", + formats=[Format(types=["ALL"], attributes=[ + Column(name="Display Name", key="display_name"), + Column(name="Qualified Name", key="qualified_name"), + Column(name="Description", key="description")])], + action={"function": "ClassificationExplorer.find_elements_by_property_value", + "required_params": ["search_string"], "optional_params": ["page_size"], + "spec_params": {}}) + return SpecDraft(label=label, format_set=fs) + + +TEMPLATES: Dict[str, Tuple[str, Any]] = { + "find-spec": ("spec", _template_spec), + "report": ("report", lambda label: ReportDraft(display_name=label, spec="Referenceable", output_format="TABLE", + parameters={"search_string": "*", "page_size": 25})), + "sheet": ("sheet", lambda label: SheetDraft(name=label, heading=label, placements=[ + SheetPlacement(text="**What this sheet shows**\n\nDescribe the sheet here.", name="About this sheet", + span="full", emphasis="panel")])), +} + + +def _rename(draft: AnyDraft, new_label: str) -> AnyDraft: + if isinstance(draft, SpecDraft): + fs = draft.format_set.model_copy(deep=True) + fs.aliases = [] # an alias of the prototype would make two specs answer to one name + return SpecDraft(label=new_label, format_set=fs) + if isinstance(draft, ReportDraft): + data = draft.model_dump(exclude={"qualified_name", "guid", "base_version", "derived_from"}) + return ReportDraft(**{**data, "display_name": new_label}) + data = draft.model_dump(exclude={"guid", "base_version", "derived_from"}) + return SheetDraft(**{**data, "name": new_label, "heading": new_label}) + + +def _spec_from_registry(label: str) -> SpecDraft: + from pyegeria.view.base_report_formats import lookup_report_spec + fs, _tier, found = lookup_report_spec(label) + if fs is None: + raise AuthoringRefused(f"No report spec named {label!r} is known here to copy (pyegeria's registry, " + f"its Egeria-held and local tiers).") + return SpecDraft(label=found or label, format_set=fs.model_copy(deep=True)) + + +async def async_new_from(*, prototype: Optional[Tuple[str, str]] = None, template: Optional[str] = None, + new_label: str, client: Any = None) -> AnyDraft: + """A copy of a prototype `(kind, label)` or a template, named `new_label`, with `derived_from` recorded. + A held Report or sheet prototype is read from Egeria as the caller (`client`).""" + if (prototype is None) == (template is None): + raise AuthoringRefused("Give one of prototype=(kind, label) or template=name.") + if not (new_label or "").strip(): + raise AuthoringRefused("A new draft needs a new name (new_label).") + if template is not None: + if template not in TEMPLATES: + raise AuthoringRefused(f"No template {template!r}; the templates are {', '.join(sorted(TEMPLATES))}.") + draft = TEMPLATES[template][1](new_label) + draft.derived_from = f"template:{template}" + return draft + kind, label = prototype + if kind == "spec": + source = _spec_from_registry(label) + elif kind in ("report", "sheet"): + if client is None: + raise AuthoringRefused(f"Copying a held {kind} reads it from Egeria as you: a client is needed.") + from pyegeria.authoring.lifecycle import async_load_held + source = await async_load_held(kind, label, client) + else: + raise AuthoringRefused(f"A prototype is one of {', '.join(KINDS)}, not {kind!r}.") + if draft_key(source) == new_label: + raise AuthoringRefused(f"The copy needs a name of its own: {new_label!r} is the prototype's.") + draft = _rename(source, new_label) + draft.derived_from = f"prototype:{kind}:{label}" + return draft + + +def new_from(*, prototype: Optional[Tuple[str, str]] = None, template: Optional[str] = None, new_label: str, + client: Any = None) -> AnyDraft: + from pyegeria.core.async_runner import run_sync + return run_sync(async_new_from(prototype=prototype, template=template, new_label=new_label, client=client)) + + +# ── Draft storage (D16) ─────────────────────────────────────────────────────── + +class DraftStore(Protocol): + """Where a user's drafts are kept. Every call names the user: a draft is personal (§1b tier 1).""" + def save(self, user_id: str, draft: AnyDraft) -> str: ... + def load(self, user_id: str, kind: str, name: str) -> Optional[AnyDraft]: ... + def list(self, user_id: str, kind: Optional[str] = None) -> List[Dict[str, str]]: ... + def delete(self, user_id: str, kind: str, name: str) -> bool: ... + + +_USER_OK = re.compile(r"[A-Za-z0-9][A-Za-z0-9._@-]{0,127}") + + +def _slug(name: str) -> str: + slug = re.sub(r"[^A-Za-z0-9._-]+", "-", name).strip("-.")[:120] + if not slug: + raise AuthoringRefused(f"Can't make a file name from {name!r}.") + return slug + + +class LocalDraftStore: + """Drafts as JSON files: `///.json`. The caller chooses `root` (the API never + picks a shared default) and passes the user id it signed in; a user id that isn't a plain name is + refused, so one user can't reach another's directory.""" + + def __init__(self, root: Union[str, Path]): + self.root = Path(root).expanduser() + + def _dir(self, user_id: str, kind: str) -> Path: + if not _USER_OK.fullmatch(user_id or ""): + raise AuthoringRefused(f"Not a user id this store accepts: {user_id!r}.") + if kind not in KINDS: + raise AuthoringRefused(f"A draft is one of {', '.join(KINDS)}, not {kind!r}.") + return self.root / user_id / kind + + def _path(self, user_id: str, kind: str, name: str) -> Path: + return self._dir(user_id, kind) / f"{_slug(name)}.json" + + def save(self, user_id: str, draft: AnyDraft) -> str: + draft = as_draft(draft) + path = self._path(user_id, draft.kind, draft_key(draft)) + path.parent.mkdir(parents=True, exist_ok=True) + tmp = path.with_suffix(".json.tmp") + tmp.write_text(json.dumps({"name": draft_key(draft), "draft": draft.model_dump(mode="json")}, + indent=2, sort_keys=True)) + os.replace(tmp, path) + return str(path) + + def load(self, user_id: str, kind: str, name: str) -> Optional[AnyDraft]: + path = self._path(user_id, kind, name) + if not path.is_file(): + return None + return as_draft(json.loads(path.read_text())["draft"]) + + def list(self, user_id: str, kind: Optional[str] = None) -> List[Dict[str, str]]: + out = [] + for k in ([kind] if kind else list(KINDS)): + d = self._dir(user_id, k) + for f in sorted(d.glob("*.json")) if d.is_dir() else []: + try: + out.append({"kind": k, "name": json.loads(f.read_text())["name"]}) + except (OSError, ValueError, KeyError): + out.append({"kind": k, "name": f.stem, "note": "unreadable draft file"}) + return out + + def delete(self, user_id: str, kind: str, name: str) -> bool: + path = self._path(user_id, kind, name) + if path.is_file(): + path.unlink() + return True + return False + + +_ELEMENT_TYPE = {"spec": "ReportSpec", "report": "Report", "sheet": "Dashboard"} +PRUNE_DAYS = 30 +ZONE_PENDING = ("The private draft zone's name is still being settled: pass zone= (e.g. 'drafts-{user}') when " + "making an EgeriaDraftStore.") + + +def _parse_time(value: Any): + from datetime import datetime, timezone + if value in (None, ""): + return None + if isinstance(value, (int, float)): + return datetime.fromtimestamp(value / 1000 if value > 1e11 else value, tz=timezone.utc) + text = str(value).replace("Z", "+00:00") + try: + parsed = datetime.fromisoformat(text) + except ValueError: + return None + return parsed if parsed.tzinfo else parsed.replace(tzinfo=timezone.utc) + + +class EgeriaDraftStore: + """Drafts held in Egeria, zoned private to their author (D16, decided "Egeria, private, 30-day prune"). + + - **The draft is the element itself** (a ReportSpec, a Report, a Dashboard sheet chain) with its real + qualified name, in the author's private zone (`zone`, a parameter while its name is settled; "{user}" in + it becomes the author's user id). In Egeria a zone with no control is private, so only the author sees + the draft. + - **Written as the author:** every write is a Dr.Egeria document run through the caller's runner (`run`), + and the client must be signed in as the user whose draft it is. + - **Never over a published element:** saving a draft whose element is already held outside the author's + private zone is refused (it would change what others see); make a copy with new_from, or promote. + - **Promotion clears the zone:** promotion_plan() is the publish plan with Declassify Zone Membership. + - **prune_drafts(older_than_days=30)** removes the author's unpromoted drafts last changed more than 30 days + ago, as the author. It never sweeps anyone else's drafts. + """ + + def __init__(self, client: Any, run: Any = None, *, zone: Optional[str] = None): + if not zone: + raise AuthoringRefused(ZONE_PENDING) + self.client = client + self.run = run + self.zone_pattern = zone + + # ---------------------------------------------------------------- helpers + + def zone(self, user_id: str) -> str: + return self.zone_pattern.replace("{user}", user_id) + + def _author(self, user_id: str) -> str: + signed_in = getattr(self.client, "user_id", None) + if not user_id or user_id != signed_in: + raise AuthoringRefused(f"Drafts are written and read as their author: this client is signed in as " + f"{signed_in!r}, not {user_id!r}.") + return self.zone(user_id) + + async def _element(self, kind: str, name: str) -> Optional[Dict[str, Any]]: + from pyegeria.authoring.lifecycle import _by_qualified_name, _report_element + if kind == "spec": + from md_processing.v2.report import find_report_spec_element + return await find_report_spec_element(self.client, name) + if kind == "report": + return await _report_element(self.client, name) + return await _by_qualified_name(self.client, f"Dashboard::{name}") + + @staticmethod + def _zones(el: Dict[str, Any]) -> List[str]: + from pyegeria.view.egeria_spec_cache import _zones + return _zones(el) + + # ---------------------------------------------------------------- the store + + async def async_save(self, user_id: str, draft: AnyDraft) -> str: + """Create or update the draft's element in the author's private zone. Returns its qualified name.""" + from pyegeria.authoring.serialize import serialize + from pyegeria.view.report_spec_publish import _call + zone = self._author(user_id) + draft = as_draft(draft) + if self.run is None: + raise AuthoringRefused("Saving a draft to Egeria runs a document as you: a runner is needed.") + held = await self._element(draft.kind, draft_key(draft)) + if held is not None and zone not in self._zones(held): + raise AuthoringRefused(f"{draft.kind} {draft_key(draft)!r} is already held in Egeria outside your private " + f"draft zone ({', '.join(self._zones(held)) or 'public'}): saving the draft there " + f"would change what others see. Copy it with new_from, or promote the draft.") + env = _call(self.run, serialize(draft, zones=[zone]), "process") + if not env.get("success"): + words = "; ".join(str(e.get("message", e)) if isinstance(e, dict) else str(e) + for e in (env.get("execution_errors") or env.get("validation_errors") or [])[:3]) + raise AuthoringRefused(f"The draft was not saved: {words or 'Dr.Egeria did not succeed'}.") + if isinstance(draft, SpecDraft): + return draft.qualified_name + if isinstance(draft, SheetDraft): + return f"Dashboard::{draft.name}" + return draft.qualified_name or draft.display_name + + async def async_load(self, user_id: str, kind: str, name: str) -> Optional[AnyDraft]: + """The author's draft `name`, or None when no element by that name is in their private zone.""" + from pyegeria.authoring.lifecycle import async_load_held + zone = self._author(user_id) + el = await self._element(kind, name) + if el is None or zone not in self._zones(el): + return None + return await async_load_held(kind, name, self.client) + + async def async_list(self, user_id: str, kind: Optional[str] = None) -> List[Dict[str, Any]]: + """The author's drafts: every ReportSpec, Report and Dashboard in their private zone, read as them.""" + zone = self._author(user_id) + out: List[Dict[str, Any]] = [] + for k in ([kind] if kind else list(KINDS)): + start = 0 + while True: + page = await self.client.classification_manager._async_find_elements_by_property_value( + ".*", ["qualifiedName"], metadata_element_type=_ELEMENT_TYPE[k], starts_with=False, + governance_zone_filter=[zone], graph_query_depth=0, start_from=start, page_size=50) + raw = [e for e in page if isinstance(e, dict) and e.get("elementHeader")] if isinstance(page, list) else [] + if not raw: # only an empty page ends the read (a short page isn't the last page) + break + start += len(raw) + for el in (e for e in raw if zone in self._zones(e)): + props = el.get("properties") or {} + versions = (el.get("elementHeader") or {}).get("versions") or {} + name = props.get("displayName") or props.get("qualifiedName") + if k == "sheet" and str(props.get("qualifiedName", "")).startswith("Dashboard::"): + name = props["qualifiedName"].split("::", 1)[1] + out.append({"kind": k, "name": name, "qualified_name": props.get("qualifiedName"), + "guid": el["elementHeader"].get("guid"), + "updated": versions.get("updateTime") or versions.get("createTime")}) + return out + + async def async_delete(self, user_id: str, kind: str, name: str) -> bool: + """Delete the author's draft (only an element in their private zone), as the author.""" + zone = self._author(user_id) + el = await self._element(kind, name) + if el is None or zone not in self._zones(el): + return False + guid = el["elementHeader"]["guid"] + if kind == "sheet": + from md_processing.v2.dashboard_sheet import DashboardSheetEgeriaWriter + return bool(await DashboardSheetEgeriaWriter(self.client).delete_sheet(name)) + if kind == "report": + await self.client.asset_maker._async_delete_asset(guid) + else: + await self.client.metadata_expert._async_delete_metadata_element(guid) + return True + + async def async_prune_drafts(self, user_id: str, older_than_days: int = PRUNE_DAYS, *, + dry_run: bool = False) -> Dict[str, Any]: + """Remove the author's drafts last changed more than `older_than_days` ago (a promoted draft is no + longer in the private zone, so it's never pruned). Run as the author only.""" + from datetime import datetime, timedelta, timezone + cutoff = datetime.now(timezone.utc) - timedelta(days=older_than_days) + drafts = await self.async_list(user_id) + out: Dict[str, Any] = {"removed": [], "kept": [], "not_dated": [], "dry_run": dry_run, + "older_than_days": older_than_days} + for d in drafts: + when = _parse_time(d.get("updated")) + if when is None: + out["not_dated"].append(d["name"]) # never removed on a guess + elif when < cutoff: + if not dry_run: + await self.async_delete(user_id, d["kind"], d["name"]) + out["removed"].append(f"{d['kind']}:{d['name']}") + else: + out["kept"].append(f"{d['kind']}:{d['name']}") + return out + + async def async_promotion_plan(self, user_id: str, kind: str, name: str, *, folders: Any = ()) -> Dict[str, Any]: + """The publish plan for the author's draft: it clears the private zone and files it in `folders`.""" + from pyegeria.authoring.lifecycle import publish_plan + draft = await self.async_load(user_id, kind, name) + if draft is None: + raise AuthoringRefused(f"You have no {kind} draft named {name!r} in your private zone.") + return publish_plan(draft, folders=folders, held={"held": True, "zones": [self.zone(user_id)]}) + + # ---------------------------------------------------------------- sync forms (DraftStore) + + def _sync(self, coro): + from pyegeria.core.async_runner import run_sync + return run_sync(coro) + + def save(self, user_id: str, draft: AnyDraft) -> str: + return self._sync(self.async_save(user_id, draft)) + + def load(self, user_id: str, kind: str, name: str) -> Optional[AnyDraft]: + return self._sync(self.async_load(user_id, kind, name)) + + def list(self, user_id: str, kind: Optional[str] = None) -> List[Dict[str, Any]]: + return self._sync(self.async_list(user_id, kind)) + + def delete(self, user_id: str, kind: str, name: str) -> bool: + return self._sync(self.async_delete(user_id, kind, name)) + + def prune_drafts(self, user_id: str, older_than_days: int = PRUNE_DAYS, *, dry_run: bool = False) -> Dict[str, Any]: + return self._sync(self.async_prune_drafts(user_id, older_than_days, dry_run=dry_run)) + + def promotion_plan(self, user_id: str, kind: str, name: str, *, folders: Any = ()) -> Dict[str, Any]: + return self._sync(self.async_promotion_plan(user_id, kind, name, folders=folders)) + + +def draft_store(backend: str = "egeria", **kwargs: Any) -> DraftStore: + """The store for a backend: "egeria" (the default for apps: client=, run=, zone=) or "local" (root=).""" + if backend == "local": + if not kwargs.get("root"): + raise AuthoringRefused("The local draft store needs a directory (root) from the caller.") + return LocalDraftStore(kwargs["root"]) + if backend == "egeria": + return EgeriaDraftStore(kwargs.get("client"), kwargs.get("run"), zone=kwargs.get("zone")) + raise AuthoringRefused(f"No draft store {backend!r}; there are 'egeria' and 'local'.") diff --git a/pyegeria/authoring/lifecycle.py b/pyegeria/authoring/lifecycle.py new file mode 100644 index 00000000..41d2d1e1 --- /dev/null +++ b/pyegeria/authoring/lifecycle.py @@ -0,0 +1,352 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the ODPi Egeria project. +"""Held artifacts: load one as a draft, read its history, plan its publish or withdraw, apply a plan. + +Every Egeria read here uses the caller's `client`, signed in as the user; every write runs through the +caller's runner (`run(markdown, directive)`), as the user. This module never authenticates and never +uses a service account. +""" +from __future__ import annotations + +import json +from typing import Any, Dict, Iterable, List, Optional, Union + +from loguru import logger + +from pyegeria.authoring.models import ( + AuthoringGates, AuthoringRefused, ReportDraft, SheetDraft, SheetPlacement, SpecDraft, as_draft, default_gates, +) +from pyegeria.authoring.serialize import ( + DASHBOARD_FOLDER_PREFIX, FIND_PARAMETERS, PINNED_VERSION_KEY, SPEC_FOLDER_PREFIX, serialize, +) +from pyegeria.view.report_spec_publish import ( + PublishRefused, build_publish_document, build_withdraw_document, document_digest, run_document, section, +) + +#: The consumers that have folders today (design note §1). A folder is ``. +KNOWN_CONSUMERS = ("EgeriaAdvisor", "Jupyter", "MyEgeria", "Portal", "ResourceExplorer", "pyegeria") +RESTRICTED_LATER = "Restricted publish comes later, after the zone proof: publish as public for now." +PIN_REFUSED = "Pinning a spec version is switched off here (AuthoringGates.allow_pinning, D14)." +BUILTIN_REFUSED = ("'{label}' is a built-in spec: it ships with pyegeria and isn't published from here. " + "Copy it with new_from(prototype=('spec', '{label}'), new_label=...) and publish the copy.") + + +# ── Reading held artifacts, as the caller ───────────────────────────────────── + +async def _by_qualified_name(client: Any, qn: str) -> Optional[Dict[str, Any]]: + from md_processing.v2.report import find_element_by_qualified_name + return await find_element_by_qualified_name(client, qn) + + +async def _report_element(client: Any, label: str) -> Optional[Dict[str, Any]]: + """A Report by qualified name, else by exact display name (one Report must match).""" + el = await _by_qualified_name(client, label) + if el and _type_name(el) == "Report": + return el + found = await client.classification_manager._async_get_elements_by_property_value( + label, ["displayName"], metadata_element_type="Report", starts_with=False, ends_with=False, + ignore_case=False, page_size=25, graph_query_depth=0) + matches = [e for e in found if isinstance(e, dict) and (e.get("properties") or {}).get("displayName") == label] \ + if isinstance(found, list) else [] + if len(matches) > 1: + raise AuthoringRefused(f"{len(matches)} Reports are named {label!r}; give its qualified name.") + return matches[0] if matches else None + + +def _type_name(el: Dict[str, Any]) -> str: + return ((el.get("elementHeader") or {}).get("type") or {}).get("typeName", "") + + +def _version(el: Dict[str, Any]) -> Optional[int]: + v = ((el.get("elementHeader") or {}).get("versions") or {}).get("version") + try: + return int(v) + except (TypeError, ValueError): + return None + + +def report_draft_from_element(el: Dict[str, Any]) -> ReportDraft: + """A ReportDraft from a Report element. Parameters are read from the typed `reportParameters` first + (D7), then from the camelCase additionalProperties keys; `notes` says which was read.""" + from md_processing.v2.report import _camel_to_snake + props = el.get("properties") or {} + extra = dict(props.get("additionalProperties") or {}) + notes: List[str] = [] + analytic: Dict[str, Any] = {} + raw_analytic = extra.get("analyticParams") + if raw_analytic: + try: + analytic = json.loads(raw_analytic) if isinstance(raw_analytic, str) else dict(raw_analytic) + except (TypeError, ValueError): + notes.append("analyticParams is not JSON; not read") + params: Dict[str, Any] = {} + pinned = extra.pop(PINNED_VERSION_KEY, None) + try: + pinned = int(pinned) if pinned not in (None, "") else None + except (TypeError, ValueError): + notes.append(f"{PINNED_VERSION_KEY} {pinned!r} is not a version number; following the latest version") + pinned = None + typed = props.get("reportParameters") + if typed: + try: + doc = json.loads(typed) if isinstance(typed, str) else dict(typed) + params = {k: v for k, v in doc.items() if k not in analytic} + notes.append("parameters read from reportParameters") + except (TypeError, ValueError): + notes.append("reportParameters is not JSON; read the additionalProperties keys instead") + typed = None + if not typed: + for key, value in extra.items(): + if key in ("reportSpec", "outputFormat", "analyticParams"): + continue + params[_camel_to_snake(key)] = _decode(value) if _camel_to_snake(key) in FIND_PARAMETERS else value + notes.append("parameters read from the additionalProperties keys (no reportParameters)") + return ReportDraft(display_name=props.get("displayName") or "", qualified_name=props.get("qualifiedName"), + description=props.get("description"), spec=extra.get("reportSpec") or "", + output_format=props.get("outputFormat") or extra.get("outputFormat") or "DICT", + parameters=params, analytic_params=analytic, pinned_version=pinned, + guid=(el.get("elementHeader") or {}).get("guid"), + base_version=_version(el), notes=notes) + + +def _decode(value: Any) -> Any: + """A camelCase-copy value back to its type: "True" -> True, "25" -> 25, "['A']" / '["A"]' -> ["A"].""" + if not isinstance(value, str): + return value + text = value.strip() + if text in ("True", "False"): + return text == "True" + if text.lstrip("-").isdigit(): + return int(text) + if text.startswith("[") and text.endswith("]"): + try: + return json.loads(text) + except ValueError: + import ast + try: + return list(ast.literal_eval(text)) + except (ValueError, SyntaxError): + return value + return value + + +def sheet_draft_from_sheet(sheet: Any) -> SheetDraft: + """A SheetDraft from a sheet read from Egeria (pyegeria.view.dashboards.EgeriaDashboardSheet).""" + notes = list(getattr(sheet, "breaks", None) or []) + placements = [] + for i, p in enumerate(sheet.placements, start=1): + kind = getattr(p, "kind", "report") + if getattr(p, "note", None): + notes.append(f"placement {i} ({p.ref}): {p.note}") + if kind == "text" or p.content is not None: + placements.append(SheetPlacement(text=p.content or "", name=p.ref, span=p.span, emphasis=p.emphasis, + perspectives=list(p.perspectives or []), detail_spec=p.detail_spec)) + else: + if kind == "missing": + notes.append(f"placement {i} ({p.ref}): its Report link is missing in Egeria; kept by name") + placements.append(SheetPlacement(report=p.ref, span=p.span, emphasis=p.emphasis, + perspectives=list(p.perspectives or []), detail_spec=p.detail_spec)) + return SheetDraft(name=sheet.name, heading=sheet.heading, description=sheet.description or "", + family=sheet.family, placements=placements, guid=getattr(sheet, "guid", None), notes=notes) + + +async def async_load_held(kind: str, label: str, client: Any) -> Union[SpecDraft, ReportDraft, SheetDraft]: + """The held artifact `label` as a draft, read from Egeria as the caller, with its Egeria version. + - spec: the ReportSpec element `ReportSpec::