Skip to content

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]
FlagTypeDefaultDescription
--centercentertrueForce heading.alignment + layout.columnAlignment to center (typical for icon-only links)
--clear-cachestringClear-cache target (defaults to —target-page). Single page number; CSV not yet supported
--columnstringColumn id (NAME) to rewrite [required]
--dry-runPrint the rewritten file content to stdout without writing
--forceReserved for future use
--headingstringOverride heading.heading text (default: keep existing heading)
--item-pairstringsRepeatable NAME=VALUE pair to splice into target.items (use #COL# tokens to pass the row’s column value)
--link-textstringHTML / 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-closeSuppress the auto-created refresh-on-dialog-close dynamicAction (overrides —refresh-on-close)
--pagestringTarget page that hosts the report region (numeric ID, alias, or name) [required]
--refresh-on-closetrueWhen —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-regionstringRegion to refresh after the dialog closes (default: —region, the report hosting the link)
--regionstringParent region id on the page (must be classicReport or interactiveReport) [required]
--target-pageintPage number the link opens [required]
FlagTypeDefaultDescription
--app-dirstring.Path to the APEX application directory
--json-prettyOutput in pretty-printed JSON (human-readable) instead of minified JSON
--toonOutput in TOON format (human-readable, token-efficient) instead of JSON
Terminal window
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#