Skip to content

SolidCraft

pawelcel edited this page Nov 17, 2026 · 3 revisions

SolidCraft

EasyPDM in SolidCraft: Upload, Download, Log in and Log out under Plugins → EasyPDM and as buttons on the ribbon.

SolidCraft's Plugins menu with EasyPDM's commands, and the same as buttons in the ribbon's Plugins group

How it works, in one paragraph

SolidCraft plugins have no network access, so it takes two pieces. The EasyPDM plugin inside SolidCraft only leaves each action as a small request in a folder, Documents/EasyPDM/outbox. The EasyPDM SolidCraft companion, a small program running beside SolidCraft, picks the requests up and does the talking to your EasyPDM server — upload, download, the browser for picking items. Without the companion running, the menu entries do nothing visible.

What you need

  • SolidCraft 0.43 or later (0.42 cannot give a plugin the file access Upload needs).
  • An EasyPDM 0.9 server, and your login to it in the browser.
  • From the latest EasyPDM for SolidCraft release: EasyPDM_SolidCraft_Companion_win-x64_vX.zip (Windows) or EasyPDM_SolidCraft_Companion_linux-x64_vX.zip (Linux). It holds the companion program and the plugin. Nothing else to install: no .NET, no Python.

Step by step

1. Unpack the companion where it will stay

Unpack the zip into a folder it can stay in — autostart (step 5) remembers the program's place:

  • Windows: e.g. C:\Users\<you>\EasyPDM — the program is easypdm-companion.exe.
  • Linux: e.g. ~/.local/opt/easypdm-companion — the program is easypdm-companion.

Open a terminal in that folder (Windows: PowerShell, Open in Terminal on the folder). The commands below are written for Linux; on Windows type .\easypdm-companion.exe instead of ./easypdm-companion.

2. Sign the companion in to EasyPDM

./easypdm-companion login --server http://192.168.1.10:5000

with your server's address. Your browser opens EasyPDM and asks whether to let the companion sign in, showing a code — the same one the terminal shows. Click Allow.

EasyPDM in the browser asking whether to let a program sign in

3. Prepare the plugin for this computer

./easypdm-companion setup-solidcraft

It writes Documents/EasyPDM/easypdm-solidcraft.zip: the plugin with this computer's outbox folder filled in, and creates that folder.

4. Install the plugin in SolidCraft

In SolidCraft: Plugins → Install plugin…, pick Documents/EasyPDM/easypdm-solidcraft.zip. The install dialog lists what the plugin asks for:

  • tick Reading and writing files,
  • for “outbox”, choose the folder Documents/EasyPDM/outbox,
  • Install.

Without both, Upload's Run button stays off with "permissions that have not been granted: file" — remove the plugin (Preferences → Plugins → Remove) and install it again. Installed, it shows under Preferences → Plugins:

SolidCraft Preferences → Plugins with the EasyPDM plugin installed and turned on

5. Let the companion start with your session

./easypdm-companion autostart

From now on it starts in the background whenever you log in to your computer, and tells you how each upload or download went in a desktop notification. Start it now without logging out:

./easypdm-companion watch

(watch in a terminal shows what it does, line by line — handy the first time. With autostart it runs as watch --background and writes to companion.log: %LOCALAPPDATA%\EasyPDM on Windows, ~/.local/state/EasyPDM on Linux. autostart --off removes it.)

6. Let downloads open in SolidCraft

SolidCraft: Preferences → Assistant, section Agents through MCP, tick Let AI agents connect. The companion opens a downloaded design through this local channel; it listens only on this computer. Without it, downloads are saved but not opened.

SolidCraft Preferences → Assistant, Let AI agents connect turned on

7. First upload

Open a design and Plugins → EasyPDM → Upload (or the Upload button on the ribbon) → Run. The browser opens EasyPDM with the form for a new item; save it there, and the companion uploads the design. From then on the design knows its item, and SolidCraft's part number and revision show EasyPDM's record name and revision; the next Upload goes straight to it.

Using it

  • Upload — the design goes up as <record name>.<revision>.sc, with a STEP, a preview (its background cut out, as FreeCAD's previews are) and the mass. A design that links other designs (Insert Design) is an assembly: each linked design goes up first as an item of its own, then the assembly with SolidCraft's quantities as its BOM. A released item gets a new revision only with a comment (the Comment field of the Upload form).
  • Download — pick the item in the browser; it lands in Documents/EasyPDM/designs, with its linked designs for an assembly, and opens in SolidCraft.
  • Log in / Log out — the same as step 2, from SolidCraft.

Progress shows in the browser's transfer panel, file by file.

When something does not happen

What you see Why, and what to do
Upload's Run is greyed out, permissions not granted: file The plugin was installed without file access or the outbox folder: remove it and install again (step 4).
Run works, but nothing happens in the browser The companion is not running: start ./easypdm-companion watch (step 5).
The companion says Not logged in Step 2 again.
A download is saved but does not open Step 6.
The browser tab does not come to the front The companion normally brings it forward; when the desktop does not allow it, the request still waits in the EasyPDM tab already open — switch to it.

Requests are files: every action leaves <id>.request.json in the outbox and, once handled, <id>.result.json beside it with what happened.

Not there yet: SolidCraft has no drawing workspace, so there is no title block or drawing PDF for it.

Clone this wiki locally