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.
📋 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") |
|
Min |
Decimal |
Minimum allowed value for this variable |
|
Max |
Decimal |
Maximum allowed value for this variable |
|
Custom Attributes |
Collection |
User-defined attribute key-value pairs |
📊 Parameter vs Variable
|
Aspect |
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 |
|
Example |
"MaxPressure = 3.0 bar" |
"RecordedTemp (0–150 °C)" |
🔧 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).
-
Set the Min and Max range — Enter the valid range for this variable. This is used for validation and documentation.
-
Use in Algorithm Design — Reference this variable in your Action Builder expressions as a write target.
💡 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 |
|
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 |
Min |
Max |
Description |
|---|---|---|---|---|---|
|
RecordedTemp |
Temperature |
°C |
0 |
150 |
Recorded CIP solution temperature at condition check |
|
BatchVolume |
Volume |
L |
0 |
10000 |
Total volume of CIP solution used |
|
CycleCounter |
Count |
— |
0 |
999 |
Number of CIP cycles completed |
|
AccumulatedFlowTotal |
Flow |
L |
0 |
50000 |
Total accumulated flow during circulation |
|
ElapsedCirculationTime |
Time |
min |
0 |
120 |
Actual circulation time recorded |
🏭 Example: SIP Module Variables
|
Variable Name |
Phenomenon |
Unit |
Min |
Max |
Description |
|---|---|---|---|---|---|
|
RecordedSterilizationTemp |
Temperature |
°C |
0 |
200 |
Temperature recorded at sterilization hold point |
|
ActualHoldTime |
Time |
min |
0 |
60 |
Actual time at sterilization temperature |
|
ColdestPointTemp |
Temperature |
°C |
0 |
200 |
Temperature at the coldest point in the system |
|
CondensateVolume |
Volume |
L |
0 |
500 |
Total condensate collected during SIP |
|
SterilizationResult |
Count |
— |
0 |
1 |
1 = Pass, 0 = Fail |
🔗 Related Pages
-
📏 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