Merge pull request 'docs(va): in-report screenshots for the mapping and the banner' (#30) from docs/va-in-report-images into main
Publish to docs.datacontroller.io / Deploy docs (push) Successful in 1m4s

Reviewed-on: #30
This commit was merged in pull request #30.
This commit is contained in:
allan committed 2026-10-29 14:38:26 +00:00
commit 428e8e7fa1
6 files changed
+7 -9

No files matched your search

Binary file not shown.

Before

Width:  |  Height:  |  Size: 151 KiB

After

Width:  |  Height:  |  Size: 184 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 163 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 171 KiB

+7 -9
View File
@@ -50,7 +50,7 @@ VA pushes a JSON payload to the iframe via `window.postMessage` whenever the sel
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.
The applied filter is shown above the grid, so what the report did to the editor is visible without touching it. In the report below, two report parameters - `SOME_DROPDOWN` and `SOME_DATE` - reach one Data Controller object, and the editor shows both the combined filter and the single row it matches: In the report below, two report parameters - `SOME_DROPDOWN` and `SOME_DATE` - reach one Data Controller object, and the editor shows both the combined filter and the rows it matches:
![A value and a date parameter filtering the embedded editor](img/va-report-filters.png) ![A value and a date parameter filtering the embedded editor](img/va-report-filters.png)
@@ -73,7 +73,7 @@ Repeat the parameter to add mappings. A report with two tabs, each holding its
| Tab 1 | `...?embed=va&va_parmap=REGION_TAB1-REGION` | | Tab 1 | `...?embed=va&va_parmap=REGION_TAB1-REGION` |
| Tab 2 | `...?embed=va&va_parmap=REGION_TAB2-REGION` | | Tab 2 | `...?embed=va&va_parmap=REGION_TAB2-REGION` |
The applied filter is visible in the editor, above the grid - here the parameter `DROPDOWN_TAB1` filtering `SOME_DROPDOWN`, which is not its name: The applied filter is visible in the editor, above the grid - here the parameter `DROPDOWN_TAB1` filtering `SOME_DROPDOWN`, which is not its name (the date parameter beside it is name-matched, which is the default):
![A va_parmap mapping filtering a column](img/va-parmap-filtered.png) ![A va_parmap mapping filtering a column](img/va-parmap-filtered.png)
@@ -120,11 +120,7 @@ A mapping can resolve the parameter value through a **named date anchor** before
https://yourserver/DC/#/editor/<library>/<table>?embed=va&va_parmap=SELECTED_DATE-D_DATE:ADD(QUARTER_START,-1) https://yourserver/DC/#/editor/<library>/<table>?embed=va&va_parmap=SELECTED_DATE-D_DATE:ADD(QUARTER_START,-1)
``` ```
A report that sends `SELECTED_DATE = 27FEB1961` then filters `D_DATE` on 1961-02-27 **and** 1960-10-01 - the selected date, plus the same point one quarter earlier: A report that sends `SELECTED_DATE = 27FEB1961` then filters `D_DATE` on 1961-02-27 **and** 1960-10-01 - the selected date, plus the same point one quarter earlier.
In the screenshot below the mapping is `SELECTED_DATE-SOME_DATE:ADD(QUARTER_START,-1)` against the demo table, and the parameter sends 27FEB1961:
![A date anchor applied to the filter](img/va-parmap-transform.png)
The clause carries both values, so the row for the selected date and the row for the previous quarter are both included. The clause carries both values, so the row for the selected date and the row for the previous quarter are both included.
@@ -184,9 +180,11 @@ The mapping lives entirely in the URL of the report object, so the job is to get
FILTER : ( ( REGION = 'Europe' ) ) FILTER : ( ( REGION = 'Europe' ) )
``` ```
A date parameter arrives as a display date and is rendered as a SAS date literal, the same as a date filter built inside Data Controller - `'12FEB1960'd` below, over the row it matches: A date parameter arrives as a display date and is rendered as a SAS date literal, the same as a date filter built inside Data Controller:
![A date parameter rendered as a SAS date literal](img/va-report-filter-line.png) ```text
FILTER : ( ( SOME_DROPDOWN = 'Option 1' AND SOME_DATE BETWEEN '01JAN1960'd AND '31MAR1960'd ) )
```
Something wrong shows the banner instead, with the cause and the fix - see [When a mapping cannot be used](#when-a-mapping-cannot-be-used) above. Something wrong shows the banner instead, with the cause and the fix - see [When a mapping cannot be used](#when-a-mapping-cannot-be-used) above.