AseptSoft Core Documentation
Breadcrumbs

Parameter

A Parameter is a named value used in condition expressions within the Algorithm Design. Parameters represent thresholds, targets, and limits that the control logic checks against — such as maximum pressure, target temperature, or minimum flow rate.

💡 In pharmaceutical terms: Parameters are the setpoints and limits that your process conditions check against. For example, during a CIP caustic wash, you might have a "MinTemp" parameter set to 75 °C — the algorithm checks whether the actual temperature has reached this value before proceeding to the next step.


📋 Properties

Property

Type

Description

Name

Text

Unique identifier for the parameter (e.g., "MaxPressure", "TargetTemp")

Phenomenon

Text

The physical phenomenon being measured (e.g., "Temperature", "Pressure", "Flow", "Level")

Unit

Text

The unit of measurement (e.g., "°C", "bar", "L/h", "mm")

Default Value

Decimal

The default numeric value for this parameter

Custom Attributes

Collection

User-defined attribute key-value pairs


🔧 How Parameters Work

Parameters provide named references to numeric values in condition expressions. Instead of writing a hard-coded number in a condition, you reference a Parameter by name. This has several benefits:

  1. Readability — "Temperature > MaxTemp" is clearer than "Temperature > 85.0"

  2. Reusability — the same parameter can be used in multiple conditions across steps and processes

  3. Maintainability — changing the threshold means updating one parameter, not every condition that uses it

Used In

Parameters are used in the Condition Builder when creating formal condition expressions. They appear in the operand selection list and can be compared against instrument readings, other parameters, or literal values.


📊 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

Example

"MaxPressure = 3.0 bar"

"RecordedTemp (0–150 °C)"


📖 How To: Define Parameters for Your Module

  1. Open Module Data — Navigate to the Data panel in the Module Ribbon and open the Module Data window.

  2. Go to the Parameters tab — Select the Parameters section.

  3. Create a new Parameter — Click "Create new" and give it a descriptive name (e.g., "MinCIPTemp", "MaxPressure").

  4. Set the phenomenon and unit — Choose the physical quantity (Temperature, Pressure, Flow, etc.) and unit (°C, bar, L/h).

  5. Set the default value — Enter the numeric value that will be used as the threshold in conditions.

  6. Use in Algorithm Design — Reference this parameter in your Condition Builder expressions.

💡 Tip: Use a consistent naming convention for parameters. For example, prefix with "Min", "Max", "Target", or "Limit" to make the purpose immediately clear: MinCIPTemp, MaxPressure, TargetFlowRate, LimitCirculationTime.


📤 Excel Export / Import

Parameters support Excel export and import for bulk management:

Exported Field

Description

Name

Parameter name (used as identification key)

Phenomenon

Physical phenomenon

Unit

Unit of measurement

Default Value

Default numeric value

Custom Attributes

All user-defined attributes

You can export parameters 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 Parameters

Parameter Name

Phenomenon

Unit

Default Value

Description

MaxPressure

Pressure

bar

3.0

Maximum allowable CIP circuit pressure

MinCIPTemp

Temperature

°C

75.0

Minimum caustic wash temperature

MaxCIPTemp

Temperature

°C

95.0

Maximum CIP temperature (safety limit)

TargetFlowRate

Flow

L/h

5000

Target CIP circulation flow rate

CirculationTime

Time

min

15

Minimum caustic contact time

DrainTimeout

Time

s

120

Maximum time allowed for drain step

🏭 Example: SIP Module Parameters

Parameter Name

Phenomenon

Unit

Default Value

Description

SterilizationTemp

Temperature

°C

121.0

Required sterilization temperature

SterilizationHoldTime

Time

min

20

Minimum hold time at sterilization temperature

MaxSteamPressure

Pressure

bar

3.5

Maximum steam pressure (safety limit)

CooldownTargetTemp

Temperature

°C

40.0

Target temperature after cool-down

MinCondensateDrain

Level

%

5.0

Minimum condensate level before drain is complete