Variable | AseptSoft Documentation

A Variable is a named storage value used in action expressions within the Algorithm Design. Variables represent calculated values, counters, recorded measurements, and other data that actions write to — such as a recorded temperature reading, a batch volume counter, or a calculated flow total.

💡 In pharmaceutical terms: Variables are where the automation system stores process data during execution. For example, after a CIP caustic wash reaches the target temperature, the action "store the actual temperature in RecordedTemp" writes the sensor reading into a variable. These recorded values can then be used in reports, batch records, and subsequent conditions.

https://downloads.aseptsoft.ch/documentation/images/Module-Data/Variable/variable-collection.png

📋 Properties

Property	Type	Description
Name	Text	Unique identifier for the variable (e.g., "RecordedTemp", "BatchVolume").
Phenomenon	Text	The physical phenomenon being represented (e.g., "Temperature", "Volume", "Count").
Unit	Text	The unit of measurement (e.g., "°C", "L", "pcs"). Real-world units like `kg/m³`, `µS/cm`, `m²`, `mol·L⁻¹` are accepted (Greek letters, superscripts, and engineering symbols up to 20 characters).
Min	Decimal	Minimum allowed value for this variable.
Max	Decimal	Maximum allowed value for this variable.
Short code (XX)	Text	Up to 6 characters. Auto-filled from the phenomenon (e.g. "PT" for Pressure, "TT" for Temperature) but always editable. Used by highlighters and tracker labels that show a compact tag instead of the full name.
Custom Attributes	Collection	User-defined attribute key-value pairs.

🔠 Short code (XX)

Variables and Parameters share the same Short code field — a compact identifier used by surfaces that need to fit a label into a tight space (highlighters, condition trackers, matrix decorations).

Behaviour	Detail
Auto-filled from phenomenon	When you pick a phenomenon, AseptSoft fills the Short code with the conventional ISA letters (Pressure → `PT`, Temperature → `TT`, Flow → `FT`, …). The auto-fill only runs when the field is empty, so your typed value is never overwritten.
Always editable	Type your own code at any time; up to 6 characters. AseptSoft warns you only if you exceed the cap.
Where it appears	Highlighter texts that include `{XX}`, condition tracker rows with the compact code variant, instrument-popup XX label.

📊 Parameter vs Variable

Aspect	Parameter	Variable
Purpose	Input thresholds and limits (what to check against).	Output storage and calculations (where to write values).
Used in	Condition expressions (checking values).	Action expressions (writing values).
Key values	Default Value	Min / Max range
Think of it as	A constant that conditions compare against.	A variable that actions write to.
Short code (XX)	✅ — same field, same auto-fill rules.	✅ — same field, same auto-fill rules.
Example	"MaxPressure = 3.0 bar"	"RecordedTemp (0–150 °C)"

💡 The Short code is a pure semantic property of the named entity, so picking Variable vs Parameter is a clean semantic decision (ranged measurement vs setpoint) — there's no hidden UI cost on either side.

🔧 How Variables Work

Variables provide named storage locations for numeric values in action expressions. They are written to by the Action Builder when defining what happens after a condition succeeds or fails.

The Min and Max values define the valid range for the variable. This information is used for validation and documentation purposes.

Used In

Variables are used in the Action Builder when creating action expressions. They appear in the operand selection list as targets for write operations.

📖 How To: Define Variables for Your Module

Open Module Data — Navigate to the Data panel in the Module Ribbon and open the Module Data window.
Go to the Variables tab — Select the Variables section.
Create a new Variable — Click "Create new" and give it a descriptive name (e.g., "RecordedTemp", "BatchVolume").
Set the phenomenon and unit — Choose the physical quantity (Temperature, Volume, Count, etc.) and unit (°C, L, pcs). The Short code (XX) auto-fills based on the phenomenon — adjust if needed.
Set the Min and Max range — Enter the valid range for this variable.
Use in Algorithm Design — Reference this variable in your Action Builder expressions as a write target.

https://downloads.aseptsoft.ch/documentation/images/Module-Data/Variable/variable-form-filled.png

💡 Tip: Use a consistent naming convention for variables. Prefix with "Recorded", "Accumulated", "Calculated", or "Count" to make the purpose clear: RecordedTemp, AccumulatedFlow, CalculatedVolume, CycleCounter.

📤 Excel Export / Import

Variables support Excel export and import for bulk management:

Exported Field	Description
Name	Variable name (used as identification key).
Phenomenon	Physical phenomenon.
Unit	Unit of measurement.
Min	Minimum value.
Max	Maximum value.
Short code (XX)	Compact identifier.
Custom Attributes	All user-defined attributes.

You can export variables to Excel, edit them in bulk, and import them back. The Name field serves as the identification key for matching during import.

🏭 Example: CIP Module Variables

Variable Name	Phenomenon	Unit	XX	Max	Description
RecordedTemp	Temperature	°C	TT	150	Recorded CIP solution temperature at condition check.
BatchVolume	Volume	L	VT	10000	Total volume of CIP solution used.
CycleCounter	Count	—	CT	999	Number of CIP cycles completed.
AccumulatedFlowTotal	Flow	L	FT	50000	Total accumulated flow during circulation.
ElapsedCirculationTime	Time	min	KT	120	Actual circulation time recorded.

🏭 Example: SIP Module Variables

Variable Name	Phenomenon	Unit	XX	Max	Description
RecordedSterilizationTemp	Temperature	°C	TT	200	Temperature recorded at sterilization hold point.
ActualHoldTime	Time	min	KT	60	Actual time at sterilization temperature.
ColdestPointTemp	Temperature	°C	TT	200	Temperature at the coldest point in the system.
CondensateVolume	Volume	L	VT	500	Total condensate collected during SIP.
SterilizationResult	Count	—	RT	1	1 = Pass, 0 = Fail.

📏 Parameter — Similar to variables but used in condition expressions with a default value.
📋 Module Data — All module data types.
Build Action Field — Where variables are used in action expressions.
🧠 Algorithm Design — Overview of condition logic.
🔁 Control Loop — Control loops that may write to variables.