Skip to content

uc-apx edit page-item

Edit an existing pageItem <ID> ( ... ) on a page. Common rewrites:

  • relabel an item (—label);
  • switch a text field to a select list backed by an LOV (—type + —lov);
  • add a PL/SQL function-body default (—default-plsql);
  • mark an item required (—required) or read-only (—readonly);
  • set or remove help text (—help-text).

Each flag corresponds to a single property or block. Combine flags to apply multiple changes in one shot; the item is re-parsed after the edits to fail-fast on a broken splice.

uc-apx edit page-item [flags]
FlagTypeDefaultDescription
--default-plsqlSet default.type: functionBody + plsqlFunctionBody: <body>. Body is wrapped in a `plsql code block. Accepts @path/to/file.plsql to read from disk; @@ escapes a literal leading @.
--default-staticstringSet default.type: static + staticValue: <value>.
--dry-runPrint the rewritten file content to stdout without writing
--help-textstringSet help.helpText to this text. Pass an empty string (—help-text "") to remove the help block.
--itemstringPage item ID to edit (e.g. P7_CUSTOMER_NAME) [required]
--labelstringRewrite label.label to this text.
--lovstringSet lov.type: sharedComponent + lov: @<alias>. Strip a leading @ if present.
--lov-sqlstringSet lov.type: sqlQuery with the given SELECT (must return (display, return) pairs). Accepts @path/to/file.sql to read from disk; @@ escapes a literal leading @.
--lov-staticstringSet lov.type: staticValues with entries “Display1;Return1,Display2;Return2”.
--null-display-valuestringSet lov.nullDisplayValue. Only meaningful when the item uses an LOV.
--pagestringTarget page (numeric ID, alias, or name) [required]
--readonlyAdd readOnly { type: always } so end-users cannot edit the item.
--requiredSet validation.valueRequired: true. Pass —required=false to remove the property (tri-state: omitting the flag leaves valueRequired unchanged).
--typetype:Rewrite top type: property. Accepts kebab-case (text-field, select-list, radio-group, popup-lov, date-picker, number-field, display-only, hidden, textarea, switch, checkbox, checkbox-group, password, …) or the raw apexlang token.
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 edit page-item --page 7 --item P7_CUSTOMER_NAME \
--label "Customer Full Name" --required
uc-apx edit page-item --page 7 --item P7_COUNTRY_CODE \
--type select-list --lov @countries-lov \
--null-display-value '- Select Country -'
uc-apx edit page-item --page 7 --item P7_NOTE \
--help-text "Enter any additional notes."