pgkiln 0.71.0 → 0.73.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/db/migrations/139_opentelemetry.sql +36 -0
- package/db/migrations/140_item_region_types.sql +27 -0
- package/docs/apex-feature-parity.md +86 -9
- package/docs/guide/01-installation.md +108 -0
- package/docs/guide/03-builder.md +9 -0
- package/docs/guide/04-pages-and-regions.md +41 -1
- package/docs/guide/05-items.md +43 -3
- package/docs/guide/09-reference.md +3 -0
- package/docs/guide/11-from-apex.md +3 -0
- package/docs/guide/12-development.md +23 -2
- package/examples/hr/hr_75_item_region_types.sql +81 -0
- package/package.json +1 -1
- package/public/app.css +48 -0
- package/public/app.js +427 -1
- package/public/builder.css +3 -0
- package/src/ai/service.ts +14 -0
- package/src/app.ts +10 -0
- package/src/builder/advisor.ts +5 -1
- package/src/builder/arrange.ts +7 -0
- package/src/builder/components.ts +5 -5
- package/src/builder/designer.ts +8 -2
- package/src/builder/home.ts +1 -0
- package/src/builder/i18n/de.ts +8 -0
- package/src/builder/i18n/en.ts +8 -0
- package/src/builder/i18n/es.ts +8 -0
- package/src/builder/i18n/fr.ts +8 -0
- package/src/builder/i18n/it.ts +8 -0
- package/src/builder/i18n/ja.ts +8 -0
- package/src/builder/i18n/ko.ts +8 -0
- package/src/builder/i18n/nl.ts +8 -0
- package/src/builder/i18n/pt.ts +8 -0
- package/src/builder/i18n/zh-cn.ts +8 -0
- package/src/builder/i18n/zh-tw.ts +8 -0
- package/src/builder/region-help.ts +8 -2
- package/src/builder/telemetry.ts +206 -0
- package/src/builder/workspaces.ts +2 -1
- package/src/i18n/ar.ts +13 -0
- package/src/i18n/cs.ts +13 -0
- package/src/i18n/da.ts +13 -0
- package/src/i18n/de.ts +13 -0
- package/src/i18n/el.ts +13 -0
- package/src/i18n/es.ts +13 -0
- package/src/i18n/fi.ts +13 -0
- package/src/i18n/fr.ts +13 -0
- package/src/i18n/he.ts +13 -0
- package/src/i18n/it.ts +13 -0
- package/src/i18n/ja.ts +13 -0
- package/src/i18n/ko.ts +13 -0
- package/src/i18n/nb.ts +13 -0
- package/src/i18n/pl.ts +13 -0
- package/src/i18n/pt.ts +13 -0
- package/src/i18n/ru.ts +13 -0
- package/src/i18n/sv.ts +13 -0
- package/src/i18n/tr.ts +13 -0
- package/src/i18n/uk.ts +13 -0
- package/src/i18n/zh.ts +13 -0
- package/src/i18n.ts +26 -0
- package/src/instance-checks.ts +11 -4
- package/src/layout.ts +2 -1
- package/src/mail/mail.ts +14 -0
- package/src/metadata.ts +5 -2
- package/src/runtime/ai-agents.ts +9 -0
- package/src/runtime/items.ts +32 -3
- package/src/runtime/page-regions.ts +50 -0
- package/src/runtime/region-cache.ts +1 -1
- package/src/runtime/regions.ts +11 -0
- package/src/runtime/render.ts +3 -17
- package/src/runtime/report.ts +55 -3
- package/src/runtime/routes.ts +3 -0
- package/src/session.ts +26 -0
- package/src/telemetry/browser.ts +91 -0
- package/src/telemetry/config.ts +342 -0
- package/src/telemetry/export.ts +484 -0
- package/src/telemetry/http.ts +126 -0
- package/src/telemetry/trace.ts +456 -0
- package/src/webclient.ts +25 -0
- package/src/workflow.ts +14 -7
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
-- =====================================================================
|
|
2
|
+
-- 139: OpenTelemetry (sprint 139, AP-6; APEX: Workspace Utilities →
|
|
3
|
+
-- OpenTelemetry)
|
|
4
|
+
--
|
|
5
|
+
-- The instance's collector and its choices are instance settings in
|
|
6
|
+
-- meta.setting (otel_*: enabled, endpoint, service name, sample ratio,
|
|
7
|
+
-- user attribute, values, signals, builder requests, browser spans;
|
|
8
|
+
-- metrics_endpoint for GET /metrics) and, as only the owner reads it,
|
|
9
|
+
-- meta.instance_setting (otel_headers_enc: headers encrypted with the
|
|
10
|
+
-- instance key; metrics_token_hash), else the standard OTEL_*
|
|
11
|
+
-- environment variables (src/telemetry/config.ts). No table needed.
|
|
12
|
+
--
|
|
13
|
+
-- meta.workspace.telemetry: what the workspace's applications send:
|
|
14
|
+
-- 'instance' (the default: the instance's collector, when there is one),
|
|
15
|
+
-- 'off' (nothing, not even to the instance's), 'own' (also to the
|
|
16
|
+
-- workspace's own collector, telemetry_endpoint, an OTLP/HTTP base URL
|
|
17
|
+
-- reached through the workspace's network access list and the
|
|
18
|
+
-- installation's allow-list). telemetry_headers_enc: headers for it
|
|
19
|
+
-- (an API key), encrypted like a web credential's secret, write-only.
|
|
20
|
+
-- telemetry_values: send SQL statements with their literals, bind
|
|
21
|
+
-- values, query strings and tool arguments to the own collector.
|
|
22
|
+
-- Installation data: not in the workspace export.
|
|
23
|
+
-- =====================================================================
|
|
24
|
+
|
|
25
|
+
alter table meta.workspace
|
|
26
|
+
add column telemetry text not null default 'instance' constraint workspace_telemetry_ok check (telemetry in ('instance', 'off', 'own')),
|
|
27
|
+
add column telemetry_endpoint text constraint workspace_telemetry_endpoint_ok
|
|
28
|
+
check (telemetry_endpoint is null or (telemetry_endpoint ~ '^https?://[^\s#@]+$' and length(telemetry_endpoint) <= 500)),
|
|
29
|
+
add column telemetry_headers_enc text,
|
|
30
|
+
add column telemetry_values boolean not null default false,
|
|
31
|
+
add constraint workspace_telemetry_own check (telemetry <> 'own' or telemetry_endpoint is not null);
|
|
32
|
+
|
|
33
|
+
comment on column meta.workspace.telemetry is 'OpenTelemetry of the workspace''s applications: instance (the instance''s collector), off, own (also its own collector) (139)';
|
|
34
|
+
comment on column meta.workspace.telemetry_endpoint is 'The workspace''s own OTLP/HTTP collector (base URL; /v1/traces and /v1/logs are appended) (139)';
|
|
35
|
+
comment on column meta.workspace.telemetry_headers_enc is 'Headers for the own collector, encrypted with PGKILN_SECRET_KEY (139)';
|
|
36
|
+
comment on column meta.workspace.telemetry_values is 'The own collector also receives values: SQL literals, bind values, query strings (139)';
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
-- Sprint 140 (AP-4): item and region types that were still missing from the Page Designer's gallery.
|
|
2
|
+
--
|
|
3
|
+
-- Items: shuttle two lists (available, chosen) with move and order buttons; a <select multiple> without JavaScript
|
|
4
|
+
-- select_one a searchable single pick from a list of values; a <select> without JavaScript
|
|
5
|
+
-- select_many a searchable multi pick with chips; a <select multiple> without JavaScript
|
|
6
|
+
-- (shuttle and select_many store their values colon-separated, like multiselect)
|
|
7
|
+
-- Regions: classic_report a report without the Actions menu and the interactive features (report templates, pagination types)
|
|
8
|
+
-- breadcrumb the page's breadcrumb trail (for the Breadcrumb bar position)
|
|
9
|
+
-- help_text the page's help text (meta.page.help, new here)
|
|
10
|
+
|
|
11
|
+
alter table meta.item drop constraint item_type_check;
|
|
12
|
+
alter table meta.item add constraint item_type_check check (type in (
|
|
13
|
+
'text', 'textarea', 'number', 'date', 'datetime', 'select', 'radio', 'checkbox', 'switch', 'hidden', 'display', 'password',
|
|
14
|
+
'checkbox_group', 'multiselect', 'popup_lov', 'email', 'tel', 'url', 'color', 'file', 'location', 'richtext', 'markdown',
|
|
15
|
+
'rating', 'combobox', 'daterange', 'qrcode', 'plugin', 'image', 'address',
|
|
16
|
+
'shuttle', 'select_one', 'select_many'));
|
|
17
|
+
|
|
18
|
+
alter table meta.region drop constraint region_type_check;
|
|
19
|
+
alter table meta.region add constraint region_type_check
|
|
20
|
+
check (type in ('report', 'form', 'chart', 'cards', 'static', 'grid', 'calendar', 'dynamic', 'facets', 'tasks', 'workflows', 'map', 'tree',
|
|
21
|
+
'template_component', 'smart_filters', 'display_selector', 'list', 'data_reporter', 'ai_assistant', 'plugin', 'url', 'search',
|
|
22
|
+
'login', 'form_designer', 'classic_report', 'breadcrumb', 'help_text'));
|
|
23
|
+
|
|
24
|
+
-- (APEX: Page → Help → Help Text) Markdown with &ITEM. substitutions, shown by a help_text region of the page.
|
|
25
|
+
-- Nullable, so exports of older versions import as they are (export_app and import_app copy every page column).
|
|
26
|
+
alter table meta.page add column help text check (help is null or length(help) <= 20000);
|
|
27
|
+
comment on column meta.page.help is 'The page''s help text (Markdown, &ITEM. substitutions), shown by a region of type help_text.';
|
|
@@ -7,24 +7,24 @@ open item and open an issue or pull request; see [CONTRIBUTING.md](../CONTRIBUTI
|
|
|
7
7
|
Legend: ✅ available · 🟡 partial (see notes) · ❌ not yet · ➖ not planned (a deliberate choice,
|
|
8
8
|
or better served by the PostgreSQL ecosystem; see the notes and [extensions](guide/15-extensions.md))
|
|
9
9
|
|
|
10
|
-
Last reviewed: 2026-11-03 against **APEX 26.2** (sprint 138: an application's Utilities tab with a dashboard, database object dependencies, change history per component, Upgrade application, UI defaults (APEX's Attribute Dictionary), application and page checksums and an icon browser (AP-5); sprint 137: Create page as a grid of page types with previews, the page types interactive report, smart filters, search page, data loading, tree, timeline, media list, content row, comments, dashboard, wizard, unified task list and workflow console, a Feature tab with nine features that install once, and Create page as copy with shared components mapped or copied (AP-3); sprint 136: vector providers (an AI service with an embedding model or a SQL function), `meta.embed`, *Add vector column* in Table Properties with an HNSW index and a queue that keeps embeddings current, search types vector and hybrid (reciprocal rank fusion with full-text) and a Retrieve (RAG) tool for AI agents, all as the app's role through RLS, on pgvector (AP-1); sprint 135: full-text search configurations, APEX's Oracle Text search type on PostgreSQL full-text search with stemming, ranking, highlights, *Did you mean* and *Add full-text search* in Table Properties (AP-2); sprint 134: the builder also in Italiano, 中文 (简体), 中文 (繁體), 日本語 and 한국어, APEX's ten builder languages plus Nederlands (SEC-5); sprints 121, 123–125: the builder in Deutsch, English, Español, Français, Nederlands and Português, step by step: the frame, sign-in, Workspace home, App Builder, Page Designer menus, the SQL Workshop's home, SQL Worksheet, Object Browser and Table Properties, Shared Components, application settings, users, identity providers, developers and workspaces (WS-7); sprint 122: *Ask in your own words* sets faceted search and smart filter facets, smart filters read a typed phrase (WS-5), and Sample Maps, Sample Approvals, Sample Data Loading and Sample Files in the App Gallery (WS-8); sprint 120: the App Gallery's single-topic sample apps (charts, cards, calendar, interactive grids, dynamic actions, reporting), the UX Pattern Catalog and a Utility Apps tab with Lookup Lists, Release Notes and Announcements (WS-8); sprint 119: data security per table, a roles × columns matrix and masked values per application role in a masking view, the same identity for pages, AI tools, REST, AutoREST and MCP (WS-13); sprint 118: Administration → Mail queue with delivery per hour and per workspace, the slowest provider calls and failures with Retry and Purge, a workspace's own mail service, and workspace network access lists that narrow the installation's allow-list (WS-9); sprint 117: Pillar Light and Pillar Dark navigation appearances with a header strip, clearer navigation tree states, subtle colour utilities, RTL; sprint 116: the comparison moved from 26.1 to 26.2, with a section for the 26.2 workspace items WS-1 … WS-13 and OCI managed identities; the App Builder list with Updated by, working copies and the lock; `pgkiln import --only`, a file-level import; stale rows on facet menus and blueprints fixed; sprint 115: popup LOVs that load on scroll, Wait Popup dynamic actions and dynamic actions on menu entries; sprint 114: Workflow 26.2 with custom task outcomes, task events and notifications, Send E-Mail and draft steps, migrating running instances and the diagram as SVG / PNG; sprint 113: Team Development with issues, labels, milestones, templates, a board and a set-up wizard; sprint 112: AI interactive reports with chips, Undo, computed columns and a phrase parser that needs no AI service; sprint 111: AI Agents with tools as a shared component, a Navigate tool with checksummed URLs, Gemini and OpenAI-compatible services; sprint 110: Data Reporter as a workspace tool with datasets, reporting applications, editors and viewers, published reports with stable URLs and pins; sprint 109: the Workspace home above the App Builder and SQL Workshop, with a summary, top applications, users and developers, and an optional release check; sprint 108: the code editor's syntax colours in the builder's light and dark themes, read-only SQL highlighted, the Data Modeler in dark mode; sprint 107: a transaction mode in the SQL Worksheet with Commit and Rollback; DA-18: JavaScript (MLE) not planned, plv8 where installed; sprint 106: the change log of DDL change sets with Flyway, Liquibase and SQL downloads; sprint 104: RESTful Services modules, templates and handlers with PL/pgSQL and media handlers, privileges, OpenAPI and Try it; sprint 103: Schema Export / Import with pg_dump and pg_restore; sprint 102: the SQL Monitor with live sessions, Top SQL and a statement's plan; sprint 101: Scheduling of pg_cron jobs with a schedule builder, run now and run history; sprint 100: RESTful Services, tables and views published as REST endpoints with paging, filters, keys and OpenAPI; sprint 99: Administration → Database Users for PostgreSQL roles; sprint 98: the Data Modeler with relational diagrams, DDL and a data dictionary; sprint 97: charts of a query in the worksheet, saved charts and their dashboard; sprint 96: the SQL Workshop's Launchpad with pins and tool groups, the builder's search with Ctrl+K; sprint 95: Table Properties: create, edit or copy a table in a form with a DDL preview and Apply in one transaction; sprint 94: an object's menu with Open in a panel, Quick DDL, Add index / trigger / policy and Drop with dependents; sprint 93: worksheets saved as SQL Scripts with tabs and a Files list, Format, Convert case, find and replace, bind and substitution variables; sprint 92: the worksheet's Query Result with sort, value dialog, copy and downloads, plans as a tree with the slowest step and misestimates, SQL History with status, search and run again; sprint 91: the SQL Worksheet like Database Actions' SQL: navigator, Run Statement at the cursor and Run Script with a log per statement, Explain Plan, Autotrace, notices, history, Run as an application role; sprint 90: Comment Out in the page designer, gallery labels in title case; sprint 89: the Object Browser's schema, one row of tabs, blank NULLs, Modify column; sprint 88: home cards with colour bands and round icons, the hero on the page background, a page footer with the version and Back to top; sprint 87: the Create Application wizard reloads the page list for a schema, RLS badges, the alias from the name; sprint 86: the page designer by page number, HTML error pages in the builder; sprint 85: the Form Designer, beyond APEX; sprint 84: the date picker, facet menus; sprint 83: Component Settings and Component Groups; sprint 82: Report Queries; sprint 81: Application Computations and Shortcuts in Shared Components; sprint 80: the master grid's first row selected when the page opens and after a search; grid cells as text with their format mask until edited, with cell navigation by arrow keys, Enter, F2 and Escape; sprint 79: generated dashboards with sums, donuts and lines, leaving out charts that say nothing; applications open in their own light or dark mode until the user chooses, per application; a user menu with Appearance and Sign in when signed out; the developer toolbar's App and Page texts and debug state; the report search's column scope in the magnifier; sprint 78: generated faceted search reports with one column per foreign key, the faceted search's total row count, Show all and Yes/No values, one search field, friendly headings and number formats in generated grids and master-detail pages, friendly names in the Create Application wizard's page list; sprint 77: the Page Designer's layout and tree by display position, button positions, the tree's context menu with Duplicate and Copy to other page, Show Common / Show All, Go to group and the Template Options dialog; display positions, button positions and side-column page templates at runtime; sprint 76: the interactive report's menus and pagination, date items in the date format; sprint 75: the SQL Workshop's Object Browser and tabs; sprint 74: the builder's information architecture: Shared Components grid, Settings tabs, application home search and tasks; sprint 73: the Create Application wizard on one page with page types and features; sprint 72: the runtime chrome compared with APEX 26.2's: the developer toolbar, the Iris look, the navigation bar's Help menu and Install button; sprint 71: generated applications compared with APEX 26.2's: labels, foreign key names in reports, file columns, format masks, the Home page and the dashboard; sprint 70: treemap, sunburst and timeline charts; sprint 69: dragging tasks on a Gantt chart; sprint 68: the Data Reporter's welcome page, Find my workspace; sprint 67: REST source catalogs from OpenAPI documents, a workspace's export and import (two rows added); sprint 66: a blueprint from an existing application; sprint 65: facet charts; sprint 64: approval vacation rules and expiration policies; sprint 63: range, box plot and stock charts; sprint 62: workspace preferences (SQL Workshop and RESTful services per workspace), extension links, Manage backups across applications, SQL Workshop utilities with object reports, About Database and a database monitor; sprint 61: the builder's screens compared with APEX 26.1: the workspace sign-in page, the Administration menu with workspace message, environment banner and utilization, the SQL Workshop home, the App Gallery, application groups and cross application reports (four rows added); sprint 60: isolated workspaces with their own database logins, row-level security on pgkiln's tables and workspace database roles, workspace administrators; sprint 59: the Page Designer's help pane, Quick edit from the developer toolbar; sprint 58: page groups; sprint 57: region templates hero, title bar, buttons container, inline dialog and drawer, wizard with wizard progress, the carousel; sprint 56: Generate DDL and Schema Comparison in the SQL Workshop, `pgkiln ddl` and `pgkiln compare`; sprint 55: an editable login page with a Login region and the Minimal page template, Forgot password through the application's mail service; sprint 54: interactive grid views, the single row view, group by and chart; sprint 53: application settings, user preferences and items kept per user, dynamic translations, `meta.data_export` and data export downloads, display image and geocoded address items; sprint 52: every dynamic action event and action, Ajax callbacks, an error handling function, the session timeout warning; sprint 51: checked imports, application backups, availability and Run only, feedback, type-specific attribute help; sprint 50: lost update detection, warn on unsaved changes, the URL and search regions with search configurations, the developer toolbar with a session state viewer, and e-mail through SMTP with OAuth2, Microsoft Graph, Amazon SES and HTTP APIs; import checks, application availability, property help and e-mail compared again; 2026-10-06: pgkiln 0.31.0, in progress: static application files and the Execute JavaScript dynamic action; region, item, dynamic action and process plug-ins; conditional and dynamic theme styles; XML and Excel in `meta.parse_data`, zips in SQL, `meta.v_boolean`; file items in S3-compatible object storage; map layers by the visible area and as vector tiles; a graphical query builder; tenants for workflows and tasks; application files as YAML and region static IDs; Lucide icons and icon modifiers; PWA push notifications; 0.30.0: 136 icons and an icon picker; an axe-core accessibility audit; cropping pictures; session sharing between applications; twenty-two built-in languages; 0.29.0: workspaces; the Iris base style; drawers; built-in template components including the metric card; Theme Roller dark-mode colours, live preview and template options on items and report columns; report selection across pages; instance settings; fourteen built-in languages; 0.28.0: AI with Claude and OpenAI; 0.27.0: Data Reporter; sample data generator; create application from several sheets, pasted data or existing tables; 0.26.0: working copies with a three-way merge; theme, library and boilerplate applications with subscriptions; 0.25.0: Gantt, pyramid and polar charts; map layers, clustering and server-side spatial filters; REST data sources that write back from forms and grids and synchronise into tables, OAuth2 password and refresh-token grants; debug messages per request and an install/upgrade log; `meta.web_request()` and `meta.parse_data()`; Theme Roller style variants and template options; 0.24.0: automations with several actions, error handling per row and runs from SQL; invoke-API workflow steps; Unload Data in the Data Workshop; create page wizards for cards, calendar, chart, map, faceted search, form and master-detail; create an application from a file; 0.23.0: interactive grid aggregates, frozen/moved/resized columns, layouts and saved grid reports, master-detail, row actions and copy/paste; download processes, execution chains in the background, workflow processes, branches to a function's URL or another app, the Dialog Closed event; number format masks, automatic time zone, runtime messages in German, French and Spanish; SQL scripts, Quick SQL, a query builder, XML loading and data load definitions; custom authentication, lists, page and application locks with developer comments, supporting objects; 0.22.0: keyset paging, report PDFs and REST collections streamed from a cursor, database-account authentication; 0.21.0: HTTP-header authentication behind a reverse proxy; 0.20.0: a popup list of values with server-side search; 0.19.0: row-range pagination, maximum row counts and row limits, lazy loading and caching of regions, streamed CSV/Excel downloads; 0.18.0: calendar week/day/list views with drag and drop, bubble/gauge/funnel/radar charts and drill-down, smart filters, a region display selector and more facet types, computations, conditional branches, build options, menu buttons, REST data sources and web credentials, rich text/Markdown, rating, combobox, date range and QR code items; 0.17.0: an App Builder home, workspace dashboard and utilities like APEX's; 0.16.0: a Page Designer with drag-and-drop layout, a code editor with autocomplete, template components and plug-ins, parallel branches and versions of workflows, the `pgkiln` command line with one file per component; 0.15.0: drop and paste files, heat maps, filtering a report by the map area; 0.14.0: stacked, combo, scatter and pie charts, several files per upload item; 0.13.0: map and tree regions; 0.12.0: REST modules in the builder; 0.11.0: workflows and Progressive Web Apps; 0.10.0: LDAP, SAML, "Keep me signed in", document templates, JSON loading, approvals and the task list; pgkiln installs no application, HR is an example).
|
|
10
|
+
Last reviewed: 2026-11-04 against **APEX 26.2** (sprint 140: the items Shuttle (ordered), Select One and Select Many, the regions Classic Report (report templates, pagination types), Breadcrumb and Help Text with a page help text, and a [mapping of every APEX item and region type](#item-and-region-types-one-by-one) (AP-4); sprint 139: OpenTelemetry, traces with a span per SQL statement, web call, AI request and tool call, logs, metrics and `/metrics` for Prometheus, browser spans relayed by pgkiln, per workspace off or its own collector (AP-6); sprint 138: an application's Utilities tab with a dashboard, database object dependencies, change history per component, Upgrade application, UI defaults (APEX's Attribute Dictionary), application and page checksums and an icon browser (AP-5); sprint 137: Create page as a grid of page types with previews, the page types interactive report, smart filters, search page, data loading, tree, timeline, media list, content row, comments, dashboard, wizard, unified task list and workflow console, a Feature tab with nine features that install once, and Create page as copy with shared components mapped or copied (AP-3); sprint 136: vector providers (an AI service with an embedding model or a SQL function), `meta.embed`, *Add vector column* in Table Properties with an HNSW index and a queue that keeps embeddings current, search types vector and hybrid (reciprocal rank fusion with full-text) and a Retrieve (RAG) tool for AI agents, all as the app's role through RLS, on pgvector (AP-1); sprint 135: full-text search configurations, APEX's Oracle Text search type on PostgreSQL full-text search with stemming, ranking, highlights, *Did you mean* and *Add full-text search* in Table Properties (AP-2); sprint 134: the builder also in Italiano, 中文 (简体), 中文 (繁體), 日本語 and 한국어, APEX's ten builder languages plus Nederlands (SEC-5); sprints 121, 123–125: the builder in Deutsch, English, Español, Français, Nederlands and Português, step by step: the frame, sign-in, Workspace home, App Builder, Page Designer menus, the SQL Workshop's home, SQL Worksheet, Object Browser and Table Properties, Shared Components, application settings, users, identity providers, developers and workspaces (WS-7); sprint 122: *Ask in your own words* sets faceted search and smart filter facets, smart filters read a typed phrase (WS-5), and Sample Maps, Sample Approvals, Sample Data Loading and Sample Files in the App Gallery (WS-8); sprint 120: the App Gallery's single-topic sample apps (charts, cards, calendar, interactive grids, dynamic actions, reporting), the UX Pattern Catalog and a Utility Apps tab with Lookup Lists, Release Notes and Announcements (WS-8); sprint 119: data security per table, a roles × columns matrix and masked values per application role in a masking view, the same identity for pages, AI tools, REST, AutoREST and MCP (WS-13); sprint 118: Administration → Mail queue with delivery per hour and per workspace, the slowest provider calls and failures with Retry and Purge, a workspace's own mail service, and workspace network access lists that narrow the installation's allow-list (WS-9); sprint 117: Pillar Light and Pillar Dark navigation appearances with a header strip, clearer navigation tree states, subtle colour utilities, RTL; sprint 116: the comparison moved from 26.1 to 26.2, with a section for the 26.2 workspace items WS-1 … WS-13 and OCI managed identities; the App Builder list with Updated by, working copies and the lock; `pgkiln import --only`, a file-level import; stale rows on facet menus and blueprints fixed; sprint 115: popup LOVs that load on scroll, Wait Popup dynamic actions and dynamic actions on menu entries; sprint 114: Workflow 26.2 with custom task outcomes, task events and notifications, Send E-Mail and draft steps, migrating running instances and the diagram as SVG / PNG; sprint 113: Team Development with issues, labels, milestones, templates, a board and a set-up wizard; sprint 112: AI interactive reports with chips, Undo, computed columns and a phrase parser that needs no AI service; sprint 111: AI Agents with tools as a shared component, a Navigate tool with checksummed URLs, Gemini and OpenAI-compatible services; sprint 110: Data Reporter as a workspace tool with datasets, reporting applications, editors and viewers, published reports with stable URLs and pins; sprint 109: the Workspace home above the App Builder and SQL Workshop, with a summary, top applications, users and developers, and an optional release check; sprint 108: the code editor's syntax colours in the builder's light and dark themes, read-only SQL highlighted, the Data Modeler in dark mode; sprint 107: a transaction mode in the SQL Worksheet with Commit and Rollback; DA-18: JavaScript (MLE) not planned, plv8 where installed; sprint 106: the change log of DDL change sets with Flyway, Liquibase and SQL downloads; sprint 104: RESTful Services modules, templates and handlers with PL/pgSQL and media handlers, privileges, OpenAPI and Try it; sprint 103: Schema Export / Import with pg_dump and pg_restore; sprint 102: the SQL Monitor with live sessions, Top SQL and a statement's plan; sprint 101: Scheduling of pg_cron jobs with a schedule builder, run now and run history; sprint 100: RESTful Services, tables and views published as REST endpoints with paging, filters, keys and OpenAPI; sprint 99: Administration → Database Users for PostgreSQL roles; sprint 98: the Data Modeler with relational diagrams, DDL and a data dictionary; sprint 97: charts of a query in the worksheet, saved charts and their dashboard; sprint 96: the SQL Workshop's Launchpad with pins and tool groups, the builder's search with Ctrl+K; sprint 95: Table Properties: create, edit or copy a table in a form with a DDL preview and Apply in one transaction; sprint 94: an object's menu with Open in a panel, Quick DDL, Add index / trigger / policy and Drop with dependents; sprint 93: worksheets saved as SQL Scripts with tabs and a Files list, Format, Convert case, find and replace, bind and substitution variables; sprint 92: the worksheet's Query Result with sort, value dialog, copy and downloads, plans as a tree with the slowest step and misestimates, SQL History with status, search and run again; sprint 91: the SQL Worksheet like Database Actions' SQL: navigator, Run Statement at the cursor and Run Script with a log per statement, Explain Plan, Autotrace, notices, history, Run as an application role; sprint 90: Comment Out in the page designer, gallery labels in title case; sprint 89: the Object Browser's schema, one row of tabs, blank NULLs, Modify column; sprint 88: home cards with colour bands and round icons, the hero on the page background, a page footer with the version and Back to top; sprint 87: the Create Application wizard reloads the page list for a schema, RLS badges, the alias from the name; sprint 86: the page designer by page number, HTML error pages in the builder; sprint 85: the Form Designer, beyond APEX; sprint 84: the date picker, facet menus; sprint 83: Component Settings and Component Groups; sprint 82: Report Queries; sprint 81: Application Computations and Shortcuts in Shared Components; sprint 80: the master grid's first row selected when the page opens and after a search; grid cells as text with their format mask until edited, with cell navigation by arrow keys, Enter, F2 and Escape; sprint 79: generated dashboards with sums, donuts and lines, leaving out charts that say nothing; applications open in their own light or dark mode until the user chooses, per application; a user menu with Appearance and Sign in when signed out; the developer toolbar's App and Page texts and debug state; the report search's column scope in the magnifier; sprint 78: generated faceted search reports with one column per foreign key, the faceted search's total row count, Show all and Yes/No values, one search field, friendly headings and number formats in generated grids and master-detail pages, friendly names in the Create Application wizard's page list; sprint 77: the Page Designer's layout and tree by display position, button positions, the tree's context menu with Duplicate and Copy to other page, Show Common / Show All, Go to group and the Template Options dialog; display positions, button positions and side-column page templates at runtime; sprint 76: the interactive report's menus and pagination, date items in the date format; sprint 75: the SQL Workshop's Object Browser and tabs; sprint 74: the builder's information architecture: Shared Components grid, Settings tabs, application home search and tasks; sprint 73: the Create Application wizard on one page with page types and features; sprint 72: the runtime chrome compared with APEX 26.2's: the developer toolbar, the Iris look, the navigation bar's Help menu and Install button; sprint 71: generated applications compared with APEX 26.2's: labels, foreign key names in reports, file columns, format masks, the Home page and the dashboard; sprint 70: treemap, sunburst and timeline charts; sprint 69: dragging tasks on a Gantt chart; sprint 68: the Data Reporter's welcome page, Find my workspace; sprint 67: REST source catalogs from OpenAPI documents, a workspace's export and import (two rows added); sprint 66: a blueprint from an existing application; sprint 65: facet charts; sprint 64: approval vacation rules and expiration policies; sprint 63: range, box plot and stock charts; sprint 62: workspace preferences (SQL Workshop and RESTful services per workspace), extension links, Manage backups across applications, SQL Workshop utilities with object reports, About Database and a database monitor; sprint 61: the builder's screens compared with APEX 26.1: the workspace sign-in page, the Administration menu with workspace message, environment banner and utilization, the SQL Workshop home, the App Gallery, application groups and cross application reports (four rows added); sprint 60: isolated workspaces with their own database logins, row-level security on pgkiln's tables and workspace database roles, workspace administrators; sprint 59: the Page Designer's help pane, Quick edit from the developer toolbar; sprint 58: page groups; sprint 57: region templates hero, title bar, buttons container, inline dialog and drawer, wizard with wizard progress, the carousel; sprint 56: Generate DDL and Schema Comparison in the SQL Workshop, `pgkiln ddl` and `pgkiln compare`; sprint 55: an editable login page with a Login region and the Minimal page template, Forgot password through the application's mail service; sprint 54: interactive grid views, the single row view, group by and chart; sprint 53: application settings, user preferences and items kept per user, dynamic translations, `meta.data_export` and data export downloads, display image and geocoded address items; sprint 52: every dynamic action event and action, Ajax callbacks, an error handling function, the session timeout warning; sprint 51: checked imports, application backups, availability and Run only, feedback, type-specific attribute help; sprint 50: lost update detection, warn on unsaved changes, the URL and search regions with search configurations, the developer toolbar with a session state viewer, and e-mail through SMTP with OAuth2, Microsoft Graph, Amazon SES and HTTP APIs; import checks, application availability, property help and e-mail compared again; 2026-10-06: pgkiln 0.31.0, in progress: static application files and the Execute JavaScript dynamic action; region, item, dynamic action and process plug-ins; conditional and dynamic theme styles; XML and Excel in `meta.parse_data`, zips in SQL, `meta.v_boolean`; file items in S3-compatible object storage; map layers by the visible area and as vector tiles; a graphical query builder; tenants for workflows and tasks; application files as YAML and region static IDs; Lucide icons and icon modifiers; PWA push notifications; 0.30.0: 136 icons and an icon picker; an axe-core accessibility audit; cropping pictures; session sharing between applications; twenty-two built-in languages; 0.29.0: workspaces; the Iris base style; drawers; built-in template components including the metric card; Theme Roller dark-mode colours, live preview and template options on items and report columns; report selection across pages; instance settings; fourteen built-in languages; 0.28.0: AI with Claude and OpenAI; 0.27.0: Data Reporter; sample data generator; create application from several sheets, pasted data or existing tables; 0.26.0: working copies with a three-way merge; theme, library and boilerplate applications with subscriptions; 0.25.0: Gantt, pyramid and polar charts; map layers, clustering and server-side spatial filters; REST data sources that write back from forms and grids and synchronise into tables, OAuth2 password and refresh-token grants; debug messages per request and an install/upgrade log; `meta.web_request()` and `meta.parse_data()`; Theme Roller style variants and template options; 0.24.0: automations with several actions, error handling per row and runs from SQL; invoke-API workflow steps; Unload Data in the Data Workshop; create page wizards for cards, calendar, chart, map, faceted search, form and master-detail; create an application from a file; 0.23.0: interactive grid aggregates, frozen/moved/resized columns, layouts and saved grid reports, master-detail, row actions and copy/paste; download processes, execution chains in the background, workflow processes, branches to a function's URL or another app, the Dialog Closed event; number format masks, automatic time zone, runtime messages in German, French and Spanish; SQL scripts, Quick SQL, a query builder, XML loading and data load definitions; custom authentication, lists, page and application locks with developer comments, supporting objects; 0.22.0: keyset paging, report PDFs and REST collections streamed from a cursor, database-account authentication; 0.21.0: HTTP-header authentication behind a reverse proxy; 0.20.0: a popup list of values with server-side search; 0.19.0: row-range pagination, maximum row counts and row limits, lazy loading and caching of regions, streamed CSV/Excel downloads; 0.18.0: calendar week/day/list views with drag and drop, bubble/gauge/funnel/radar charts and drill-down, smart filters, a region display selector and more facet types, computations, conditional branches, build options, menu buttons, REST data sources and web credentials, rich text/Markdown, rating, combobox, date range and QR code items; 0.17.0: an App Builder home, workspace dashboard and utilities like APEX's; 0.16.0: a Page Designer with drag-and-drop layout, a code editor with autocomplete, template components and plug-ins, parallel branches and versions of workflows, the `pgkiln` command line with one file per component; 0.15.0: drop and paste files, heat maps, filtering a report by the map area; 0.14.0: stacked, combo, scatter and pie charts, several files per upload item; 0.13.0: map and tree regions; 0.12.0: REST modules in the builder; 0.11.0: workflows and Progressive Web Apps; 0.10.0: LDAP, SAML, "Keep me signed in", document templates, JSON loading, approvals and the task list; pgkiln installs no application, HR is an example).
|
|
11
11
|
|
|
12
12
|
## At a glance
|
|
13
13
|
|
|
14
14
|
| Area | ✅ | 🟡 | ❌ | ➖ | In short |
|
|
15
15
|
|---|---:|---:|---:|---:|---|
|
|
16
16
|
| App Builder and development | 22 | 0 | 0 | 0 | Page Designer with drag-and-drop and a code editor, wizards, search, where used, an Advisor, a CLI with one file per component, page locks and comments, supporting objects, working copies with a three-way merge, theme/library/boilerplate apps with subscriptions; App Builder AI (pages, SQL and table descriptions) |
|
|
17
|
-
| Regions |
|
|
18
|
-
| Items |
|
|
17
|
+
| Regions | 24 | 0 | 0 | 0 | All everyday regions incl. classic reports with report templates, breadcrumb and help text regions, a search region over search configurations and a URL region; twenty-two chart types with drill-down; calendars with week/day/list views and drag and drop; faceted search, smart filters and a region display selector; interactive reports with breaks, aggregates, highlights, compute, group by, pivot, chart view and saved reports; interactive grids with single row, group by and chart views; maps (with vector tiles) and trees; template components; row ranges, lazy loading and region caching for large tables |
|
|
18
|
+
| Items | 15 | 0 | 0 | 0 | All common items incl. shuttle, Select One and Select Many, file upload (several files per item), rich text and Markdown editors, star rating, combobox, date range, QR code, password reveal, display image and geocoded address |
|
|
19
19
|
| Logic and processing | 18 | 0 | 0 | 1 | User preferences and application settings; all dynamic action events and actions, Ajax callbacks and an error handling function; Core APEX model complete with computations, conditional branches, build options and menu buttons, download, chain and workflow processes; JavaScript from static application files in dynamic actions; region, item, dynamic action and process plug-ins |
|
|
20
20
|
| Security | 22 | 0 | 0 | 0 | An editable login page and Forgot password; a session timeout warning; On par or stricter (CSP without `unsafe-inline`); OIDC, SAML and LDAP; header authentication behind a proxy; database accounts; custom authentication |
|
|
21
21
|
| User interface | 12 | 0 | 0 | 0 | Region templates incl. hero, inline dialog and drawer, wizard and carousel; Universal Theme-like and responsive; a Theme Roller with style variants and conditional, dynamic styles; about 1,700 icons with Font APEX-like modifiers |
|
|
22
22
|
| Globalization | 6 | 0 | 0 | 0 | One translated app like 26.1 with dynamic translations of table values; number format masks and automatic time zone; twenty-two built-in languages |
|
|
23
23
|
| Data and integration | 13 | 0 | 0 | 2 | REST source catalogs from OpenAPI documents; Generate DDL and schema comparison; `meta.data_export` and data export downloads (CSV, JSON, XML, HTML, Excel, PDF); e-mail through SMTP (password or OAuth2), Microsoft Graph, Amazon SES and HTTP APIs; REST APIs via PostgREST, REST data sources that write back and synchronise, web credentials with OAuth2 grants, CSV/XLSX/JSON/XML loading with saved definitions and unloading, SQL scripts and Quick SQL, report PDFs and document templates |
|
|
24
24
|
| Workflow, automation and AI | 6 | 0 | 0 | 0 | Scheduled automations with several actions and runs from SQL, approvals, a task list and workflows with parallel branches, versions and invoke-API steps; AI with Claude or OpenAI: *Generate text with AI*, an assistant region with tools, natural-language report filters and blueprints |
|
|
25
|
-
| Administration |
|
|
25
|
+
| Administration | 15 | 0 | 0 | 0 | OpenTelemetry traces, logs and metrics to the team's own monitoring and `/metrics` for Prometheus (24.2); An APEX-like sign-in with a workspace and a Workspace home; a mail queue dashboard, a workspace's own mail service and network access list (26.1 / 26.2); a workspace's components exported and imported as one file; workspace message, environment banner and utilization; isolated workspaces with their own database logins and roles, and workspace administrators; application availability and Run only, automatic backups, user feedback; a developer toolbar with a session state viewer and debug per session; Top SQL per app; debug messages per request; an install/upgrade log |
|
|
26
26
|
| APEX 26.2 workspace (WS-1 … WS-13) | 13 | 0 | 0 | 1 | Workspace home, Data Reporter as a workspace tool, Team Development, AI Agents, AI interactive reports, Workflow 26.2, the mail queue, workspace mail and network access, the 26.1 component details, the App Builder list's details, the Pillar navigation appearances and data security per table (rows, columns and masked values), the App Gallery's single-topic sample apps, UX Pattern Catalog and Utility Apps; the builder in eleven languages (APEX's ten and Nederlands) |
|
|
27
|
-
| **Total** | **
|
|
27
|
+
| **Total** | **166** | **0** | **0** | **4** | 170 APEX features compared: 98% available, none missing, 4 deliberately not planned |
|
|
28
28
|
|
|
29
29
|
(Counts are of the rows in the tables below. A review on 2026-10-06 added 18 rows for APEX features that were
|
|
30
30
|
not compared before, one on 2026-10-12 added two more (property help, application availability), and one on
|
|
@@ -33,7 +33,8 @@ application reports, Manage Service), so the share available dropped without any
|
|
|
33
33
|
two, REST source catalogs and the workspace export, with their features. Sprint 116 compared with APEX 26.2 and added
|
|
34
34
|
the section [APEX 26.2 workspace](#apex-262-workspace-ws-1--ws-13): fourteen rows, the 26.2 workspace items WS-1 … WS-13
|
|
35
35
|
and OCI managed identities. Some of them repeat a row above from the workspace's side; they are counted on purpose, as
|
|
36
|
-
the 26.2 comparison.)
|
|
36
|
+
the 26.2 comparison. Sprint 139 added OpenTelemetry (24.2), found missing by the 27 Oct pass (AP-6). Sprint 140 split the shuttle off the
|
|
37
|
+
multi-select row and added Select One / Select Many (24.2) and the Help Text region (AP-4).)
|
|
37
38
|
|
|
38
39
|
## App Builder and development
|
|
39
40
|
|
|
@@ -66,7 +67,7 @@ the 26.2 comparison.)
|
|
|
66
67
|
|
|
67
68
|
| APEX | pgkiln | Notes |
|
|
68
69
|
|---|---|---|
|
|
69
|
-
| Classic report | ✅ | `report`
|
|
70
|
+
| Classic report (report templates, pagination types) | ✅ | (sprint 140) Region type `classic_report`: the report renderer without the Actions menu, column menus, saved reports or downloads, and none of an interactive report's settings from the URL; sorting by headings, an optional search; `report_template` `standard` (a table), `value_pairs` (Value Attribute Pairs), `badges` (Badge List) or `media_list` (Media List); `pagination` `total` (X–Y of Z), `range` (X–Y) or `none` ([chapter 4](guide/04-pages-and-regions.md#classic_report-classic-report)) |
|
|
70
71
|
| Interactive report | ✅ | (sprint 76) An Actions menu of nine entries with dialogs, a column heading menu (sort, hide, control break, the column's values to filter by), a search in one column, hidden columns, pagination with the range, first/last and rows per page. Search, column filters, sort, rows per page, control break, aggregates (with subtotals), highlight, saved private and public reports, computed columns, group by, pivot, chart view, row selection into a page item, CSV, Excel (typed cells) and PDF download, print, reset, reflow on phones. a maximum row count (`max_rows`), natural-language control (*Ask in your own words*, 26.1) and row selection that stays across pages. Not possible: flashback queries (PostgreSQL has none; use an audit or temporal table) |
|
|
71
72
|
| Interactive grid | ✅ | Inline edit, add and delete rows, lists of values, required columns, per-row errors, all-or-nothing save, signed row keys, search and paging; **aggregates** over the whole result (developer and user defined), **frozen columns**, column **reorder/resize/hide** (Actions → Columns, or drag and drop), per-user layouts and **saved grid reports** (private and public), **master-detail** (signed row selection, the first row selected on load and after a search, details refreshed in place), **navigation and edit mode** (cells as text with their format mask until clicked, Enter or F2; arrow keys between cells), a **row actions menu** (edit, duplicate, delete, links) and **copy/paste** of cell ranges (tab-separated, spreadsheet compatible) ([chapter 4](guide/04-pages-and-regions.md)) |
|
|
72
73
|
| Interactive grid views: single row view, chart view, group by | ✅ | (sprint 54) **Single row view**: one row of the search as a form with first/previous/next/last and *Add row*, from the Actions or row actions menu, saved by the grid's own process with the same checks; **group by** and **chart** set up in the Actions menu over every row of the search, as for the interactive report; `views` limits them; Save comes back to the same search, page and view ([chapter 4](guide/04-pages-and-regions.md#grid-interactive-grid)). No pivot view on grids (the interactive report has one), no editing in the single row view of columns the grid doesn't show |
|
|
@@ -77,7 +78,8 @@ the 26.2 comparison.)
|
|
|
77
78
|
| Faceted search | ✅ | Checkbox, range (predefined, or a custom from/to on numbers and dates), star rating and search facets with live counts that honour the other facets; exclude on checkbox facets (26.1). Values travel as query parameters, never as SQL text. (sprint 65) **Facet charts**: a bar or pie chart of a facet's counts, each mark filtering on its value. (sprint 78) The **total row count**, *Show all* after seven values, booleans as Yes/No, one search field (the report's own is left out). (sprint 84) A checkbox facet's **⋮ menu** (APEX: the facet's menu): *Clear* and *Sort by count* / *Sort by name* ([chapter 4](guide/04-pages-and-regions.md#facets-faceted-search)) |
|
|
78
79
|
| Smart filters | ✅ | One search field with filter chips and suggestions over a report, the same facet types; URL-based, works without JavaScript ([chapter 4](guide/04-pages-and-regions.md#smart_filters)) |
|
|
79
80
|
| Static content, dynamic content | ✅ | `static` (HTML with substitutions) and `dynamic` (a SELECT returning HTML) |
|
|
80
|
-
| Breadcrumb | ✅ | Automatic, from the page's breadcrumb parent |
|
|
81
|
+
| Breadcrumb | ✅ | Automatic, from the page's breadcrumb parent; (sprint 140) also a `breadcrumb` region for the Breadcrumb bar position (the title bar then leaves its own out), with or without the current page. No separate breadcrumb shared component: the trail follows the pages' parents |
|
|
82
|
+
| Help Text region, page help | ✅ | (sprint 140) The page's *Help text* (Markdown with `&ITEM.` substitutions, item values stay text) and a `help_text` region that shows it ([chapter 4](guide/04-pages-and-regions.md#breadcrumb-and-help_text)) |
|
|
81
83
|
| Navigation menu (side or top) | ✅ | Collapsible side menu or top bar; a drawer on tablets and phones |
|
|
82
84
|
| Region display selector, tabs | ✅ | Tabs or a select list; regions can share a tab, *Show all*, the choice remembered in the session, `#R<id>` links. Accessible tabs with JavaScript; without it every region shows with links to each |
|
|
83
85
|
| Tree | ✅ | `tree` region from id / parent id / label rows, with icons, links and the first levels open; works without JavaScript |
|
|
@@ -96,7 +98,9 @@ the 26.2 comparison.)
|
|
|
96
98
|
|---|---|---|
|
|
97
99
|
| Text field, textarea, number, date picker, password, hidden, display only | ✅ | Native inputs, with the right phone keyboard (`inputmode`) |
|
|
98
100
|
| Select list, radio group, checkbox, switch | ✅ | |
|
|
99
|
-
| Checkbox group,
|
|
101
|
+
| Checkbox group, multi-select | ✅ | Colon-separated values, as in APEX |
|
|
102
|
+
| Shuttle | ✅ | (sprint 140) `shuttle`: available and selected lists, a filter, move one / all, remove one / all, top / up / down / bottom, double-click and keyboard; colon-separated in the chosen order; a multi-select list without JavaScript ([chapter 5](guide/05-items.md#shuttle-select-one-and-select-many)) |
|
|
103
|
+
| Select One, Select Many (24.2) | ✅ | (sprint 140) `select_one`, `select_many`: a search field with a list box over the list of values (ARIA combobox), chips for Select Many; a select list or multi-select list without JavaScript. The list box filters the rows the page read (`max_rows`); a Popup LOV searches on the server |
|
|
100
104
|
| Popup LOV | ✅ | `popup_lov`: a dialog with server-side search (loaded page after page as the dialog scrolls, at most 100 rows a request; ‹ / More without IntersectionObserver) of the item's own shared, static or SQL list of values, extra display columns, return vs display value; the posted value is checked against the list; a select list without JavaScript ([chapter 5](guide/05-items.md)) |
|
|
101
105
|
| Cascading, shared and static lists of values | ✅ | `cascade_parents`, `LOV:NAME`, `STATIC:` |
|
|
102
106
|
| E-mail, phone, URL, colour picker | ✅ | Typed inputs |
|
|
@@ -108,6 +112,78 @@ the 26.2 comparison.)
|
|
|
108
112
|
| Password reveal toggle (24.2) | ✅ | `{"reveal": true}` on password items; the value is never sent back to the page |
|
|
109
113
|
| Display image, geocoded address | ✅ | (sprint 53) `image` items show a picture from an https URL, a path or a BLOB from a query (served as the application's role, sandboxed); `address` items check the text against the installation's Nominatim-compatible geocoder (`GEOCODER_URL`) and put the chosen address's position into another item |
|
|
110
114
|
|
|
115
|
+
## Item and region types, one by one
|
|
116
|
+
|
|
117
|
+
(sprint 140) Every item type and region type of APEX 26.2's Page Designer, and what pgkiln uses for it, so the next
|
|
118
|
+
review is a diff. Not counted in [At a glance](#at-a-glance): the rows above compare features.
|
|
119
|
+
|
|
120
|
+
**Items**
|
|
121
|
+
|
|
122
|
+
| APEX item type | pgkiln | Notes |
|
|
123
|
+
|---|---|---|
|
|
124
|
+
| Checkbox | `checkbox` | `true` / `false` |
|
|
125
|
+
| Checkbox Group | `checkbox_group` | colon-separated; `{"switches": true}` |
|
|
126
|
+
| Color Picker | `color` | `#rrggbb` |
|
|
127
|
+
| Combobox | `combobox` | free text with suggestions, tags |
|
|
128
|
+
| Date Picker | `date`, `datetime` | pgkiln's date picker in the date format; `daterange` has no APEX type |
|
|
129
|
+
| Display Image | `image` | |
|
|
130
|
+
| Display Only | `display` | display values of a list of values |
|
|
131
|
+
| File Upload (File Browse) | `file` | several files per item |
|
|
132
|
+
| Geocoded Address | `address` | `GEOCODER_URL` |
|
|
133
|
+
| Hidden | `hidden` | |
|
|
134
|
+
| Image Upload (24.2) | `file` | with `{"accept": "image/*", "crop": "1:1", "max_px": 1600}` |
|
|
135
|
+
| Markdown Editor | `markdown` | |
|
|
136
|
+
| Number Field | `number` | format masks |
|
|
137
|
+
| Password | `password` | `{"reveal": true}` |
|
|
138
|
+
| Percent Graph | — | a template component or a report column template draws it ([template components](guide/04-pages-and-regions.md#template-components)) |
|
|
139
|
+
| Popup LOV | `popup_lov` | server-side search, infinite scrolling |
|
|
140
|
+
| QR Code | `qrcode` | |
|
|
141
|
+
| Radio Group | `radio` | |
|
|
142
|
+
| Rich Text Editor | `richtext` | sanitised HTML |
|
|
143
|
+
| Select List | `select` | |
|
|
144
|
+
| Select Many (24.2) | `select_many` | sprint 140 |
|
|
145
|
+
| Select One (24.2) | `select_one` | sprint 140 |
|
|
146
|
+
| Shuttle | `shuttle` | sprint 140 |
|
|
147
|
+
| Star Rating | `rating` | |
|
|
148
|
+
| Switch | `switch` | |
|
|
149
|
+
| Text Field | `text`, `email`, `tel`, `url` | the subtypes as their own types |
|
|
150
|
+
| Text Field with autocomplete (desupported) | `combobox` | |
|
|
151
|
+
| Textarea | `textarea` | |
|
|
152
|
+
| List Manager (desupported) | — | desupported in APEX; a `shuttle` or `select_many` does the job |
|
|
153
|
+
| Plug-in | `plugin` | item plug-ins with their own JavaScript |
|
|
154
|
+
|
|
155
|
+
**Regions**
|
|
156
|
+
|
|
157
|
+
| APEX region type | pgkiln | Notes |
|
|
158
|
+
|---|---|---|
|
|
159
|
+
| AI Assistant | `ai_assistant` | |
|
|
160
|
+
| Breadcrumb | `breadcrumb` | sprint 140; the title bar shows the trail without one |
|
|
161
|
+
| Calendar | `calendar` | |
|
|
162
|
+
| Cards | `cards` | |
|
|
163
|
+
| Chart | `chart` | |
|
|
164
|
+
| Classic Report | `classic_report` | sprint 140; before: `report` with `interactive: false` |
|
|
165
|
+
| Dynamic Content (PL/SQL Dynamic Content) | `dynamic` | a SELECT returning HTML |
|
|
166
|
+
| Faceted Search | `facets` | |
|
|
167
|
+
| Form | `form` | |
|
|
168
|
+
| Help Text | `help_text` | sprint 140 |
|
|
169
|
+
| Interactive Grid | `grid` | |
|
|
170
|
+
| Interactive Report | `report` | |
|
|
171
|
+
| List | `list` | |
|
|
172
|
+
| Map | `map` | |
|
|
173
|
+
| Region Display Selector | `display_selector` | |
|
|
174
|
+
| Search | `search` | |
|
|
175
|
+
| Smart Filters | `smart_filters` | |
|
|
176
|
+
| Static Content | `static` | |
|
|
177
|
+
| Template Component (Avatar, Badge, Comments, Content Row, Media List, Metric Card, Timeline) | `template_component` | built in, and your own |
|
|
178
|
+
| Tree | `tree` | |
|
|
179
|
+
| URL | `url` | |
|
|
180
|
+
| Unified Task List | `tasks` | |
|
|
181
|
+
| Workflow Console | `workflows` | |
|
|
182
|
+
| Data Reporter (26.2, a workspace tool) | `data_reporter` | also a region in an application |
|
|
183
|
+
| Column Toggle Report, Reflow Report, List View (jQuery Mobile, desupported) | — | desupported in APEX; reports reflow on phones (`"mobile": "reflow"`) |
|
|
184
|
+
| Plug-in | `plugin` | region plug-ins with their own code |
|
|
185
|
+
| — | `login`, `form_designer` | pgkiln's own: the login page's sign-in form, a form designer for business users |
|
|
186
|
+
|
|
111
187
|
## Logic and processing
|
|
112
188
|
|
|
113
189
|
| APEX | pgkiln | Notes |
|
|
@@ -233,6 +309,7 @@ the 26.2 comparison.)
|
|
|
233
309
|
| Automatic application backups, page groups | ✅ | (sprint 51) **Backups**: before every import that replaces an application (CLI, MCP, working copy merge, restore), daily when it changed, and by hand; the newest 25 (configurable) are kept; download and restore from the builder ([chapter 3](guide/03-builder.md#backups)); (sprint 62) Workspace utilities → **Manage backups** across the workspace's applications, with a backup of all of them at once. (sprint 58) **Page groups**: Shared Components → Page groups, a page's *Page group*, the page list by group with a filter ([chapter 3](guide/03-builder.md#page-groups)) |
|
|
234
310
|
| Application availability (Available, Developers only, Restricted access, Unavailable; build status *Run only*) | ✅ | (sprint 51) Available, available to developers only (a builder session in the same browser), restricted to named users, or unavailable with a message, for pages, file downloads, REST modules and PostgREST; build status **Run only** refuses builder changes as if the application were locked, while `pgkiln import --replace` still deploys. Installation settings: not exported, kept by an import ([chapter 3](guide/03-builder.md#availability-and-build-status)) |
|
|
235
311
|
| Monitoring (top SQL) | ✅ | Activity per app; Top SQL per app's database role from `pg_stat_statements` (sortable, resettable) |
|
|
312
|
+
| OpenTelemetry (Workspace Utilities → OpenTelemetry, 24.2: client logging and token relay to an OTLP collector) | ✅ | (sprint 139, AP-6) Workspace utilities → **OpenTelemetry** ([chapter 1](guide/01-installation.md#monitoring-with-opentelemetry)) or the standard `OTEL_*` variables: OTLP/HTTP to any Collector. A trace per request with a span per SQL statement, REST data source and web call (W3C `traceparent` passed on), AI request (tokens) and tool call; mail and workflow steps as traces of their own; head sampling that keeps every failed trace; values (SQL literals, binds, query strings) only when chosen, the user hashed. Logs of errors, refused access and failed sign-ins; metrics of request durations, errors, AI tokens and the queues; `GET /metrics` for Prometheus. Browser spans of the page load and Ajax calls relayed by pgkiln (APEX's token relay: no collector token reaches the browser). Per workspace: off, or also its own collector through its network access list. Beyond APEX: SQL spans and Prometheus |
|
|
236
313
|
| Workspace export and import (Workspace Utilities → Export) | ✅ | (sprint 67) Workspace utilities → **Export and import** (administrators and the workspace's administrators): settings (message, banner, preferences), developers and workspace administrators, application groups, extension links, REST source catalogs, SQL scripts, blueprints and data generators as one file; imported into the current workspace in one transaction, keeping or replacing components with the same name and never deleting ([chapter 3](guide/03-builder.md#export-and-import)). Applications are exported on their own; isolation, database roles and passwords never leave the installation |
|
|
237
314
|
| Workspaces (multi-tenant) | ✅ | Workspaces group applications and developers: the builder shows and opens only the applications of a developer's workspaces (administrators: all), a current workspace with a switcher, new and imported applications go into it, administrators add workspaces, choose their developers and move applications ([chapter 3](guide/03-builder.md#workspaces)). (sprint 60) **Isolated workspaces** are a tenant boundary: the applications run on a PostgreSQL login of the workspace's own and its developers' SQL Workshop on another, with row-level security on pgkiln's tables, so SQL that resets its role can't reach other workspaces' applications, data, sessions or accounts; **workspace database roles** (APEX: workspace schemas) assigned by administrators; **workspace administrators** who manage their workspace's developers; SQL scripts, blueprints and sample data per workspace ([isolated workspaces](guide/03-builder.md#isolated-workspaces)). **Missing:** user directories per workspace (accounts are installation-wide, visible to the workspaces whose applications they use), developers created by a workspace administrator |
|
|
238
315
|
| Mail queue reporting: delivery health, performance, failures and usage per workspace (26.2) | ✅ | (sprint 118, WS-9) Administration → **Mail queue** ([chapter 3](guide/03-builder.md#mail-queue)): queued, sent, failed and retrying mail per hour and per workspace / application, the share delivered, the average and the 10 slowest provider calls, and every failure with the provider's answer (an SMTP reply such as `550 5.1.1`), with **Retry** and **Purge** (one or all failed). Administrators see every workspace, a workspace's administrators their own |
|
|
@@ -197,6 +197,15 @@ which is read at startup; real environment variables take precedence.
|
|
|
197
197
|
| `LOG_LEVEL` | `info` | `fatal`, `error`, `warn`, `info`, `debug`, `trace` |
|
|
198
198
|
| `PGKILN_RELEASE_CHECK` | `off` | `on`: the server asks GitHub once a day for a newer pgkiln release and the [Workspace home](03-builder.md#the-release-check) announces it. Administrators can also set it in the builder (Instance settings → *New versions*), which wins over the variable. Keep it off where the server may not reach the internet |
|
|
199
199
|
| `PGKILN_RELEASE_URL` | GitHub's releases API | For tests and mirrors only: the address of a JSON document like GitHub's `releases/latest` |
|
|
200
|
+
| `OTEL_EXPORTER_OTLP_ENDPOINT` | *(none)* | (0.72) The OpenTelemetry Collector's OTLP/HTTP address (e.g. `http://otel-collector:4318`): pgkiln sends [traces, logs and metrics](#monitoring-with-opentelemetry) there. Workspace utilities → **OpenTelemetry** wins over it and over the other `OTEL_*` variables below |
|
|
201
|
+
| `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`, `…_LOGS_ENDPOINT`, `…_METRICS_ENDPOINT` | the endpoint + `/v1/traces` … | A full URL per signal (only when the builder sets no collector URL) |
|
|
202
|
+
| `OTEL_EXPORTER_OTLP_HEADERS` | *(none)* | Headers sent to the collector, `name=value,name2=value2` (an API key) |
|
|
203
|
+
| `OTEL_SERVICE_NAME`, `OTEL_RESOURCE_ATTRIBUTES` | `pgkiln`, *(none)* | The `service.name` and other resource attributes (`deployment.environment=prod`) |
|
|
204
|
+
| `OTEL_TRACES_SAMPLER`, `OTEL_TRACES_SAMPLER_ARG` | always on | `traceidratio` with a ratio from 0 to 1 sends that share of traces; a trace with an error is always sent |
|
|
205
|
+
| `OTEL_TRACES_EXPORTER`, `OTEL_LOGS_EXPORTER`, `OTEL_METRICS_EXPORTER` | `otlp` | `none` leaves that signal out |
|
|
206
|
+
| `OTEL_METRIC_EXPORT_INTERVAL` | `60000` | Milliseconds between metric exports (5 s to 1 h) |
|
|
207
|
+
| `OTEL_SDK_DISABLED` | `false` | `true` turns the instance's export off, whatever the builder says |
|
|
208
|
+
| `PGKILN_METRICS`, `PGKILN_METRICS_TOKEN` | `off`, *(none)* | `on` opens `GET /metrics` (Prometheus) for administrators and for scrapers that send `Authorization: Bearer <PGKILN_METRICS_TOKEN>` |
|
|
200
209
|
|
|
201
210
|
## npm scripts
|
|
202
211
|
|
|
@@ -355,6 +364,105 @@ run several instances behind a load balancer. Each instance opens up to
|
|
|
355
364
|
`2 × (DB_POOL_SIZE + DB_NESTED_POOL_SIZE)` database connections (30 with the defaults); keep the sum
|
|
356
365
|
of all instances below PostgreSQL's `max_connections` (100 by default).
|
|
357
366
|
|
|
367
|
+
## Monitoring with OpenTelemetry
|
|
368
|
+
|
|
369
|
+
(0.72; APEX: Workspace Utilities → OpenTelemetry) pgkiln sends **traces, logs and metrics** to your own monitoring
|
|
370
|
+
over OTLP, the OpenTelemetry protocol: Grafana (Tempo, Loki, Mimir), Jaeger, Datadog, Honeycomb, New Relic, Elastic,
|
|
371
|
+
OCI APM and the rest, normally through an [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/). It sends
|
|
372
|
+
OTLP over HTTP as JSON (`http/json`), which every Collector accepts on port 4318. No agent and no extra package are
|
|
373
|
+
needed, and nothing runs while no collector is set.
|
|
374
|
+
|
|
375
|
+
Administrators set it up in Workspace utilities → **OpenTelemetry** (`/builder/telemetry`), or with the standard
|
|
376
|
+
`OTEL_*` variables of the [configuration reference](#configuration-reference) (a value set in the builder wins):
|
|
377
|
+
|
|
378
|
+
- **Collector URL**: the OTLP/HTTP base address; `/v1/traces`, `/v1/logs` and `/v1/metrics` are added.
|
|
379
|
+
**Headers** (an API key) are stored encrypted with `PGKILN_SECRET_KEY` (rotated by `pgkiln admin rotate-key`)
|
|
380
|
+
and never shown again, only their names. **Send a test span** sends one span and shows what the collector answered;
|
|
381
|
+
*Status* shows what each server process sent, dropped, and the last problem.
|
|
382
|
+
- **What is traced.** Every application request is a trace: a server span `GET /a/:alias/:page` with the application,
|
|
383
|
+
page, HTTP status, route and the user (see below), and a child span for **each SQL statement** (`db.query.text`,
|
|
384
|
+
rows, SQLSTATE on errors; transaction control left out), **each outgoing web call** (REST data sources, `invoke_api`,
|
|
385
|
+
`meta.web_request`, web credential token requests: `HTTP GET` with the host, path and status; a 4xx/5xx answer is
|
|
386
|
+
an error span), **each AI request** (`gen_ai.*`: provider, model, input and output tokens) and **each AI tool call**
|
|
387
|
+
of an assistant or agent. A W3C `traceparent` header goes along with every outgoing web call, so the called service
|
|
388
|
+
joins the same trace, and an incoming `traceparent` (from a proxy or another service) is continued. Background work
|
|
389
|
+
has traces of its own: each **mail** sending attempt and each **workflow step** (with the `invoke_api` call inside it).
|
|
390
|
+
*Trace builder requests too* adds `/builder` requests (to the instance's collector only).
|
|
391
|
+
- **Sample ratio**: the share of traces sent (0 to 1). pgkiln keeps a trace's spans until it ends, so a trace with an
|
|
392
|
+
error (an HTTP 5xx, a failing statement, a REST call answered with 500) is **always** sent.
|
|
393
|
+
- **Values stay out** unless *Include values* is on: SQL statements are sent with their literals replaced by `?`
|
|
394
|
+
(`where ename = ?`), bind values, the query string, the full URL of outgoing calls and AI tool arguments are left
|
|
395
|
+
out, and quoted values, `Key (col)=(value)`, e-mail addresses and long numbers are removed from error messages.
|
|
396
|
+
With *Include values*, statements go as run, with `db.query.parameter.N`.
|
|
397
|
+
- **User**: *Hashed* (the default) sends `enduser.id` as a keyed hash (the same user always gives the same value,
|
|
398
|
+
the name is not sent), *User name* sends the name, *Not sent* leaves it out.
|
|
399
|
+
- **Logs**: errors (also unhandled server errors), refused access and failed or locked sign-ins, as log records tied
|
|
400
|
+
to the request's trace, with the application and page.
|
|
401
|
+
- **Metrics**, every 60 seconds (`OTEL_METRIC_EXPORT_INTERVAL`): `pgkiln.http.server.duration` (a histogram in
|
|
402
|
+
milliseconds per application, method and status class), `pgkiln.errors`, `pgkiln.access_denied`,
|
|
403
|
+
`pgkiln.signin_failures`, `pgkiln.ai.requests`, `pgkiln.ai.tokens` (per provider, model, input/output),
|
|
404
|
+
`pgkiln.mail.sent`, and the levels `pgkiln.mail.queue`, `pgkiln.jobs.queue`, `pgkiln.workflows`,
|
|
405
|
+
`pgkiln.ai.requests.pending`, `pgkiln.embeddings.queue`, `pgkiln.db.pool.connections`, `process.memory.rss`,
|
|
406
|
+
`process.uptime`; `pgkiln.telemetry.dropped` counts what could not be sent.
|
|
407
|
+
- **Browser spans** (optional): a page whose trace is sent carries a signed `<meta name="pgkiln-trace">`, and `app.js`
|
|
408
|
+
reports the page's load timings and its Ajax calls to `POST /a/<alias>/telemetry`; pgkiln adds them to the page's
|
|
409
|
+
trace (*browser page load*, *browser POST*). The browser never sees the collector or its headers, and the token is
|
|
410
|
+
bound to the trace, the application and 30 minutes.
|
|
411
|
+
- **Prometheus**: *Prometheus endpoint /metrics* (or `PGKILN_METRICS=on`) answers `GET /metrics` in the Prometheus
|
|
412
|
+
text format, for administrators signed in to the builder and for scrapers with the metrics token (*Make a token*,
|
|
413
|
+
shown once; or `PGKILN_METRICS_TOKEN`). It works without a collector.
|
|
414
|
+
|
|
415
|
+
Each **workspace** chooses on its page → *Mail and network access* → **OpenTelemetry**
|
|
416
|
+
(`/builder/workspaces/<id>/telemetry`, its administrators): *As the instance does* (the default), *Nothing* (its
|
|
417
|
+
applications send nothing, not even to the instance's collector), or *Also to our own collector*: an OTLP/HTTP URL
|
|
418
|
+
with its own headers and its own *Include values*, reached like any outgoing call of the workspace, through the
|
|
419
|
+
installation's allow-list (`PGKILN_REST_ALLOWED_HOSTS`) and the workspace's [network access](03-builder.md#network-access)
|
|
420
|
+
list. Its resource carries `pgkiln.workspace.id`. Metrics go to the instance's collector only.
|
|
421
|
+
|
|
422
|
+
A Collector that sends traces to Jaeger, for a first look (`docker compose`):
|
|
423
|
+
|
|
424
|
+
```yaml
|
|
425
|
+
services:
|
|
426
|
+
jaeger:
|
|
427
|
+
image: jaegertracing/all-in-one:1.62.0 # the UI on http://localhost:16686
|
|
428
|
+
environment: { COLLECTOR_OTLP_ENABLED: "true" }
|
|
429
|
+
otel-collector:
|
|
430
|
+
image: otel/opentelemetry-collector-contrib:0.114.0
|
|
431
|
+
command: ["--config=/etc/otel.yaml"]
|
|
432
|
+
volumes: ["./otel.yaml:/etc/otel.yaml:ro"]
|
|
433
|
+
ports: ["4318:4318"]
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
```yaml
|
|
437
|
+
# otel.yaml
|
|
438
|
+
receivers:
|
|
439
|
+
otlp: { protocols: { http: { endpoint: 0.0.0.0:4318 } } }
|
|
440
|
+
exporters:
|
|
441
|
+
otlp/jaeger: { endpoint: jaeger:4317, tls: { insecure: true } }
|
|
442
|
+
debug: {}
|
|
443
|
+
service:
|
|
444
|
+
pipelines:
|
|
445
|
+
traces: { receivers: [otlp], exporters: [otlp/jaeger] }
|
|
446
|
+
logs: { receivers: [otlp], exporters: [debug] }
|
|
447
|
+
metrics: { receivers: [otlp], exporters: [debug] }
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
Set `OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318` (or the URL in the builder), open a page, and its trace shows
|
|
451
|
+
in Jaeger under the service `pgkiln`. A Prometheus scrape job for `/metrics`:
|
|
452
|
+
|
|
453
|
+
```yaml
|
|
454
|
+
scrape_configs:
|
|
455
|
+
- job_name: pgkiln
|
|
456
|
+
metrics_path: /metrics
|
|
457
|
+
authorization: { credentials: "<the metrics token>" }
|
|
458
|
+
static_configs: [{ targets: ["apps.example.com:443"] }]
|
|
459
|
+
scheme: https
|
|
460
|
+
```
|
|
461
|
+
|
|
462
|
+
Every server process sends what it saw: with several instances, each is a `service.instance.id` (host and process).
|
|
463
|
+
A collector that is down costs a failed request per batch every few seconds, never a user's request; what doesn't fit
|
|
464
|
+
the queue (8,192 spans per collector) is dropped and counted.
|
|
465
|
+
|
|
358
466
|
## Backups and moving applications
|
|
359
467
|
|
|
360
468
|
- **Everything** is in PostgreSQL: application definitions (`meta.*`), sessions and your data.
|
package/docs/guide/03-builder.md
CHANGED
|
@@ -1724,6 +1724,15 @@ doesn't allow:
|
|
|
1724
1724
|
`PGKILN_REST_PRIVATE_HOSTS` lists it). The server resolves the host once and connects to the address it checked,
|
|
1725
1725
|
with the host name kept for TLS, on every send and test.
|
|
1726
1726
|
|
|
1727
|
+
### OpenTelemetry
|
|
1728
|
+
|
|
1729
|
+
Workspace utilities → **OpenTelemetry** (`/builder/telemetry`, administrators; APEX 24.2: Workspace Utilities →
|
|
1730
|
+
OpenTelemetry): traces, logs and metrics of the applications to an OpenTelemetry Collector, and `GET /metrics` for
|
|
1731
|
+
Prometheus. A workspace's page → *Mail and network access* → **OpenTelemetry** lets its administrators switch its
|
|
1732
|
+
applications off or send them to a collector of their own as well (through the allow-list and the workspace's
|
|
1733
|
+
[network access](#network-access) list). What is sent, the values left out and the settings are in
|
|
1734
|
+
[chapter 1](01-installation.md#monitoring-with-opentelemetry).
|
|
1735
|
+
|
|
1727
1736
|
### Network access
|
|
1728
1737
|
|
|
1729
1738
|
Administration menu → **Network access** (`/builder/network`; APEX 26.2: workspace network ACLs), for administrators
|
|
@@ -14,6 +14,7 @@ A page has a number (unique in the app), a name, a title, and these behaviours:
|
|
|
14
14
|
| `authz` | scheme name | Who may open it (403 otherwise) |
|
|
15
15
|
| `protection` | `checksum`, `unrestricted` | Whether URL item values need a checksum |
|
|
16
16
|
| `warn_unsaved` | boolean | Ask before the user leaves the page with unsaved changes, see [below](#warn-on-unsaved-changes) |
|
|
17
|
+
| `help` | Markdown | (140; APEX: Page → Help Text) The page's help text, with `&ITEM.` substitutions; a [`help_text` region](#breadcrumb-and-help_text) shows it. At most 20,000 characters |
|
|
17
18
|
|
|
18
19
|
### Warn on unsaved changes
|
|
19
20
|
|
|
@@ -170,6 +171,7 @@ database only checks the shape (at most 12 names of lower case letters, digits a
|
|
|
170
171
|
| Type | Purpose |
|
|
171
172
|
|---|---|
|
|
172
173
|
| [`report`](#report-interactive-report) | Read-only table from a SELECT, with search, filters, sorting, control break, aggregates, highlights, computed columns, group by, pivot and chart views, row selection, saved reports, paging and CSV/Excel/PDF download |
|
|
174
|
+
| [`classic_report`](#classic_report-classic-report) | (140) A report without the Actions menu and the interactive features: a table, value/attribute pairs, a badge list or a media list, with a choice of pagination |
|
|
173
175
|
| [`grid`](#grid-interactive-grid) | Editable table on one database table, with aggregates, frozen, movable and resizable columns, saved grid reports, a row actions menu, master-detail, copy/paste of cells, and single row, group by and chart views |
|
|
174
176
|
| [`form`](#form) | Fields for one row of a table, with automatic fetch and save |
|
|
175
177
|
| [`chart`](#chart) | Bar, column, stacked, line, area, combo, scatter, bubble, donut, pie, gauge, funnel, radar, Gantt, pyramid, polar, range, box plot, stock, treemap, sunburst or timeline chart from a SELECT, with drill-down links |
|
|
@@ -189,6 +191,8 @@ database only checks the shape (at most 12 names of lower case letters, digits a
|
|
|
189
191
|
| [`search`](#search-search-region) | One search field over several sources (search configurations), results grouped per source |
|
|
190
192
|
| [`url`](#url-url-region) | Another site's page (or a page of this server) in a sandboxed frame |
|
|
191
193
|
| `login` | The sign-in form of the application's own login page (no attributes): identity providers, user name and password, *Keep me signed in*, *Forgot password?*; see [chapter 8](08-security.md#the-login-page) |
|
|
194
|
+
| [`breadcrumb`](#breadcrumb-and-help_text) | (140) The page's breadcrumb trail, for the Breadcrumb bar position |
|
|
195
|
+
| [`help_text`](#breadcrumb-and-help_text) | (140) The page's help text |
|
|
192
196
|
| [`static`](#static-and-dynamic-content) | Fixed HTML with `&ITEM.` substitutions |
|
|
193
197
|
| [`dynamic`](#static-and-dynamic-content) | HTML produced by a SELECT |
|
|
194
198
|
|
|
@@ -403,7 +407,7 @@ Attributes (most of them are also in the page designer's **Report settings** for
|
|
|
403
407
|
| `max_rows` | none | Maximum row count: the report, its total and its downloads read at most this many rows (1 to 1,000,000) |
|
|
404
408
|
| `lazy` | `false` | Load the region after the page shows (see [large tables](#large-tables)) |
|
|
405
409
|
| `cache` | none | Keep the rendered region: `{"scope": "user" \| "session" \| "all", "seconds": 300}` |
|
|
406
|
-
| `searchable` | `true` | Show the search box (`false
|
|
410
|
+
| `searchable` | `true` | Show the search box (`false`: no search, no Actions menu; or use a [`classic_report`](#classic_report-classic-report)) |
|
|
407
411
|
| `fulltext` | none | (sprint 135) A `tsvector` column of the source that the search box also uses: a row is found when its text contains the search text, **or** its tsvector matches it (`websearch_to_tsquery`: stemmed words, `"phrases"`, `or`, `-word`). It may be a `hidden` column (you chose it). Without it, the only `tsvector` column the user may see is used, if there is one. Not with a search in one column |
|
|
408
412
|
| `fulltext_config` | language's | (sprint 135) The text search configuration of that search (`english`, `dutch`…, the one the tsvector was made with); by default the application's primary language's, else `simple`. Only names in `pg_ts_config` are used |
|
|
409
413
|
| `interactive` | `true` | Show the Actions menu (only when searchable) |
|
|
@@ -432,6 +436,25 @@ downloads; highlights, aggregates and the group by, pivot and chart views are sh
|
|
|
432
436
|
|
|
433
437
|
---
|
|
434
438
|
|
|
439
|
+
### `classic_report` (classic report)
|
|
440
|
+
|
|
441
|
+
(sprint 140; APEX: Classic Report) A report from a SELECT without the Actions menu, column heading
|
|
442
|
+
menus, saved reports, downloads or row selection: the same renderer as the interactive report
|
|
443
|
+
with those left out, and none of their settings is read from the URL. Users can sort by a column
|
|
444
|
+
heading (`"sortable": false` leaves that out) and page; a search field only with
|
|
445
|
+
`"searchable": true`. Items placed in the region show above it, as filters for its query.
|
|
446
|
+
|
|
447
|
+
| Attribute | Default | Meaning |
|
|
448
|
+
|---|---|---|
|
|
449
|
+
| `report_template` | `"standard"` | `standard`: a table (a card per row on phones, `"mobile": "scroll"` keeps the table); `value_pairs`: each row as headings and values (APEX: Value Attribute Pairs); `badges`: the first column as the label and the second as a large value (APEX: Badge List); `media_list`: a title (column `title`, else the first) and a text (`description`, `text` or `body`, else the second), the title a link with `link` |
|
|
450
|
+
| `pagination` | `"total"` | `total`: rows X–Y of Z; `range`: rows X–Y without counting them all; `none`: every row on one page (at most `max_rows`, 500) and no pager |
|
|
451
|
+
| `page_size` | 15 | Rows per page (the user has no rows-per-page choice) |
|
|
452
|
+
| `headings`, `hidden`, `formats`, `link`, `empty`, `max_rows`, `lazy`, `cache` | | As for [`report`](#report-interactive-report) |
|
|
453
|
+
|
|
454
|
+
```json
|
|
455
|
+
{"report_template": "badges", "pagination": "none"}
|
|
456
|
+
```
|
|
457
|
+
|
|
435
458
|
### `grid` (interactive grid)
|
|
436
459
|
|
|
437
460
|
An editable table on **one** table. Required properties: `table_name` (e.g. `hr.dept`),
|
|
@@ -1791,6 +1814,23 @@ Attributes:
|
|
|
1791
1814
|
{"height": 640, "sandbox": ["allow-scripts", "allow-same-origin"], "fullscreen": true}
|
|
1792
1815
|
```
|
|
1793
1816
|
|
|
1817
|
+
### `breadcrumb` and `help_text`
|
|
1818
|
+
|
|
1819
|
+
(sprint 140; APEX: Breadcrumb and Help Text regions)
|
|
1820
|
+
|
|
1821
|
+
- **`breadcrumb`**: the page's breadcrumb trail as links: the pages above it by their *Breadcrumb
|
|
1822
|
+
parent* (else the home page), the ones the user may open, then the current page's title
|
|
1823
|
+
(`{"current": false}` leaves that out). Put it in the **Breadcrumb bar** position with template
|
|
1824
|
+
`plain`, which is where the Page Designer's gallery puts one. A page with a breadcrumb region
|
|
1825
|
+
shows the trail only there: its title bar leaves its own out.
|
|
1826
|
+
- **`help_text`**: the page's **Help text** (Page Designer → page properties → Help), Markdown with
|
|
1827
|
+
`&ITEM.` substitutions; item values stay text (no Markdown or HTML of their own). HTML in the help
|
|
1828
|
+
text itself is shown as text, links to `javascript:` are not links. Without a help text the region
|
|
1829
|
+
says *No help is available for this page.* (the runtime message `region.no_help`), or
|
|
1830
|
+
`{"empty": "…"}`.
|
|
1831
|
+
|
|
1832
|
+
HR page 50 (*Project team*) has both, and two classic reports.
|
|
1833
|
+
|
|
1794
1834
|
### `static` and `dynamic` content
|
|
1795
1835
|
|
|
1796
1836
|
- **`static`**: `source` is HTML written by the developer, with `&ITEM.` substitutions
|
package/docs/guide/05-items.md
CHANGED
|
@@ -23,6 +23,9 @@ page, optionally inside a region. Name them `P<page>_<NAME>` (uppercase letters,
|
|
|
23
23
|
| `switch` | on/off switch | `true` / `false` |
|
|
24
24
|
| `checkbox_group` | several checkboxes | **colon-separated** return values, e.g. `10:30`; (137) `{"switches": true}` shows each as a switch, one per line |
|
|
25
25
|
| `multiselect` | multi-select list | **colon-separated** return values |
|
|
26
|
+
| `shuttle` | (140) two lists, *Available* and *Selected*, with buttons to move values across and put the chosen ones in order ([Shuttle](#shuttle-select-one-and-select-many)); a multi-select list without JavaScript | **colon-separated** return values, in the chosen order |
|
|
27
|
+
| `select_one` | (140) a search field over the list of values: typing filters a list under it ([Select One](#shuttle-select-one-and-select-many)); a select list without JavaScript | the chosen return value |
|
|
28
|
+
| `select_many` | (140) as `select_one`, for several values shown as chips with a remove button; a multi-select list without JavaScript | **colon-separated** return values |
|
|
26
29
|
| `display` | read-only text (shows the display value for list items) | whatever was set |
|
|
27
30
|
| `hidden` | not rendered | set by URL (with checksum), fetch or processes |
|
|
28
31
|
| `file` | file upload ([chapter 16](16-files.md)); on phones the camera with `{"capture": "environment"}`, photos made smaller with `{"max_px": 1600}` ([chapter 17](17-mobile.md)) | the id of the uploaded temporary file (a uuid) |
|
|
@@ -191,7 +194,8 @@ pages and applications without sign-in keep nothing.
|
|
|
191
194
|
## Lists of values
|
|
192
195
|
|
|
193
196
|
A list of values (LOV) provides the options of select lists, radio groups, checkbox groups,
|
|
194
|
-
multi-selects, popup LOVs, grid columns and display
|
|
197
|
+
multi-selects, shuttles, Select One and Select Many items, popup LOVs, grid columns and display
|
|
198
|
+
items. Three forms:
|
|
195
199
|
|
|
196
200
|
1. **A SELECT returning (display, return)**. Bind variables are allowed:
|
|
197
201
|
```sql
|
|
@@ -205,8 +209,9 @@ multi-selects, popup LOVs, grid columns and display items. Three forms:
|
|
|
205
209
|
list can also read a web service: give it a **REST data source** and query the rows from
|
|
206
210
|
`rest` ([chapter 19](19-rest-data-sources.md#lists-of-values)).
|
|
207
211
|
|
|
208
|
-
On submit, the value of a select list, radio group, checkbox group, multi-select
|
|
209
|
-
value of a multi-value item), and of a grid column with a list
|
|
212
|
+
On submit, the value of a select list, radio group, checkbox group, multi-select, shuttle, Select
|
|
213
|
+
One, Select Many or popup LOV (each value of a multi-value item), and of a grid column with a list
|
|
214
|
+
of values, must be one its list
|
|
210
215
|
returns at that moment, for that user: a list that leaves out departments a user may not pick also
|
|
211
216
|
keeps a crafted request from choosing them. Otherwise the item gets *"choose a value from the
|
|
212
217
|
list"*. For a list that may legitimately miss the current value, set `"any_value": true` in the
|
|
@@ -241,6 +246,41 @@ new search starts over at the first page. A browser without `IntersectionObserve
|
|
|
241
246
|
The HR example's page 26 (*Pick an employee*) has one with name, job and department columns;
|
|
242
247
|
page 47 (*Component details*) one over 6,000 rows, 100 a page.
|
|
243
248
|
|
|
249
|
+
## Shuttle, Select One and Select Many
|
|
250
|
+
|
|
251
|
+
(sprint 140; APEX: Shuttle, and 24.2's Select One and Select Many) Three list items for choosing from
|
|
252
|
+
a list of values, each a plain select list without JavaScript (the page saves the same values):
|
|
253
|
+
|
|
254
|
+
- **Shuttle** (`shuttle`): two lists side by side, *Available* and *Selected* (stacked on phones),
|
|
255
|
+
with a filter field over the available values. Move values across with the buttons between the
|
|
256
|
+
lists (*Move all* », *Move* ›, *Remove* ‹, *Remove all* «), by double-clicking one, or with the
|
|
257
|
+
keyboard: **Enter** moves the marked values across, **Delete** removes them from *Selected*, and in
|
|
258
|
+
*Selected* **Alt+↑ / Alt+↓** move them up or down (with **Shift**: to the top or bottom; the buttons
|
|
259
|
+
⤒ ↑ ↓ ⤓ do the same). The value is the chosen return values **in their order**, colon-separated
|
|
260
|
+
(`7566:7902`), so `string_to_array(:P50_MEMBERS, ':') with ordinality` keeps the order. Without
|
|
261
|
+
JavaScript the shuttle is a multi-select list (the chosen values first, in their order); a value
|
|
262
|
+
posted from it comes in the list's order.
|
|
263
|
+
- **Select One** (`select_one`): a search field. Clicking it or typing opens a list box under it
|
|
264
|
+
that shows the list's display values containing what was typed (case-insensitive); **↑ / ↓**
|
|
265
|
+
move through it, **Enter** chooses, **Escape** closes. Emptying the field chooses no value.
|
|
266
|
+
`{"null_label": "- None -"}` names the empty entry, `false` leaves it out (a required item).
|
|
267
|
+
- **Select Many** (`select_many`): the same, for several values: the chosen ones are chips above the
|
|
268
|
+
field, each with a remove button (named *Remove …* for screen readers); **Backspace** in the
|
|
269
|
+
empty field removes the last one, Enter on a chosen value in the list removes it again. The
|
|
270
|
+
value is colon-separated, like a multi-select.
|
|
271
|
+
|
|
272
|
+
Like the other list items they are checked against their list of values on submit, take
|
|
273
|
+
`cascade_parents` (a cascading shuttle is reloaded with its new values), show their display values
|
|
274
|
+
(comma-separated, in order) when read-only, and dynamic actions see the colon-separated value
|
|
275
|
+
(*Set value* with `A:B` chooses those values). The list box searches the rows the page read
|
|
276
|
+
(`max_rows`, 5,000 by default): for lists of tens of thousands of rows use a [Popup LOV](#popup-lov),
|
|
277
|
+
which searches on the server. Texts such as *Move all*, *Selected* and *Remove {value}* are runtime
|
|
278
|
+
messages (`shuttle.*`, `lov.search`, `item.tag_remove`) an application can replace with a text
|
|
279
|
+
message of the same name.
|
|
280
|
+
|
|
281
|
+
HR page 50 (*Project team*, Administration) has a Select One of departments, a shuttle of that
|
|
282
|
+
department's employees (cascading) and a Select Many of skills.
|
|
283
|
+
|
|
244
284
|
## Cascading lists of values
|
|
245
285
|
|
|
246
286
|
A list that depends on another item, for example managers filtered by department:
|