Documentation

Revisions, review and change management

Revisions with locked pages and marked changes, the approval workflow, baselines with compare and merge, comments and redlining, and change requests.

Revisions

A revision stores a snapshot of all pages and can release (lock) them; locked pages are read only. Changes since the last released revision (added / changed / removed symbols, wires, texts, graphics, dimensions, images, connection and cable definitions, pages and their properties) are listed, marked on the pages with a revision triangle and reported in the revision overview; changed items name the changed properties with old and new value (Device tag: -K1 › -K2; Position).

Release workflow

With approvers defined (Project data › Revisions… › Approval workflow: user names and the number of approvals needed) a new revision starts as a draft, is submitted for review, approved or rejected by the approvers (recorded with user, date and note) and released once approved. Pages changed in any way after the submission block the release until the revision is submitted again (earlier approvals become void).

Baselines and compare / merge

A baseline stores the whole project (pages, devices, parts, cables, panel layout, settings); releasing a revision stores one automatically. Project data › Compare and baselines… compares the project with a baseline, the pages of a revision or another project file: added / removed / changed pages (with the changed items), devices, parts, potentials, cables, harnesses, enclosures, terminal strips, plugs, PLC cards and settings sections. Selected differences are taken over.

Review: comments and redlining

Comments on a page position with status (open, in progress, resolved, rejected), author, date and replies; redline (to be changed) and greenline (changed as built) markup as line, rectangle, revision cloud or text. They are drawn on a layer of their own (shown on screen, not in exports), listed in the Review tab of the navigator and can be added to released pages and to pages another user has locked. On the project server they are merged record by record without locks. PDF comments a reviewer made in a PDF export (Acrobat or another viewer: notes, text boxes, highlights, shapes, replies) are imported into the review layer (Review › Import PDF comments…, command import_pdf_comments); rectangles and lines also become redline markup, comments imported before are skipped.

Change requests

Requests from inside or outside the project (number, title, description, requester, origin, priority, status, affected pages and devices, implementing revision) with linked comments (Project data › Change requests…). Exchange with other systems as CSV (Number;Title;Description;Requester;Origin;Date;Priority; Status;Pages;Devices;Revision) or JSON; importing updates requests with a known number.

This document in the repository

More documentation

Getting started: from the first page to the bill of materials

This tutorial walks through a small control circuit in OpenECraft: pages, symbols, wires, devices with parts, terminals, a PLC, the project check, reports, the panel layout and the output. Commands are written as Tab ›…

Read

Installation and building

Packages for Windows, Linux and macOS, the web version, and building from source.

Read

User interface

The editor's layout and the commands and keys of everyday work. New users start with the tutorial.

Read

Schematic editor

Pages, devices and their structure, live cross references, editing tools, navigators and project storage. The user interface lists the commands and keys.

Read

Symbols and libraries

The built-in symbol libraries (IEC, NFPA / JIC, GB, GOST, JIS, fluid power, P&ID, single-line) and the symbol editor for own symbols.

Read

Wires, cables, potentials and numbering

How connections get their cable, colour, cross-section and number, and how devices, pages and wires are numbered.

Read

Terminal strips, plugs, PLC and marking

Terminal strips with multi-level terminals and accessories, plugs, PLC cards with the exchange to PLC programming tools, and the markers for the workshop.

Read

Macros, configurator and table editing

Reuse of circuits as macros with variants and placeholders, pages generated by the configurator, and bulk changes in tables and spreadsheets.

Read

Parts management

The parts database shared by all projects (EPLAN style): commercial, technical and mounting data, function templates, connection points, 2D / 3D graphics and the import of manufacturer data. Parts are shared between…

Read

Reports, forms and the project check

Reports as windows, CSV / Excel or live report pages, title blocks and report forms (also graphical and own drawn forms), and the project check with its message management.

Read

Electrical sizing, calculations and verification

Conductor sizing, short circuit and protection coordination, load calculation, EMC, functional safety and rule sets – all part of the project check – and the inspection and test report of the installation.

Read

Panel layout, rooms and 3D routing

OpenECraft aligns the device's clip to the rail centerline. For Beckhoff's 12 × 100 × 68 mm EL I/O housings with 8 or 16 terminals, and the matching EK1100 coupler, the rail center is 63.8 mm from the top. For example…

Read

Wiring and mounting assistants

The panel layout as a checklist for the workshop, on a desktop or a tablet.

Read

Fluid power, process and plant engineering

Hoses and pipes in their own nets, electro-fluid links, PCT loops, the pre-planning of the plant and single-line / multi-line engineering.

Read

Wire harnesses

Harnesses with 3D topology, protections and fixings, KBL export, the harness interface for machines and nailboard drawings (Connections › Harnesses…). The example project conveyor has a door harness.

Read

Output and data exchange

PDF, DXF / DWG, SVG and 3D exports, DXF / DWG import, the enterprise integration layer (ERP, PDM, PLM, ECAD, MCAD, procurement, wiring machines) and Autodesk Vault.

Read

Command line, MCP server and plugins

Projects and the parts server without a window, for scripts and AI agents.

Read

Plugins

OpenECraft is extended through the openecraft-api crate. A plugin adds

Read

Parts server and parts manager

The data portal shared by all OpenECraft installations and the app that maintains it.

Read

Project server

Shared projects for a team: several users work on the same project, each page is locked by one of them.

Read

Access control of the servers

The parts server and the project server share one access model: users sign in with a local account or with a directory (Active Directory, OpenLDAP or another LDAP server), and what they may do comes from roles given to…

Read