AseptSoft Core Documentation

Export Module Data to Word

AseptSoft can export your module's functional specification data to a professionally formatted Word document (.docx). The export produces a structured document containing tables for each data type — covering states, fluids, parameters, variables, alarms, interlocks, control loops, dialogs, processes, equipment module configurations, and algorithm — ready for sharing, review, or inclusion in qualification binders.

💡 When to use Word export: Choose Word when you need an editable, shareable document that stakeholders can review, annotate, and comment on without needing access to AseptSoft. Ideal for distributing functional specifications during design reviews, FAT/SAT documentation, or regulatory submissions.


🖱️ How to Access

  1. Open your module in AseptSoft

  2. Navigate to the Module Ribbon

  3. In the Export panel, click the Word button (alongside the PDF and Excel buttons)


📋 The Export Dialog

When you click the Word button, the Export to Word Document dialog opens. The dialog is organized into two main areas: a shared sidebar on the left for process and PID selection, and the data type cards on the right where you configure each export table.

https://downloads.aseptsoft.ch/documentation/images/Export-Import/Export-Word/export-word-config.png

🏭 Left Sidebar — Shared Selections

The left sidebar contains controls that apply across multiple data types. This avoids repeating the same selections on every card.

Sidebar Section

What It Controls

Used By

🔄 Process Selection

Checkable list of all processes in the module, with an All Processes toggle at the top to quickly select or deselect everything

Processes, Algorithm

📋 PID Selection

Checkable list of all PIDs, with drag-to-reorder so you control the order tables appear in the document

Valve Interlocks, Control Loops, Equipment Module Configurations

💬 Comment

Optional text field — the comment is embedded in the Word document's properties for version notes, reviewer instructions, or any context

All exports

💡 Tip: Select only the processes or PIDs relevant to your current specification. For example, when documenting a single CIP process, check only that process instead of exporting all processes at once.

📊 Data Types

The right panel shows a card for each data type. Toggle each one on or off to include or exclude it from the export.

#

Data Type

Description

Group By Options

1

⚙️ States

All process states with their properties (activation type, color, fluid response)

2

💧 Fluids

Fluid flow definitions used in simulations

None, Flow Type

3

📏 Parameters

Module parameters (setpoints, ranges)

None, Phenomenon

4

🔢 Variables

Module variables (runtime data points)

None, Phenomenon

5

🔔 Alarms

Safety alarm configurations

6

🔒 Valve Interlocks

Interlock logic definitions with sub-mode selection

7

🔄 Control Loops

PID and control loop definitions (PID-aware — uses PID selection from sidebar)

8

🖥️ Dialogs

HMI dialog definitions

9

🏭 Processes

Valve phase matrix — shows which valve state each item takes in each process phase

10

📦 Equipment Module Configurations

Equipment module setup and per-configuration item values (PID-aware)

11

📐 Algorithm

GRAFCET-style step/transition logic per process (process-aware)


🎛️ Per-Card Options

Each data type card offers standard controls, plus some cards have specialized options.

Standard Controls

Option

What It Does

Enable/Disable

Check or uncheck to include or exclude the entire table

🔀 Transpose

Swap rows and columns — useful when a table has many fields but few records

📂 Group By

For Fluids, Parameters, and Variables, group entries by a category (e.g., group parameters by Phenomenon)

📝 Field Selection and Reordering

Expand any data type card to see its field list. Each field (column) has:

  • A checkbox to include or exclude that column from the export

  • A drag handle — grab and drag to reorder columns in the output table

  • All / None buttons to quickly select or deselect all fields

💡 Tip: Drag the most important fields to the top for a cleaner report. Hide internal fields that stakeholders don't need to see.


🏭 Processes (Valve Phase Matrix)

The Processes card exports a valve phase matrix — a table showing which valve state each engineering item takes during each process phase. This is one of the most important tables for understanding how a process operates.

Configuration Options

The card is split into two sub-panels:

