diff --git a/docs/embed-va.md b/docs/embed-va.md index f682117..4aeddee 100644 --- a/docs/embed-va.md +++ b/docs/embed-va.md @@ -6,10 +6,7 @@ description: Embed the Data Controller editor inside a SAS VA report as a data-d # Embedding inside SAS Visual Analytics -Data Controller can be embedded inside a SAS Visual Analytics report as a -**data-driven content** (DDC) object. This unlocks scenarios where a user -selects a row in a VA visualisation and is immediately able to edit the -corresponding row(s) in a SAS table - all from inside the same report. +Data Controller can be embedded inside a SAS Visual Analytics report as a **data-driven content** (DDC) object. This unlocks scenarios where a user can safely modify the values in an underlying SAS table, and have the visualisation updated- all from inside the same report. ## URL @@ -31,19 +28,13 @@ The `?embed=` parameter accepts three values: ## How VA drives the editor -VA pushes a JSON payload to the iframe via `window.postMessage` whenever the -selected rows change. Data Controller listens for these messages and: +VA pushes a JSON payload to the iframe via `window.postMessage` whenever the selected rows change. Data Controller listens for these messages and: 1. Resolves each VA `parameter` to a DC column by matching on column label. -2. Builds a filter (using existing [Filter](/filter/) machinery) over the - selected primary-key values. -3. Hides any VA columns marked as `brush` so the grid stays focused on the - user-editable columns (except primary key cols which are always shown) -4. Navigates to `/editor//?embed=va` so the filtered view is - shareable and survives reloads. +2. Builds a filter (using existing [Filter](/filter/) machinery) over the selected values. +3. Hides any VA columns marked as `brush` so the grid stays focused on the user-editable columns (except primary key cols which are always shown) -If VA sends an empty / unmatched message the editor falls back to the unfiltered -view but stays in VA mode. +If VA sends an empty / unmatched message the editor falls back to the unfiltered view but stays in VA mode. ## Security @@ -53,6 +44,4 @@ https://git.datacontroller.io/dc/dc/src/branch/main/client/src/app/services/va-m ## Configuration in VA -In the VA Report Designer, add a **Data-Driven Content** object and set the URL -to the editor route shown above. Map the report data items so they include the -primary key column(s) of the target DC table. \ No newline at end of file +In the VA Report Designer, add a **Data-Driven Content** object and set the URL to the editor route shown above. Be sure that any report level parameters are added to the DDC object itself. \ No newline at end of file