A State defines a named condition that an Engineering Item (valve, pump, tank, etc.) can be in. Each state carries a color for visual representation on the P&ID and a fluid response that determines how it affects fluid flow.
๐ก In pharmaceutical terms: States are how you tell AseptSoft what position each Engineering Item is in during a given process step. For example, during a CIP rinse, your inlet valve might be in the "Open" state (green, allowing caustic to flow) while the product valve is "Closed" (red, blocking flow).
๐ Properties
|
Property |
Type |
Description |
|---|---|---|
|
Name |
Text |
Unique identifier for the state (e.g., "Open", "Closed", "Partial"). |
|
Color |
Color |
The color shown on the P&ID when this state is active. |
|
Fluid Response |
Selection |
How the state affects fluid flow (see table below). |
|
Attributes |
Text |
Custom text attributes for additional metadata. |
|
Percentage-based |
Yes/No |
Whether this state supports percentage-based blending. |
|
Zero State |
Reference |
Reference to the "zero percent" state (only when percentage-based is enabled). |
|
Zero Color |
Color |
Color shown at 0% (only when percentage-based is enabled). |
|
Zero Fluid Response |
Selection |
Fluid response at 0% (only when percentage-based is enabled). |
|
Usages |
List |
Type compatibility โ which types of Engineering Items can use this state. |
|
Highlightable in active phase |
Yes/No |
When ON, every valve in this state in the active step gets an in-drawing highlight. |
|
Highlighter |
Reference |
The recipe used to paint the highlight โ Master (shared) by default, with the option to fork into a per-state Custom recipe. |
|
Custom Attributes (per phase) |
Collection |
Named values (with optional units) the state carries on each phase ร valve cell โ surfaced in the popup, the matrix, and the Excel sidecar. |
๐ง Fluid Response Types
The fluid response determines what happens to fluid flow when an Engineering Item is set to this state:
|
Response |
What It Means |
Example |
|---|---|---|
|
Allow fluid to pass |
Fluid passes through the item unchanged. |
Valve open โ WFI flows through the pipe. |
|
Block fluid |
Fluid is blocked โ no flow passes through. |
Valve closed โ no fluid can pass. |
|
Unknown |
No fluid information โ treated as neutral. |
State unknown during system initialization. |
|
Change into an existing fluid stream |
Fluid transforms into a specified Fluid. |
A heat exchanger converts water into steam. |
|
Generate a new fluid stream |
A new Fluid is introduced at this point. |
A WFI supply source generates fresh WFI into the system. |
โ ๏ธ Conflict resolution: When multiple fluid responses overlap, the system resolves them using priority: Generate > Change Into > Allow > Unknown > Block.
๐ Percentage-Based States
When percentage-based blending is enabled, a state supports smooth visual transitions between two appearances:
-
At 100% โ the state uses its own Color and Fluid Response.
-
At 0% โ the state uses its Zero Color and Zero Fluid Response (or inherits from the referenced Zero State).
-
At any value in between โ the color is blended proportionally.
๐ญ Pharma example: A modulating control valve (e.g., a steam regulation valve during SIP) might be at 65% open. The P&ID shows a blended color between the "Open" color and the "Closed" color to visually represent the partial position.
How the Zero State Works
The Zero State reference points to another State whose color is used as the 0% baseline color. If a separate Zero Color is also defined on this state, the system uses it as a fallback if the referenced state is not found.
The fluid response at any percentage is determined by comparing the two responses (current state and zero state) and using the higher-priority response.
๐ Highlightable states
Any state can be marked Highlightable in active phase. When it is, every valve in that state in the currently active step gets a coloured highlight in the drawing using the catalog's State Master recipe. The highlight automatically takes the state's own colour and percentage โ no per-state work needed.
|
Step |
What you do |
|---|---|
|
1 |
Open the State editor. Tick Highlightable in active phase. |
|
2 |
(Optional) In the Highlighter dropdown, pick Create Custom... to fork the Master recipe so this one state looks different from the rest. The Highlighter Designer opens with the new recipe selected. |
|
3 |
Save. Switch to the active step in the drawing โ every valve in this state now wears the highlight. |
A Reset button on the Custom row deletes the fork (the state falls back to the Master). Master edits propagate everywhere; Custom forks stay independent.
๐ก The state's colour and percentage flow into the recipe automatically via the
{State.Color},{State.Name}and{State.PercentSuffix}placeholder tokens. See the Highlighters page for the full token list.
๐งฎ Custom in-phase attributes
Some states need values that vary per phase โ a Pulsating state with an Open delay and a Closed delay, a Sterilization state with a Setpoint temperature, a CIP state with a Chemical concentration. Define the attribute keys once on the state, and AseptSoft surfaces them everywhere they're useful.
Defining the keys
In the State editor, add an entry to the Custom Attributes collection for each value the state needs to carry per phase. Each entry is a key (e.g. Open delay) with an optional unit (e.g. s).
Where users enter values
|
Surface |
What you do |
|---|---|
|
Valve hover popup |
While the active step uses this state on a valve, an Attributes in this step section appears with one editable field per key. Press Enter to commit. |
|
Valve ร Step Matrix |
Right-click a cell whose state has attribute keys โ Edit attribute values... opens the standard Attributes form scoped to that (valve ร step ร state) tuple. |
|
Excel sidecar |
The Module Excel export now includes one extra worksheet per Highlightable state-with-attributes, named |
Where the values show up
-
In the highlight on the drawing โ reference
{Attribute.<key>}tokens in the State Master/Custom recipe's text. -
In the Module Word/Excel functional specification.
-
In the round-trip Excel cells.
Step duplication preserves attribute values
Duplicating a step (the common "Step 4 is mostly like Step 3 exceptโฆ" workflow) carries every per-step attribute value across all the (valve ร state) pairs both steps share. The new step's highlights look correct from the moment it's created.
๐ง Usages (Type Compatibility)
The Usages property defines which Engineering Item types are compatible with this state. A state can be assigned to multiple types. When assigning states to Engineering Items, only compatible states appear based on the item's type.
๐ก Tip: If a state should apply to all Engineering Item types in your module, make sure to add each type to the Usages list. If you forget one, that type will not see this state in the selection list.
๐ How To: Create and Assign States
-
Open Module Data โ Navigate to the Data panel in the Module Ribbon and open the Module Data window.
-
Go to the States tab โ Select the States section.
-
Create a new State โ Click "Create new" and give it a descriptive name (e.g., "Open", "Closed", "CIP Drain").
-
Set the color โ Choose a color that will make this state visually distinct on the P&ID.
-
Choose the fluid response โ Select the appropriate behavior:
-
"Allow fluid to pass" for open items.
-
"Block fluid" for closed items.
-
"Generate a new fluid stream" for fluid sources.
-
"Change into an existing fluid stream" for transformation points.
-
-
Set type compatibility โ In the Usages section, select which Engineering Item types this state applies to.
-
Enable percentage-based blending (optional) โ If this is a modulating state, enable the percentage option and set the zero state reference.
-
Mark Highlightable (optional) โ Tick Highlightable in active phase if you want every valve in this state to wear an in-drawing highlight.
-
Add custom attribute keys (optional) โ If the state needs per-phase values (delays, setpoints), add them under Custom Attributes.
-
Use it in Process Design โ Assign this state to Engineering Items in your Process Steps.
๐ญ Example: CIP Module States
Below is a typical set of states for a pharmaceutical CIP (Cleaning in Place) module:
|
State Name |
Color |
Fluid Response |
Percentage-Based |
Highlightable |
Compatible Types |
|---|---|---|---|---|---|
|
Open |
Green |
Allow fluid to pass |
No |
No |
Ball Valve, Butterfly Valve, Diaphragm Valve |
|
Closed |
Red |
Block fluid |
No |
No |
Ball Valve, Butterfly Valve, Diaphragm Valve |
|
Partial |
Yellow |
Allow fluid to pass |
Yes (Zero = Closed) |
No |
Butterfly Valve, Control Valve |
|
Pulsating |
Cyan |
Allow fluid to pass |
No |
Yes (with Open delay / Closed delay) |
Diaphragm Valve |
|
WFI Source |
Blue |
Generate โ WFI |
No |
No |
Source |
|
CIP Caustic Source |
Purple |
Generate โ CIP Caustic |
No |
No |
Source |
|
Steam Source |
Gray |
Generate โ Steam |
No |
No |
Source |
|
Drain Open |
Orange |
Allow fluid to pass |
No |
No |
Drain Valve |
|
Transition |
Amber |
Unknown |
No |
No |
Ball Valve, Butterfly Valve |
๐ญ Why "Transition"? In pharma processes, Engineering Items do not switch instantly. The "Transition" state represents the brief period while an item is moving between positions. During this state, the fluid response is "Unknown" because the position is indeterminate.
๐ญ Why Pulsating is Highlightable with attributes: pulsating valves carry per-phase delays that vary by line size. Attribute keys Open delay and Closed delay let each (valve ร phase) cell carry its own values, the highlight reads them from the cell, and the matrix or the Excel sidecar lets you bulk-edit them.
๐ Related Pages
-
๐ง Fluid โ Fluid flow states used in "Change Into" and "Generate" responses.
-
๐ Module Data โ All module data types.
-
Engineering Item โ Components that states are assigned to.
-
Highlighters โ Master / Custom highlight recipes for Highlightable states.
-
Fluidstream Simulations โ Visualizing fluid flow based on state assignments.
-
๐ Process Design โ Creating processes and assigning states to steps.