Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Variable Definition

Embedded Object Grooper.Core

Defines a variable with a computed value for use in expressions, data models, or automation.

Remarks

Overview

A Variable Definition allows you to create named variables whose values are calculated dynamically using an expression. These variables can be referenced throughout your Data Model, Data Section, Data Table, or other configuration objects to drive logic, formatting, or automation.

How It Works

  • The 'Name' property specifies the variable's identifier, which must be unique and code-friendly.
  • The 'Type' and 'Is Array' properties define the data type and whether the variable is a single value or a collection.
  • The 'Expression' property contains the logic used to compute the variable's value, referencing other fields, variables, or built-in functions.
  • Optional formatting properties ('Number Format', 'Date Format') control how the value is displayed.

Usage Scenarios

  • Calculating totals, differences, or derived values in a Data Model.
  • Creating reusable expressions for validation, conditional logic, or UI display.
  • Formatting numeric or date/time values for export, display, or downstream integration.

Configuration & Best Practices

  • Use descriptive, code-friendly names for variables to avoid conflicts and improve maintainability.
  • Test expressions thoroughly to ensure correct results and error handling.
  • Use the formatting properties to control how values appear in the UI or exported data.
  • Document the purpose of each variable using the 'Description' property.

Properties

NameTypeDescription

Used By

Notification