PenstockJetBrains / Start here
Where things are in the IDE
Every place Penstock shows up in a JetBrains IDE, in one table, so you can find any feature.
The map
| Where | What is there |
|---|---|
The editor of a .bpmn, .dmn or .form file | The toolbar (auto layout, Check, Simulate, Monitor, Scenarios, the More menu, Deploy, the sidebar toggle), the palette beside the canvas, the canvas, and the sidebar with its tabs: Properties, Scenarios, Problems, Comments, Monitor and Code. See The BPMN editor and The sidebar. |
| The Tools menu, Tools | Penstock, Find Action and the Keymap | Every action of the editor in seven groups (Check & run, Layout & convert, Deploy & share, View, File, Edit, Help), so a shortcut can be bound to any of them the way the IDE binds its own. They work while a Penstock editor has the focus. See The toolbar and the More menu and Shortcuts. |
| Code inspection, under Settings | Editor | Inspections | Penstock | Five inspections. The first puts the check's findings in the IDE's Problems window and marks the file in the Project view. The others check names in your code against the diagrams. See Settings in the IDE and Diagram check. |
| Tabs at the foot of the editor | BPMN Editor (or DMN Editor, Form Editor) and Text. A test-case file has Scenarios after its text. See The editor in the IDE. |
| The Penstock tool window, left side | Your project as a tree: processes, tests, workers, element templates, variables, messages, errors, decisions, forms, deployment and files, and the Migrate to Camunda 8 root. The Run Penstock menu, deploy, Check Workers. While the debugger is stopped, a Debug section. See The Penstock tool window. |
| The Run window and Run | Edit Configurations | The output of the Run Penstock actions, and the test tree of test-case runs. The run configuration type Penstock test cases. See Tests in the IDE. |
| The gutter of a Java or Kotlin file, and of a test-case file | Icons that jump to the tasks that use a string, and green triangles that run a test case. See Code links in the IDE and Tests in the IDE. |
| The context menu of a Java or Kotlin file | Create element template, on a job worker. Rename (Shift+F6) also changes the diagrams that name it. See Rename in the IDE. |
| Above a worker, delegate, bean or test | Code Vision: which tasks it runs, how many tests reach it, how much of a process a test covers. |
| The context menu of a diagram element | Editing actions, Go to a class, Go to Implementation, Find Usages in Code, Run Tests, Debug Tests. |
| The Tools menu, last entry | Penstock licence…. See Licence in the IDE. |
| The Help menu, last entry | Penstock Documentation opens this guide in your browser. The same link is on the Penstock page of the settings, under Documentation. |
| The status bar | The licence: Penstock Free, Penstock Pro trial: 27d, Penstock Pro or Penstock Team. Click it for the licence dialog. |
| The IDE's diff window | Two diagrams instead of two blocks of XML, for a .bpmn file. Pro. See Diagram diff. |
| Settings | Tools | Penstock | The version, the open-source licences, and the projects Penstock trusts. No project settings: the project is set up in penstock.yaml. See Settings in the IDE and penstock.yaml. |
| Notifications | What's new after an update, project settings that can move to penstock.yaml, a penstock.yaml Penstock cannot read, a request to trust the project, the result of a deployment, an offer to rename. See Settings in the IDE. |
What you see
A JetBrains IDE with Penstock has a Penstock icon on the left tool window bar and, after you open a diagram, a toolbar, a palette, a canvas and a sidebar inside the editor. The first time the editor opens, a short tour points out the palette, the properties panel, Check, the tool window, Deploy and the More menu. It is shown once; Show the tour again in the More menu replays it.
Common problems
- I cannot find a feature.
- Check the table above. Some actions are in the More menu of the editor. See The toolbar and the More menu.
- There are no project settings in Settings.
- Right. Settings | Tools | Penstock shows the version and the trusted projects. The project is set up in
penstock.yaml, and the personal choices are in~/.penstock/preferences.json.