uc-apx create region interactive-grid

Insert a new interactiveGrid region. Source can be a local-database table (—table, default editable with auto row processing) or an inline SQL query (—sql, read-only by default). Exactly one of —table or —sql is required. The —column list must include the primary key.

—where <expr> appends a whereClause: to the source block (table mode only — for —sql, write the WHERE inline in your query).

Usage

uc-apx create region interactive-grid [flags]

Flags

Flag	Type	Default	Description
--column	string		Comma-separated columns. Syntax: NAME[:TYPE[:LENGTH]]. TYPE ∈ varchar2 (default), number, date, timestamp, clob. At least one column is required [required]
--column-span	int		12-col grid span for the region’s layout (0 = omit; e.g. 6 for a half-width region)
--dry-run			Print rendered region to stdout without writing
--force			Reserved for future use
--id	string		Region id (default: kebab-case of —name)
--name	string		Display name of the region [required]
--page	string		Target page (numeric ID, alias, or name) [required]
--sequence	int		Layout sequence (default: max existing + 10)
--slot	string	body	Page slot to place the region in
--sql	string		Inline SQL query (or @path/to/file.sql to read from disk; @@ escapes a literal leading @; mutually exclusive with —table)
--table	string		Local-database table (mutually exclusive with —sql)
--where	string		WHERE clause appended to the table-mode source block (rejected with —sql; write the WHERE inline there)

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

Example Generated APEXlang

Using --dry-run to preview the generated construct (no files are written):

uc-apx --app-dir examples/brookstrut create region interactive-grid --page 46 --name Product Grid --table OOW_DEMO_PRODUCTS --column PRODUCT_ID:number,PRODUCT_NAME:varchar2:100 --pk-column PRODUCT_ID --dry-run

Generated APEXlang

region product-grid (
        name: Product Grid
        type: interactiveGrid
        source {
            location: localDatabase
            tableName: OOW_DEMO_PRODUCTS
        }
        layout {
            sequence: 50
            slot: body
        }
        appearance {
            template: @/standard
            templateOptions: #DEFAULT#
        }
        edit {
            enabled: true
            allowedOperations: [
                add
                update
                delete
            ]
        }
        toolbar {
            controls: [
                searchCol
                searchField
                actionsMenu
                resetButton
                saveButton
            ]
        }
        pagination {
            type: scroll
        }

        savedReport 1 (
            visibility: primary
            view {
                default: grid
            }
            singleRowView {
                displayedColumns: true
            }

            displayColumn (
                column: @PRODUCT_ID
                layout {
                    sequence: 1
                }
            )

            displayColumn (
                column: @PRODUCT_NAME
                layout {
                    sequence: 2
                }
            )
        )

        column PRODUCT_ID (
            type: hidden
            layout {
                sequence: 10
            }
            source {
                databaseColumn: PRODUCT_ID
                dataType: number
                primaryKey: true
                queryOnly: true
            }
        )

        column PRODUCT_NAME (
            type: textField
            heading {
                heading: Product Name
            }
            layout {
                sequence: 20
            }
            source {
                databaseColumn: PRODUCT_NAME
                dataType: varchar2
            }
            validation {
                maxLength: 100
            }
        )
    )

    process process-product-grid (
        name: Process Interactive Grid product-grid
        type: interactiveGridAutoRowProcessing
        editableRegion: @product-grid
        execution {
            sequence: 10
        }
    )