AseptSoft Core Documentation
Breadcrumbs

Module Data

Module Data is the collection of all data definitions within a Module. These definitions are shared across all Processes and Steps within the module, and form the foundation for your process data model.

💡 Think of Module Data as the vocabulary of your process. Before you can design a CIP sequence or define an SFC algorithm, you need to tell AseptSoft what states your valves can be in, what fluids flow through your pipes, what parameters to monitor, and what alarms to watch. Module Data is where all of that is defined.


🗂️ Data Types at a Glance

Module Data is organized into categories. Each data type serves a specific role in your process design:

🔄 States and Fluids

Data Type

What It Does

Example

🔵 State

Defines the physical positions of valves and instruments, with colors and fluid flow behavior

"Open" (green, allows flow), "Closed" (red, blocks flow)

💧 Fluid

Defines the media flowing through your piping — with colors, priority, and aggregation

WFI (blue, liquid), CIP Caustic (purple, liquid), Steam (gray, gas)

📊 Parameters and Variables

Data Type

What It Does

Example

📏 Parameter

Named thresholds and limits used in conditions — "check if temperature exceeds this value"

MaxTemp = 95 °C, MinPressure = 1.5 bar

📝 Variable

Named storage values written by actions — "record the current reading into this variable"

RecordedTemp (0–150 °C), BatchVolume (0–10000 L)

⚙️ Process Automation

Data Type

What It Does

Example

💬 Dialog

Operator interaction prompts — confirmations, numeric inputs, and button selections

"Confirm CIP solution is prepared", "Enter target temperature"

🚨 Alarm

Monitoring conditions that alert operators when limits are exceeded

High-High temperature alarm on CIP tank at 98 °C

🛡️ Interlock

Safety protection logic that prevents unsafe operations or drives equipment to safe states

"Block CIP start if drain valve is not confirmed closed"

🔁 Control Loop

PID control strategies for continuous process variable regulation

Temperature control loop for SIP sterilization (TIC-101)

🏭 Equipment

Data Type

What It Does

Example

🔧 Equipment Module

Groups of valves and instruments that work together as a functional unit

"Tank Inlet Module" with inlet valve + vent valve + pressure transmitter

🧩 Process and Algorithm Design

Data Type

What It Does

Example

📐 Process Design

Processes (CIP, SIP, Production) broken into sequential Steps with valve state assignments

CIP process with Fill → Circulate → Drain steps

🧠 Algorithm Design

SFC/GRAFCET logic defining transition conditions between steps

"Wait for temperature > 75 °C, then proceed to next step"


🏭 Pharma Industry Context

In a typical biotech or pharmaceutical facility, your Module Data might include:

Category

Typical Entries

States

Open, Closed, Partial (50%), Transition, Water Source, Steam Source, Drain Open

Fluids

WFI (Water for Injection), CIP Acid, CIP Caustic, Product, Steam, Nitrogen, Compressed Air

Parameters

MaxTemp, MinTemp, TargetFlowRate, CirculationTime, DrainTimeout, SterilizationHoldTime

Variables

RecordedTemp, BatchVolume, CycleCounter, AccumulatedFlowTotal

Dialogs

"Confirm CIP start", "Enter batch ID", "Acknowledge sterile breach"

Alarms

High temperature, Low flow, Tank overflow, Pressure deviation

Interlocks

"Block start if valves not confirmed", "Trip on overpressure", "Hold on temperature deviation"

Control Loops

CIP temperature control, SIP steam pressure, Product fill flow rate

Equipment Modules

CIP Supply Manifold, Tank Inlet Group, Transfer Path A/B/C


📖 How To: Set Up Module Data for a New Process

Follow these steps to build out the data model for a new module (for example, a CIP skid):

  1. Define your Fluids — Start by creating entries for every fluid that will flow through the system (WFI, CIP Acid, CIP Caustic, Steam, etc.). Assign each a distinct color and priority. See Fluid.

  2. Define your States — Create the valve states your process needs (Open, Closed, Partial, etc.) and set the fluid response for each. See State.

  3. Create Parameters and Variables — Add the numeric thresholds your conditions will check (MaxTemp, MinPressure) and the storage variables your actions will write to (RecordedTemp, BatchVolume). See Parameter and Variable.

  4. Set up Equipment Modules — Group related valves and instruments into functional units with configuration templates. See Equipment Module.

  5. Create Dialogs — Define operator prompts for confirmations, data entry, and decision points. See Dialog.

  6. Define Alarms and Interlocks — Add monitoring conditions and safety protection logic. See Alarm and Interlock.

  7. Set up Control Loops — Define PID strategies for continuous process variable regulation. See Control Loop.

  8. Design Processes and Algorithms — Finally, create your processes with steps and define the transition logic. See Process Design and Algorithm Design.