Left — Items to Export

Option

What It Controls

Equipment Modules

Include Equipment Module rows in the matrix

Control Modules within EM

Include Control Modules that belong to an Equipment Module

Control Modules without EM

Include orphan Control Modules (not assigned to any Equipment Module)

⏭️ Skip empty Control Modules

Hide Control Modules that have no valve state in any phase

Right — Type Filtering and Nicknames

Option

What It Controls

🔍 Types

MultiComboBox to filter which valve types appear (e.g., show only butterfly valves, ball valves)

🏷️ Nickname by behaviour

When enabled, replaces full state names with short nicknames in the matrix cells

When Nickname by behaviour is enabled, a nicknaming grid appears where you assign short labels to each valve behaviour category:

Behaviour

Default Nickname

Meaning

Open

O

Valve is open

Closed

C

Valve is closed

Generates

G

Valve generates flow

Transforms

T

Valve transforms flow

Unknown

?

State behaviour is not classified

💡 Tip: Nicknames keep the matrix compact and scannable. A cell showing "O" is much easier to scan across dozens of phases than "Full Open Position".

Output

The exported document contains one table per selected process:

  • Rows = engineering items (Equipment Modules, their child Control Modules, orphan Control Modules)

  • Columns = process phases

  • Cells = valve state name (or nickname when enabled)

The process selection in the left sidebar controls which processes generate tables.


📦 Equipment Module Configurations

The Equipment Module Configurations card exports a comprehensive view of how Equipment Modules are set up and what values their Control Module items take across different configurations.

Output Structure

The export produces two levels of tables:

1. Overview Table — One row per Equipment Module:

Column

Content

Name

Equipment Module name

Template

Template the EM is based on

Control Modules

List of child Control Modules

Linked Valves

Valves associated with the EM

Configurations

Configuration names defined for the EM

2. Per-EM Detail Tables — One table per Equipment Module showing configuration values:

  • Rows = Control Module items within the EM

  • Columns = Configuration names

  • Cells = Item value for that configuration

The PID selection in the left sidebar controls which PIDs (and their Equipment Modules) are included.


📐 Algorithm

The Algorithm card exports the GRAFCET-style step and transition logic for each selected process. Two display modes are available:

Display Modes

Mode

Description

Best For

📄 Compact (Step + Humanized)

2-column table with Step and Algorithm columns, using GRAFCET emoji notation (selected by default)

Quick reference, reviews, compact documents

📋 Full (all condition fields)

Expandable field list with individual checkboxes for each condition field

Detailed validation, field-by-field audit

Select the mode using the radio buttons at the top of the Algorithm card.

GRAFCET Symbols (Compact Mode)

In compact mode, the Algorithm column uses these symbols to indicate condition types:

Symbol

Meaning

Transition

Continuous action

Activation action

Deactivation action

Event-driven action

Other action type

Output

  • Compact mode produces one 2-column table per selected process (Step and Algorithm)

  • Full mode produces one table per process with all selected condition fields as individual columns

The process selection in the left sidebar controls which processes generate tables.


🔒 Valve Interlocks

The Valve Interlocks card exports interlock logic definitions. You can select which interlock sub-modes to include:

Sub-Mode

What It Shows

Raw

Raw interlock data as defined

All Forbidden

All forbidden state combinations

All Allowed

All allowed state combinations

Mechanical Design

Mechanical design interlocks

Check one or more sub-modes to include them in the export. Each selected sub-mode generates its own section in the output. The PID selection in the left sidebar controls which PIDs are included.


📁 Export Path

At the bottom of the dialog, set where the document will be saved:

  • Choose the export folder using the path editor

  • Optionally set a custom subfolder name to organize exports by purpose or date

The document is saved as: [Export Folder]/Word/[Custom Name]/[Module Name] - Functional Specification.docx


📄 The Exported Document

The generated Word document follows a clean, professional layout:

Document Structure

Section

