dc/docs.datacontroller.io
6
1 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(config): derived variables in the EDIT screen #21

Merged
allan merged 23 commits from docs/derived-variables into main 2026-10-21 22:26:31 +00:00
Conversation 18 Commits 23 Files Changed 7
+6 -6
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit cddf39e58c - Show all commits

No files matched your search

docs/derived-variables.md
+5 -5
View File
@@ -20,7 +20,7 @@ Each row defines one variable:
- `LIBREF` / `DSN` - the target table - `LIBREF` / `DSN` - the target table
- `VAR_NM` - the name of the new column - `VAR_NM` - the name of the new column
- `VAR_DEPENDENCIES` - every input the expression uses: the physical columns and any derived variables, space separated - `VAR_DEPS` - every input the expression uses: the physical columns and any derived variables, space separated
- `VAR_TYPE` - `C` for character, `N` for numeric - `VAR_TYPE` - `C` for character, `N` for numeric
- `VAR_LEN` - character length, or numeric length (1-8) - `VAR_LEN` - character length, or numeric length (1-8)
- `VAR_FMT` - optional, eg `DATE9.` or `DOLLAR12.2` - `VAR_FMT` - optional, eg `DATE9.` or `DOLLAR12.2`
@@ -31,7 +31,7 @@ A simple example, deriving a region from a state:
``` ```
VAR_NM REGION VAR_NM REGION
VAR_DEPENDENCIES STATE VAR_DEPS STATE
VAR_TYPE C VAR_TYPE C
VAR_LEN 8 VAR_LEN 8
VAR_FMT (blank) VAR_FMT (blank)
@@ -43,7 +43,7 @@ A second variable can build on it - its dependencies include the physical column
``` ```
VAR_NM REGION_LABEL VAR_NM REGION_LABEL
VAR_DEPENDENCIES REGION STATE VAR_DEPS REGION STATE
VAR_TYPE C VAR_TYPE C
VAR_LEN 14 VAR_LEN 14
VAR_FMT (blank) VAR_FMT (blank)
@@ -73,7 +73,7 @@ Derived columns themselves are an EDIT screen feature: the VIEW screen and the d
## Rules and limits ## Rules and limits
- **Expressions only.** `VAR_LOGIC` must be a single SAS expression - no semicolons, macro triggers (`%`, `&`) or comments. Conditional logic is available through functions such as `ifc()`, `choosec()`, `cats()`, `catx()`, `put()`, `input()` and `intnx()`. - **Expressions only.** `VAR_LOGIC` must be a single SAS expression - no semicolons, macro triggers (`%`, `&`) or comments. Conditional logic is available through functions such as `ifc()`, `choosec()`, `cats()`, `catx()`, `put()`, `input()` and `intnx()`.
- **Dependencies declared.** `VAR_DEPENDENCIES` lists every input the expression uses, physical columns and derived variables alike. Statements are generated in dependency order, so a variable can build on another without a sequence number. The declaration is checked against the expression in both directions: a derived variable that is referenced must be declared, and a declared name that the expression does not reference is an error. A declared name must be a column of the table or a derived variable of the same table, and a cycle is rejected. - **Dependencies declared.** `VAR_DEPS` lists every input the expression uses, physical columns and derived variables alike. Statements are generated in dependency order, so a variable can build on another without a sequence number. The declaration is checked against the expression in both directions: a derived variable that is referenced must be declared, and a declared name that the expression does not reference is an error. A declared name must be a column of the table or a derived variable of the same table, and a cycle is rejected.
- **No collisions.** `VAR_NM` must not match an existing column of the target table, or one of the reserved names (`TX_FROM`, `TX_TO`, `PROCESSED_DTTM`, `VAR_TXFROM`, `VAR_TXTO`, `VAR_PROCESSED`, `_____DELETE__THIS__RECORD_____`). - **No collisions.** `VAR_NM` must not match an existing column of the target table, or one of the reserved names (`TX_FROM`, `TX_TO`, `PROCESSED_DTTM`, `VAR_TXFROM`, `VAR_TXTO`, `VAR_PROCESSED`, `_____DELETE__THIS__RECORD_____`).
- **Read-only.** Derived columns cannot be edited in the grid, and any value submitted for them is discarded before the approval package is created. - **Read-only.** Derived columns cannot be edited in the grid, and any value submitted for them is discarded before the approval package is created.
- **Recomputed on every read.** The value always reflects the current data and the current definition, and there is no history of previous derived values. - **Recomputed on every read.** The value always reflects the current data and the current definition, and there is no history of previous derived values.
@@ -82,7 +82,7 @@ A configuration error - a bad name, an invalid type or length, a name collision,
Most of these rules are also applied when a row is submitted for approval, through a post edit hook on `MPE_DERIVED`. A bad name, type, length, format or expression - or a reference to a variable that is not defined earlier - is rejected at submit time, while the error can still be corrected, rather than breaking the EDIT screen afterwards. The collision between `VAR_NM` and a physical column of the target table is only checked at read time, as the hook does not have the target library assigned. Most of these rules are also applied when a row is submitted for approval, through a post edit hook on `MPE_DERIVED`. A bad name, type, length, format or expression - or a reference to a variable that is not defined earlier - is rejected at submit time, while the error can still be corrected, rather than breaking the EDIT screen afterwards. The collision between `VAR_NM` and a physical column of the target table is only checked at read time, as the hook does not have the target library assigned.
The simple rules are also configured as validation rules on the table itself, so they show up in the grid before submission: `VAR_TYPE` is a dropdown of `C` and `N`, `VAR_LEN` carries minimum and maximum values, and `VAR_NM`, `VAR_DEPENDENCIES`, `VAR_FMT` and `VAR_LOGIC` are pattern checked. Validation rules are evaluated in the browser, so the post edit hook remains the authoritative check. The simple rules are also configured as validation rules on the table itself, so they show up in the grid before submission: `VAR_TYPE` is a dropdown of `C` and `N`, `VAR_LEN` carries minimum and maximum values, and `VAR_NM`, `VAR_DEPS`, `VAR_FMT` and `VAR_LOGIC` are pattern checked. Validation rules are evaluated in the browser, so the post edit hook remains the authoritative check.
!!! warning "Derived values can expose hidden data" !!! warning "Derived values can expose hidden data"
An expression can reference a column that is hidden from the user by [Column Level Security](/column-level-security/), and the derived column will show the result. Configure derived variables with the same care as any other data exposure. An expression can reference a column that is hidden from the user by [Column Level Security](/column-level-security/), and the derived column will show the result. Configure derived variables with the same care as any other data exposure.
docs/tables/mpe_derived.md
+1 -1
View File
@@ -17,7 +17,7 @@ The table is itself registered in [MPE_TABLES](/tables/mpe_tables/), so it is ma
- 🔑 `LIBREF char(8)`: The libref of the target table - 🔑 `LIBREF char(8)`: The libref of the target table
- 🔑 `DSN char(32)`: The target table - 🔑 `DSN char(32)`: The target table
- 🔑 `VAR_NM char(32)`: The name of the derived column - 🔑 `VAR_NM char(32)`: The name of the derived column
- `VAR_DEPENDENCIES char(4000)`: Every input the expression uses - physical columns and derived variables, space separated - `VAR_DEPS char(4000)`: Every input the expression uses - physical columns and derived variables, space separated
- `VAR_TYPE char(1)`: `C` for character, `N` for numeric - `VAR_TYPE char(1)`: `C` for character, `N` for numeric
- `VAR_LEN num`: Character length, or numeric length (1-8) - `VAR_LEN num`: Character length, or numeric length (1-8)
- `VAR_FMT char(32)`: Optional SAS format, eg `DATE9.` - `VAR_FMT char(32)`: Optional SAS format, eg `DATE9.`