uc-apx create link-column
Rewrite an existing classic-report or interactive-report column from
a plain renderer (plainText / number / hidden / …) to type: link, with
a link { target { page, items, clearCache } linkText: … } block that
opens the target page with row-substitution-token (#COL#) passthrough.
Canonical use: turn the auto-scaffolded numeric ID column on an IR
into an edit-pencil link column that opens a modal-dialog form page,
with the row’s PK passed through via —item-pair PNN_ID=#ID#.
The column is rewritten in place (no new construct is created), so any
existing heading text, sequence, source.dataType, etc. are preserved.
By default the column also gets heading.alignment / layout.columnAlignment
set to center (disable with —center=false) and an enableUsersTo
block that hides the column from sort / filter / control-break etc.
(disable with —disable-user-actions=false).
uc-apx create link-column [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--center | center | true | Force heading.alignment + layout.columnAlignment to center (typical for icon-only links) |
--clear-cache | string | Clear-cache target (defaults to —target-page). Single page number; CSV not yet supported | |
--column | string | Column id (NAME) to rewrite [required] | |
--dry-run | Print the rewritten file content to stdout without writing | ||
--force | Reserved for future use | ||
--heading | string | Override heading.heading text (default: keep existing heading) | |
--item-pair | strings | Repeatable NAME=VALUE pair to splice into target.items (use #COL# tokens to pass the row’s column value) | |
--link-text | string | HTML / text rendered as the link body (defaults to the edit-pencil icon) (default “<img src=“#IMAGE_PREFIX#app_ui/img/icons/apex-edit-pencil.png” class=“apex-edit-pencil” alt="">“) | |
--no-refresh-on-close | Suppress the auto-created refresh-on-dialog-close dynamicAction (overrides —refresh-on-close) | ||
--page | string | Target page that hosts the report region (numeric ID, alias, or name) [required] | |
--refresh-on-close | true | When —target-page is a modal page, also splice a refresh-on-dialog-close dynamicAction on the report region so it refreshes after the dialog saves & closes. No-op for non-modal targets | |
--refresh-region | string | Region to refresh after the dialog closes (default: —region, the report hosting the link) | |
--region | string | Parent region id on the page (must be classicReport or interactiveReport) [required] | |
--target-page | int | Page number the link opens [required] |
Global Flags
Section titled “Global Flags”| Flag | Type | Default | Description |
|---|---|---|---|
--app-dir | string | . | Path to the APEX application directory |
--json-pretty | Output in pretty-printed JSON (human-readable) instead of minified JSON | ||
--toon | Output in TOON format (human-readable, token-efficient) instead of JSON |
Examples (from help)
Section titled “Examples (from help)”uc-apx create link-column \ --page 131 --region customer-issues --column ID \ --target-page 129 \ --item-pair P129_CUSTOMER_ID=#CUSTOMER_ID# \ --item-pair P129_ID=#ID#