Description

🏷️ Title

Module name and "Functional Specification" subtitle, centered

📋 Document Properties

Module version, exported by, export date, and your optional comment

📊 Data Tables

One table per selected data type, each with its own heading

Table Formatting

Element

Style

Header row

Blue background with white bold text

Data rows

Clean rows with borders between cells

Color columns

Columns containing color data display the actual color as the cell background

Font

Calibri throughout

💡 Color preview: If a data type includes color information (like State colors), the exported table shows the actual color as a cell background — making it easy to visually scan color assignments.


🔄 Cumulative Exports

Like all AseptSoft exports, the Word export is cumulative. If you export, then edit the document (add notes, formatting, extra content), and later re-export, AseptSoft merges updated data into your existing file while preserving your edits.


⚙️ Persistent Settings

Your export configuration — which tables are enabled, which fields are selected, field order, transpose and group-by choices, process and PID selections, interlock sub-modes, algorithm display mode, and process card options — is saved as JSON per module. The next time you open the export dialog, your previous selections are restored.

🔄 First-Use Seeding

When you open the Word export dialog for the first time and no Word-specific settings exist yet, the Processes card automatically seeds its configuration from your Excel tabular export settings (if any). This means your item selection, type filters, and nickname preferences carry over — no need to reconfigure from scratch.


🏭 Workflow: Creating a Functional Specification for Design Review

Here's a typical workflow for generating a functional specification document:

  1. Open your module and ensure all data (States, Fluids, Parameters, Processes, Algorithm, etc.) is up to date

  2. Click Word in the Module Ribbon → Export panel

  3. In the left sidebar, select the processes and PIDs relevant to this specification

  4. Enable the data types you want in the report using the cards on the right

  5. Expand each card and reorder fields — drag the most important fields to the top, hide internal fields

  6. For Parameters, set Group By → Phenomenon to organize parameters by measurement type

  7. For Processes, enable Nickname by behaviour for a compact valve phase matrix

  8. For Algorithm, choose Compact mode for a concise GRAFCET overview or Full mode for detailed validation

  9. Add an export comment like "Draft for design review — Rev A"

  10. Click Export — a progress bar shows the export advancing table by table

  11. The document opens automatically — review it, add a cover page or any formatting, then share it with the review team

  12. After receiving feedback, make changes in AseptSoft, then re-export — your cover page and formatting stay intact, only the data tables update

💊 Pharma Example: CIP Module Specification

For a CIP skid module, you might configure the export like this:

Sidebar selections:

  • Processes: CIP Caustic Wash, CIP Acid Wash, CIP Rinse, Sterilization

  • PIDs: PID-001 (Main CIP Skid), PID-002 (Distribution Panel)

Data types:

Data Type

Why Include It

Configuration

✅ States

Shows all valve states (Open, Closed, Throttling) with colors and fluid responses

✅ Fluids

Lists CIP Caustic, CIP Acid, WFI, and their flow types

Group By: Flow Type

✅ Parameters

Setpoints like temperature, concentration, flow rate

Group By: Phenomenon

✅ Variables

Runtime data points (conductivity readings, timer counts)

Group By: Phenomenon

✅ Alarms

Safety alarms for temperature excursions, low flow conditions

✅ Valve Interlocks

Safety interlocks preventing caustic flow without rinse completion

Sub-modes: Raw + All Forbidden

✅ Processes

Valve phase matrix showing which valves open/close in each CIP phase

Nicknames enabled, skip empty CMs

✅ Algorithm

GRAFCET step logic for each CIP process

Compact mode

❌ Dialogs

Not needed for this specification

❌ Control Loops

No PID loops in this CIP module

❌ EM Configurations

Not relevant for this export

The resulting Word document becomes a self-contained functional specification covering both the static configuration (states, parameters, alarms) and the dynamic behaviour (process valve matrix, algorithm logic) — ready for review by the process engineer, automation team, or quality department.