Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/dr_egeria_manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,13 @@ Dr.Egeria organizes its commands into "families," each corresponding to a specif
- `Create Dashboard Sheet`: Create a named, ordered, nestable Dashboard Sheet — a local pyegeria-managed layout record (not yet an Egeria element; see `pyegeria/view/_output_dashboard_sheet_models.py`).
- `Link Report to Dashboard Sheet`: Place a `Report` (by name) onto a Dashboard Sheet as an ordered Placement, with layout hints (`Placement Span`/`Placement Emphasis`), optional viewer-role tagging (`Placement Perspectives`), and an optional drill-down target (`Placement Detail Spec`).
- `Add Text on Dashboard Sheet`: Place literal markdown text (a section header, explanation, or caption) onto a Dashboard Sheet as an ordered Placement, alongside Report placements — no Egeria element involved; also supports `Placement Perspectives` for viewer-role tagging.
- **Asset Maker** (added 2026-09-11): Instantiate Open Metadata catalog templates via `pyegeria/omvs/automated_curation.py`'s create-from-template surface — no update path, since the underlying OMVS methods are create-only. `Create Element` is the generic, Advanced-only mechanism (raw `typeName`/`templateGUID`/`placeholderPropertyValues`); twelve Basic-level, type-specific wrappers cover the common cases: `Create Secrets Store Element`, `Create Kafka Server Element`, `Create CSV Data File Element`, `Create Postgres Server Element`, `Create Postgres Database Element`, `Create Folder Element`, `Create UC Server Element`, `Create UC Catalog Element`, `Create UC Schema Element`, `Create UC Table Element`, `Create UC Function Element`, `Create UC Volume Element`. Live-verified: `Create Schema Type` (see below) and `Create CSV Data File Element` round-tripped against a running server; `Create Kafka Server Element` currently fails on a server with no "Apache Kafka Server" catalog template registered — a pre-existing gap in that server's template catalog, not a defect in this command.
- **Asset Maker** (added 2026-09-11): Instantiate Open Metadata catalog templates via `pyegeria/omvs/automated_curation.py`'s create-from-template surface — no update path, since the underlying OMVS methods are create-only. The generic, Advanced-only `Create Element` (raw `typeName`/`templateGUID`/`placeholderPropertyValues`) moved to the Automation family on 2026-10-02; twelve Basic-level, type-specific wrappers remain here for the common cases: `Create Secrets Store Element`, `Create Kafka Server Element`, `Create CSV Data File Element`, `Create Postgres Server Element`, `Create Postgres Database Element`, `Create Folder Element`, `Create UC Server Element`, `Create UC Catalog Element`, `Create UC Schema Element`, `Create UC Table Element`, `Create UC Function Element`, `Create UC Volume Element`. Live-verified: `Create Schema Type` (see below) and `Create CSV Data File Element` round-tripped against a running server; `Create Kafka Server Element` currently fails on a server with no "Apache Kafka Server" catalog template registered — a pre-existing gap in that server's template catalog, not a defect in this command.
- **Automation** (added 2026-10-02): Commands that set Egeria's governance engines running, via `pyegeria/omvs/automated_curation.py` (processors in `md_processing/v2/automation.py`).
- `Initiate Governance Action Process` / `Initiate Governance Action Type`: run a process or a single action type. `Action Targets` takes one `action target name: element` pair per line; `Request Parameters` takes `name: value` pairs.
- `Initiate Survey`: run a survey (e.g. `PostgreSQLSurvey::survey-postgres-database`) against one resource. The action target name each survey expects (`postgresDatabase`, `fileToSurvey`, ...) is read from the survey type, so it doesn't need to be supplied.
- `Initiate Subscription`: take out a subscription to a digital product by running its subscription type (`ProvisioningActionProcess::<product>::Create Subscription::<type>`) with a `Subscription Requester` and `Destination Data Set`. This provisions the subscription, unlike `Create Digital Subscription`, which only records the element.
- `Cancel Subscription`: run the cancel process Egeria attached to the subscription when it was provisioned (found through its resource list).
- `Create Element`: the generic create-from-template command, moved here from Asset Maker.
- **Schema Maker** (added 2026-09-11): The `pyegeria/omvs/schema_maker.py` surface — `Create`/`Update Schema Type` and `Create`/`Update Schema Attribute` (both upsert-capable, live-verified), `Create Schema Type From Template`/`Create Schema Attribute From Template`, 15 `Link`/`Detach` relationship command pairs (Nested Schema Attribute, Attribute for Schema, Foreign Key, External Schema Type, Map From/To Schema Type, Graph Edge, Query Target, Schema, Relational DB Schema, API Operations/Header/Request/Response, Schema Type Option — `Link Nested Schema Attribute` live-verified), and 3 `Add`/`Remove` classification pairs (Primary Key, Type Embedded Attribute, Calculated Value) on a schema attribute/column. Effectivity dates, Anchor ID, and Anchor Scope IDs are Advanced-level; everything else is Basic.

#### `Create Report`'s two Dictionary attributes, worked examples
Expand Down
10 changes: 5 additions & 5 deletions md_processing/data/compact_commands/commands_action_author.json
Original file line number Diff line number Diff line change
Expand Up @@ -2272,7 +2272,7 @@
"default_value": "",
"valid_values": [],
"existing_element": "",
"description": "The governance action process to link.",
"description": "The governance action process, identified by its qualified name, display name or GUID.",
"generated": false,
"style": "Reference Name",
"user_specified": true,
Expand Down Expand Up @@ -2348,7 +2348,7 @@
"default_value": "",
"valid_values": [],
"existing_element": "",
"description": "Parameters to pass to the governance service when this step executes.",
"description": "Name: value parameters passed to the governance service(s) that run.",
"generated": false,
"style": "Dictionary",
"user_specified": true,
Expand Down Expand Up @@ -2386,7 +2386,7 @@
"default_value": "",
"valid_values": [],
"existing_element": "",
"description": "The governance action type to link to a governance engine executor.",
"description": "The governance action type, identified by its qualified name, display name or GUID.",
"generated": false,
"style": "Reference Name",
"user_specified": true,
Expand Down Expand Up @@ -2538,7 +2538,7 @@
"default_value": "",
"valid_values": [],
"existing_element": "",
"description": "The name to give this element when it is passed as an action target to the governance service.",
"description": "The name an element is given when it is passed as an action target to a governance service.",
"generated": false,
"style": "Simple",
"user_specified": true,
Expand Down Expand Up @@ -2721,7 +2721,7 @@
"default_value": "",
"valid_values": [],
"existing_element": "",
"description": "Elements that triggered/requested this engine action.",
"description": "Elements that caused or requested the action.",
"generated": false,
"style": "Reference Name List",
"user_specified": true,
Expand Down
Loading
Loading