Native models

Models describe structured values that you can name, reference and compose. They have no separate platform identity or lifecycle.

214 models

NameDescription
edge_app_documentPortable EdgeApp definition.
edge_app_exec_commandOne executable with arguments, outputs, environment settings and limits.
edge_app_handlerNamed Lua handler source.
edge_app_http_routeMethod, path, handler, auth, and limits.
edge_app_libraryNamed reusable Lua source.
edge_app_modbus_pollOne Modbus poll and handler binding.
edge_app_modbus_portOne named Modbus transport.
edge_app_modbus_readTyped Modbus address read.
edge_app_modbus_slaveOne slave unit.
edge_app_mqtt_brokerOne named MQTT connection.
edge_app_mqtt_subscriptionTopic filter and handler binding.
edge_app_opcua_endpointOne named OPC UA endpoint.
edge_app_opcua_subscriptionMonitored node and handler binding.
edge_app_snmp_deviceOne named SNMP device connection.
edge_app_snmp_pollOne SNMP poll and handler binding.
integration_actionNamed Action; its source is either a chunk receiving (input, actionConfig) or a typed exports.handler(input: T, config: C?) whose types generate the Action's schemas; instance config is available through ctx.config.get().
integration_actorScript actor behaviour; no entry script or exports convention.
integration_actor_actionNamed Action; its source is either a chunk receiving (input, actionConfig) or a typed exports.handler(input: T, config: C?) whose types generate the Action's schemas; instance config is available through ctx.config.get().
integration_actor_libraryModule loaded by ctx.script.load(name).
integration_actor_subscriptionInline Lua event chunk; varargs (event, config).
integration_actor_timerInline Lua timer chunk; varargs (timerName, config); exactly one of every/cron. Cron uses UTC.
integration_api_clientA pinned API contract and original Swagger/OpenAPI source.
integration_api_client_exportPublishes the client's operations as Actions named client.operation; requires <setup>.
integration_custom_appOne complete App.vue component, without separate supporting files.
integration_data_container_schemaSchema for installation-owned data. No container values are defined here. Omitted taggable types prohibit attachments.
integration_documentXML v1 definition of Integration behavior and required configuration.
integration_libraryModule loaded by ctx.script.load(name).
integration_policyTyped IAM document, 1...256 statements.
integration_policy_statementAn ALLOW or DENY statement composed into an integration policy.
integration_protobufInline protobuf source (256 KiB) or a whitespace-tolerant base64 FileDescriptorSet (256 KiB decoded). External imports are unavailable.
integration_resource_requirementLogical requirement; installations supply concrete entities.
integration_subscriptionInline Lua event chunk; varargs (event, config).
integration_timerInline Lua timer chunk; varargs (timerName, config); exactly one of every/cron. Cron uses UTC.
integration_workflow—
journey_agentHands a goal to an AI assistant when one is configured, with a manual fallback for users without one. Use it where an assistant can help, such as drafting or reviewing
journey_allCondition that holds when every child condition holds
journey_anyCondition that holds when at least one child condition holds
journey_argOne GraphQL variable: a typed literal, or a reference to an input or state value
journey_arrayA list value within `variables`
journey_assertHolds the one condition an invariant requires
journey_captureCopies a value from the response into Journey state for later stages
journey_documentThe root element: a guided process made of ordered stages
journey_doneThe final stage. Shows closing text and an optional checklist, and clears the user's saved progress. Every Journey ends with one
journey_eqCondition that holds when the value at `path` equals `value`
journey_equalsThe value a `wait-for` stage waits for
journey_executeRuns a GraphQL operation when the user presses its button, usually a mutation that saves or changes data. It can capture and reveal values from the response, such as a new record's ID
journey_existsCondition that holds when the value at `path` is present and not null; an empty string still exists
journey_fetchRuns a GraphQL read when the stage opens, captures values from the response into state, and continues once it succeeds. Use it to load data that later stages need
journey_fieldA question on a form stage. The answer is written to Journey state under its `key`
journey_formAsks the user for a known set of answers, such as a name, a quantity or a date. Each field writes its answer to Journey state for later stages
journey_gtCondition that holds when the value at `path` is greater than `value`
journey_gteCondition that holds when the value at `path` is greater than or equal to `value`
journey_hintContext for an AI assistant about this stage. It does not set up an assistant by itself
journey_infoShows text and an optional checklist, then lets the user continue. Use it for instructions, context or a summary part-way through a process
journey_inputRead-only context supplied when the journey is launched, such as the customer it concerns. Read it as `$.inputs.<key>`
journey_invariantA rule the process must always satisfy, such as a count staying positive. It documents intent; it is not a permission check
journey_ltCondition that holds when the value at `path` is less than `value`
journey_lteCondition that holds when the value at `path` is less than or equal to `value`
journey_manual_fallbackFallback for runners without an assistant
journey_neqCondition that holds when the value at `path` does not equal `value`
journey_notCondition that holds when its single child condition does not
journey_objectA nested object value within `variables`
journey_optionOne choice in a `choice` field
journey_outputA value the journey hands back when it finishes, read from `$.state.<key>`. A journey task sends these to complete the task
journey_query_pickRuns a GraphQL read and shows the results as a list for the user to choose from; the chosen item's values are captured into state. Use it to select a customer, job or other record
journey_revealShows a captured value to the user after the stage runs, such as a new record's ID
journey_schema_formBuilds a form from a JSON Schema, written inline or captured from an API earlier in the Journey. Use it for nested or typed configuration, or when the fields are only known at runtime
journey_validationExtra rules a field's answer must meet: a pattern for text, or a range for numbers
journey_variablesThe GraphQL variables sent with the stage's `document`
journey_wait_forRepeatedly runs a GraphQL read until a value in the response equals an expected result, or until it times out. Use it to wait for a job to finish or a status to change; checking only continues while the Journey is open
journey_whenHolds the one condition that decides whether a stage or field takes part
ml_model_documentML configuration. Training data and operational state are not part of this document.
ml_model_featureOne feature column.
ml_model_forecastTime-series forecast configuration.
ml_model_holdoutRows kept back from training to score the model.
ml_model_hyperparametersOptional tabular training hyperparameters.
ml_model_normalization_stageA named Lua normalization stage.
ml_model_seasonal_periodOne seasonal observation period.
ml_model_tabularTabular regression or classification configuration.
portal_assetOne public text asset, served at /<path>.
portal_componentOne component: its props and slots, template, CSS and server Lua.
portal_layoutOne document shell.
portal_libraryShared Lua, loaded with require(name).
portal_pageOne page: its URL pattern, DataXML template, server Lua, local handlers and CSS.
portal_routeOne server route: Lua answering a method at a path under /api.
portal_site_documentA Portal site: its pages, components, routes, tools, shared Lua, layouts, stylesheets and public assets.
portal_styleOne stylesheet, served at /styles/<name>.css.
portal_toolOne MCP tool: its annotations, input and output schemas and Lua.
report_documentThe root element: a report's parameters, data sources, preparation and output files. Save and publish a version before running or scheduling it.
report_outputOne file produced by each run: a PDF, a CSV file or an Excel workbook.
report_parameterOne input the report asks for when it runs, such as a date range or a customer.
report_sheetOne worksheet.
report_sourceOne query whose rows become a dataset named after the source. Write MicroSQL or a read-only GraphQL query; parameter values are supplied when the report runs.
report_transformLua script that changes or filters each row: it receives the row as `input` and returns the changed row, or `nil` to drop it. It cannot query data.
workflow_document—
workflow_edge—
workflow_node—
workflow_variable—
workspace_action_formA legacy form that writes shared state and runs an action. Use `form` instead: it protects the user's draft.
workspace_block_action_groupA row or column of action buttons.
workspace_block_action_group_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_ai_insightAn AI analysis of the panel's data, shown inline. It runs when the panel loads or refreshes, is read-only, and is advisory. It needs a configured AI assistant.
workspace_block_ai_insight_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_alert_blockA message with a severity: info, warning, error or critical.
workspace_block_alert_block_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_alert_block_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_checklistA list of items with a done state, such as the steps of a process.
workspace_block_checklist_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_checklist_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_data_listA list of rows with a main line, a second line, a badge and a status dot. `record-list` covers the common case.
workspace_block_data_list_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_data_list_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_data_tableA table of rows. `record-table` covers the common case.
workspace_block_data_table_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_data_table_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_filter_barA row of filter options the user can choose from.
workspace_block_filter_bar_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_filter_bar_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_formThe low-level form block. Use `form` instead, which adds draft protection and schema checks.
workspace_block_form_blockInput fields that write workspace state for a following action. Prefer `form`.
workspace_block_form_block_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_form_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_gauge_chartA gauge showing one number between a minimum and a maximum.
workspace_block_gauge_chart_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_gauge_chart_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_journeyEmbeds a published Journey, a guided step-by-step process, in the panel.
workspace_block_journey_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_journey_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_map_blockA map with a marker for each location.
workspace_block_map_block_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_map_block_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_media_previewAn image preview, with text shown when there is no image.
workspace_block_media_preview_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_media_preview_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_metric_groupA group of metric tiles. `kpi-summary` covers the common case.
workspace_block_metric_group_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_metric_group_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_pagerNext, Previous and First buttons. `pager` covers the common case.
workspace_block_pager_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_progress_barA progress bar with optional labels at each end.
workspace_block_progress_bar_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_progress_bar_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_propertySets one property of a generic block, or of its `config` or `data-binding`, to a JSON value. Use it for values an attribute cannot express, such as lists and objects.
workspace_block_record_cardA card showing one record, with a title, a status badge and labelled fields. `record-detail` covers the common case.
workspace_block_record_card_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_record_card_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_relation_graphA diagram of records and the links between them.
workspace_block_relation_graph_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_relation_graph_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_sparkline_chartA small line or area chart. `trend` covers the common case.
workspace_block_sparkline_chart_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_sparkline_chart_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_state_inputAn input bound to workspace state. `filter` covers the common case.
workspace_block_state_input_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_swatch_setA set of colour swatches, each with a label.
workspace_block_swatch_set_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_swatch_set_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_tab_switchA row of tabs the user can switch between. Define the tabs with a `<property name="tabs">` list of labels and values.
workspace_block_textText, optionally formatted as Markdown. `text` covers the common case.
workspace_block_text_configSettings for the enclosing block. Use attributes for simple values, `<property>` children for lists and objects, or one complete JSON body.
workspace_block_text_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_block_timelineA vertical timeline of events.
workspace_block_timeline_data_bindingBinds the enclosing block to the panel's data. Each value is literal text or a `{{ dot.path }}` expression. Use attributes, `<property>` children, or one complete JSON body.
workspace_case_fieldsetA conditional group of fields inside a variant case. Its `when` condition decides whether the fields take part; hidden drafts are kept.
workspace_case_sectionA plain group of fields inside a variant case, laid out in one or two columns.
workspace_columnStacks its children vertically. Each child's `weight` sets its share of the space.
workspace_data_sourceLoads data for lookups without showing a panel, for example the options of a relationship picker. It loads and refreshes like a panel. It does not hide the data from anyone allowed to open the workspace.
workspace_detailThe region of a `record-browser` that shows the selected record. Its contents read the selection through state.
workspace_detail_fieldOne labelled value in a `record-detail`.
workspace_documentThe root element of a Workspace: a screen of panels that read and edit business data. It declares shared state, server Lua handlers, data sources and the layout.
workspace_fieldsetA conditional group of fields. Its `when` condition decides whether they are validated and submitted; hidden drafts are kept, not cleared.
workspace_filterAn editable filter bound to shared state. Apply or Clear updates the state and reloads the panels that depend on it; it never submits a form.
workspace_formA form for creating or editing a record. It keeps the user's draft, validates it, asks for confirmation and submits it through a GraphQL mutation or a Lua action.
workspace_form_actionsSets the text of a form's save and reset buttons.
workspace_form_fieldA visible input in a form, bound to one path in the mutation or handler input.
workspace_form_submitHow a form submits: a GraphQL mutation written inside the element, or a server Lua action. It also says where to find errors and the saved record in the response.
workspace_form_valueA hidden, read-only input in a form, such as a record ID taken from the record or from state.
workspace_handlerDeclares a server Lua function the workspace can call: `read` handlers supply panel data, `action` handlers perform writes. Omit `input` and `output` to derive the contract from the typed Lua function.
workspace_handler_constraintAdds an input restriction to a handler. The server enforces it on every call, including direct API calls. Use it for arguments without a visible form field.
workspace_handler_inputAn explicit handler input schema, using a schema root in urn:cococo:json-schema:1 or legacy JSON text/CDATA. Prefer typed Lua inputs; if you use this, supply an output schema too.
workspace_handler_outputAn explicit handler output schema, using a schema root in urn:cococo:json-schema:1 or legacy JSON text/CDATA. Supply it together with an input schema, or not at all.
workspace_kpi_metricOne headline number in a `kpi-summary`.
workspace_kpi_summaryA group of headline numbers, each with a label and an optional unit and trend.
workspace_legacy_fieldAn input in a legacy `action-form`.
workspace_legacy_submit_graphqlThe GraphQL mutation a legacy `action-form` runs.
workspace_legacy_submit_luaThe Lua action a legacy `action-form` runs.
workspace_lookupOffers a field's choices from the records another panel or data source has loaded. Searching filters only those loaded records.
workspace_magic_argPasses one MagicQuery parameter, either from declared state or as a literal value.
workspace_master_detailA two-region layout, typically a list of records on one side and the selected record on the other.
workspace_metric_panelA ready-made dashboard panel: loads a metric's recent samples and shows the statistics you choose above a trend chart.
workspace_metric_statOne statistic shown by a `metric-panel`, such as the average or maximum of the series.
workspace_mutation_inputGroups nested input values for a legacy GraphQL submit.
workspace_optionOne fixed choice for a field, with a label and a JSON value.
workspace_pagerNext, Previous and First buttons for a panel whose query pages through results with a cursor.
workspace_panelA titled region that runs one query and displays the result with the blocks inside it. Most workspace content lives in panels.
workspace_query_graphqlLoads a panel's data with a GraphQL query written inside the element; CDATA keeps it readable. Arguments pass declared state to the query's variables.
workspace_query_luaLoads a panel's data by calling a declared `read` handler in the workspace's server Lua.
workspace_query_magicqueryLoads a panel's data with a MagicQuery: a supported noun plus named parameters, which the server expands into GraphQL.
workspace_record_browserA ready-made list-and-detail workflow: a selectable list of records plus a detail region for the selected one. It creates its selection state if you have not declared it.
workspace_record_detailShows one record: a heading plus labelled values.
workspace_record_editorA ready-made edit panel: loads the selected record and shows an edit form whose identity input is filled in automatically.
workspace_record_listA selectable list of records. Selecting one writes its key to shared state for other panels to use.
workspace_record_tableShows records as rows, with the columns you define.
workspace_related_recordsShows the records that belong to the selected parent, such as a customer's contacts, in a table, with an optional form for adding one. The parent's identity is filled into that form automatically.
workspace_rowPlaces its children side by side. Each child's `weight` sets its share of the width.
workspace_sectionA plain group of fields, laid out in one or two columns.
workspace_stateDeclares a piece of shared state, such as the selected record or a filter value, with its initial JSON value. Queries, lists, filters and forms read and write it by name.
workspace_state_argPasses declared workspace state to a query variable, handler input or mutation input.
workspace_table_columnOne column of a table, bound to a value on each row.
workspace_textShows text, either written in the element or bound to a value in the panel's data.
workspace_trendA line or area chart of a series of values from the panel's data.
workspace_variantLets the user choose one of several shapes for part of the input, for example a person or a company, each with its own fields.
workspace_variant_caseOne choice within a `variant`, with the fields that belong to it.
workspace_variant_fieldAn input inside a variant case. Its path is relative to the selected case.