🔧 How to Access

Open the Module Data window from the Data panel in the Module Ribbon. The window organizes all data types into tabs for easy navigation.


🔄 States and Fluids — Overview

States define what condition an Engineering Item (valve, pump, instrument, etc.) can be in. Each state has a name, color, and fluid response that determines how it affects fluid flow.

Fluids define the types of fluids that flow through the piping system. Each fluid has a name, color, aggregation (Liquid or Gas), priority, and flow direction.

💡 States and Fluids work together: when a valve is set to an "Open" state with a fluid response of "Allow fluid to pass", the fluid flows through. When set to "Closed" with "Block fluid", flow is stopped.

Property

State

Fluid

Name

Color

Fluid Response

✅ (Allow, Block, Unknown, Change Into, Generate)

Percentage-based

✅ (blend between state and zero-state colors)

Usages

✅ (valve type compatibility)

Aggregation

✅ (Liquid, Gas, Not specified)

Priority

✅ (determines which fluid wins in conflicts)

Reversed Flow

✅ (indicates reverse direction)

Custom Attributes


📊 Parameters and Variables — Overview

Parameters are named values used in condition expressions — they represent thresholds, targets, and limits that the control logic checks against.

Variables are named storage values used in action expressions — they represent calculated values, counters, and recorded measurements.

Property

Parameter

Variable

Name

Phenomenon

✅ (e.g., Temperature, Pressure, Flow)

Unit

✅ (e.g., °C, bar, L/h)

Default Value

Min / Max Range

Custom Attributes

Excel Export/Import


⚙️ Process Automation — Overview

💬 Dialogs

Dialogs are reusable operator interaction templates. They prompt the operator with a message and collect a response — such as a whole number, a decimal value, a yes/no answer, free text, a button selection, a confirmation, a continue-or-abort decision, or a continue-or-restart decision. Dialogs can contain buttons and input controls (checkboxes, radio buttons, text fields, numeric inputs, and decimal inputs).

🚨 Alarms

Alarms define monitoring conditions with limit types (High-High, High, Low, Low-Low, or Discrete on/off), setpoints, priority (Critical to Diagnostic), severity (Emergency to Log Only), classification, acknowledgement rules, shelving rules, routing flags, and return-to-normal behavior.

🛡️ Interlocks

Interlocks define safety protection logic following ISA-88 standards. They include scope, type (Command permissive, Runtime hold, Trip/Abort, Transition permissive, Mode exclusivity, Lineup proof, Instrument health check, Quality gate, or Bypass rule), effect (Inhibit command, Force hold, Force abort, Block transition, Inhibit mode change, or Force stop), cause conditions, safe actions, latching/reset policies, bypass policies, and notification flags.

🔁 Control Loops

Control Loops define PID control strategies with pattern (Basic PID, Cascade, Ratio, Split Range, Override, or On/Off), criticality, process variable configuration, setpoint sources, controller tuning, output limits, final control elements, mode handling, failure behavior, and phase interaction.


🔧 Equipment Modules — Overview

Equipment Modules group related Engineering Items into reusable functional units using a template-based system:

  1. Configuration Template — defines item slots (which valves/instruments belong to the group)

  2. Configurations — named instances of the template (e.g., "Path A", "Path B", "Path C")

  3. Configuration Items — the actual valve/instrument assignments within each configuration

🏭 Equipment Modules are typically used for transfer paths, CIP manifolds, and other groups of equipment that operate together.


🛠️ Common Operations

Operation

Description

Create

Add a new data item from the Module Data window

Edit

Modify properties of an existing data item

Duplicate

Create a copy of an existing data item

Delete

Remove a data item (checks for dependencies first)

Search

Filter data items by name or content

Excel Export

Export data items to Excel for review or transfer

Excel Import

Import data items from Excel