Skip to main content
CYPEX Documentation
Support
v2.0.0 Latest stable release View changelog ->
Various Referencegenerated

Procedure Button

Run a database procedure

Technical id
default_procedure_button
Translation keys
label

A button that calls a database function or procedure directly, for work that belongs in the database rather than in the page.

When to use

  • Triggering server-side logic that would be wrong to express as a sequence of page actions — a batch recalculation or a state transition with its own rules.

What you need

The function must exist in the database and be callable by the signed-in user’s role; arguments are supplied from the page.

Examples

  • Recalculating totals across an invoice after its lines change.

Avoid

  • Using it where a connector operation is the intended integration point.
  • Assuming the page refreshes itself afterwards — elements showing affected data must be reloaded explicitly.

Use instead

  • Call Button — Use instead to call a published connector operation rather than a database function.

Editor properties

Configure these in the Application Designer property panel. Group headings mirror the editor where possible. Data Source is where the element gets its rows or field binding (a view/query, a connector operation, or a parent form field). References appear only for view-backed sources and map foreign-key ID columns to readable labels from another view.

Func ArgsrequiredStructured JSON
Configuration for func args.
Default: none
Func NamerequiredText
Configuration for func name.
Default: none
Func SchemarequiredText
Configuration for func schema.
Default: none

Sizing

  • No size of its own: dropped at the platform default of 1 × 1 grid cells and resized on the page.

Where you can place it

Drag this element into one of these containers:

1
2
3
4
5
6
7
{
  "config": {
    "func_name": "func_name",
    "func_schema": "func_schema",
    "func_args": {}
  }
}