mesoneer-ag/camunda-modeler-property-info-plugin

This plugin serves a better overview which properties are set per shape.

Camunda Modeler Property Info Plugin

This plugin serves a better overview which properties are set per shape.

About plugin

Camunda Modeler Property Info Plugin created by mesoneer AG allows its users to have a batter overview over BPMN processes, which may be helpful to get a better understanding of how processes are built and how elements interact. This Plugin is useful for processes of any size and complexity and may be helpful for developers and business specialists in order to better understand what is 'under the hood'.

How to install

Windows:

• Create new folder in your Camunda directory - {MODELER_LOCATION}/plugins
• Download and unzip plugin files into a new plugins folder

MacOS:

• Create new plugins folder in /Users/{USER_NAME}/Library/Application Support/camunda-modeler directory
• Download and unzip plugin files into a new plugins folder

A compressed version is always available in the release section.

How to use

When in Modeler:

Press Alt + Y to display Main Elements
Press Alt + T to display Transactions and Job Priorities
Press Alt + X to display Element IDs

Possible Badges

Input
Output
Variable

Listener
Task Listener

Extension
Field Injection

Element id
Documentation
Transactions

Is Executable
Is not Executable

Licence

Apache License, Version 2.0, January 2004

camunda-modeler-property-info-plugin's Issues

[transactions] show implicit transaction boundaries

I am using your transactions branch, which shows also transaction boundaries. It would be awesome, if also the implicit transaction boundaries, caused by user tasks and intermediate timer and message catch events, were shown.

Display all documentation "post-it" with text

Hello,

as of now, the plugin draws a yellow corner for the diagram elements that have a non empty documentation. In order to see the text, one has to move the mouse over the yellow corner.

It would be cool if it was possible to display all the texts at the same time so that one can see and read all the documentation notes without having to move the mouse.

Ideally, this would be a toggle switch ("show all" / "hide all").

Thank you.

Feedback about usability and bug report

Hi,
we've gotten the following feedback from a Camunda customer about this plugin:

Usability:

• Die Overlays werden beim Herauszoomen aus dem Prozessmodell komplett ausgeblendet
• Ich würde mir wünschen, dass zumindest die Information, dass hier Properties gefüllt sind, auf irgendeine Art und Weise erhalten bleiben, auch beim herauszoomen
• Genauso würde ein Filter zum Aktivieren/Deaktivieren für einzelne Arten von Properties helfen
  Bugs:
• Startet man den Camunda Modeler nicht über die camunda-modeler.exe (Sondern über einen Klick auf eine BPMN Datei) im Programmordner, so wird das Highlighting des Plugins nicht im Prozess Modell angezeigt

Thanks and best regards,
Mat

Pool executable icon

Add icon indicating if Pool is executable
.

Add Sequence Flow Condition Type Icon

It is common to accidentally delete configuration of a sequence flow because you do not know it there unless you are clicking into all of the sequence flows.

Would be helpful to have a icon on sequence flows that show what condition type (if any) has been selected.

Updates for Camunda Modeler 5

Hello, Valentin from Camunda here.

With Camunda Modeler 5.0.0 we are making some changes to how we handle plugins.

First off, our docs have moved here.

In short, plugins now work for Cloud bpmn-js diagrams, and will automatically be picked up. This plugin was identified as non breaking with some partial functionality. If you'd like to opt-out of cloud diagrams, you'll have to use the new plugin registration helper functions that were shipped in https://github.com/camunda/camunda-modeler-plugin-helpers v5.0.0, i.e replacing registerBpmnJSPlugin with registerPlatformBpmnJSPlugin

Or you could extend the plugin to fully support Cloud, or keep it in this state, whatever you decide is best.

Note that opting out will break backwards compatibility, since those registration functions do nothing pre Camunda Modeler 5, so you may want to reference an older build somewhere in the README for people using older versions of Camunda Modeler, if you decide to go that direction.

Feel free to ask me anything about this 😄

Plugin not compatible with Camunda Modeler 3.7.0 (macOs)?

When I use the plugin with Modeler 3.7.0 (on macOS 10.14.6) and enable Overlays on a fairly simple process (without listeners etc), overlays won't show, but an error is thrown instead:

Cannot read property 'extensionElements' of undefined
    at addStyle (file:///Users/zilskes/Library/Application%20Support/camunda-modeler/plugins/camunda-modeler-property-info-plugin/client/client-bundle.js:124:71)
    at toggleOverlays (file:///Users/zilskes/Library/Application%20Support/camunda-modeler/plugins/camunda-modeler-property-info-plugin/client/client-bundle.js:73:21)
    at Object.togglePropertyOverlays (file:///Users/zilskes/Library/Application%20Support/camunda-modeler/plugins/camunda-modeler-property-info-plugin/client/client-bundle.js:34:13)
    at opts (webpack:///node_modules/diagram-js/lib/features/editor-actions/EditorActions.js:170:31)
    at trigger (webpack:///src/app/tabs/bpmn/BpmnEditor.js:610:33)
    at triggerAction (webpack:///src/app/tabs/MultiSheetTab.js:258:18)
    at triggerAction (webpack:///src/app/tabs/EditorTab.js:36:33)
    at triggerAction (webpack:///src/app/App.js:1678:15)
    at fn (webpack:///src/app/App.js:2188:19)
    at file:///Applications/Camunda%20Modeler.app/Contents/Resources/app.asar/public/bundle.js:51:129365 [ error ]
This error may be the result of a plug-in compatibility issue. [ info ]
Disable plug-ins (restarts the app) [ info ]

Is there a compatibility issue with latest Modeler version?

Job Priority Number

Would be nice to have job priority number shown. To prevent job starvation there are sometimes very specific job priority configurations that are good to see on overviews.

Inactive Repo for highly required extension

Hello @itsmefox ,

this repo seems to be inactive for 5 years now. There are several issues and PRs to be handled. What would think of moving this repo to the community hub?

Here is a doc that shows you how: https://github.com/camunda-community-hub/community/blob/main/transferring-extensions.md

Please feel free to reach out if you have any questions.

Add Async Info to overlay

Add Async Info to overlay

On all items including gateways

Toggling shortcut CTRL+Y does not work on Windows/Linux

The overlay toggling shortcut CTRL+Y does not work on Windows/Linux. It overlaps with the "redo" shortcut on Windows and Linux.

Execution Listeners (L) on Sequence Flows

In reviewing another's BPMN diagram, I discovered that Sequence Flows can also associate Execution Listeners. However, as I've come to rely on this lovely plugin to highlight implementation aspects, it doesn't indicate execution listeners when these are applied to a sequence flow.

Error reported when using with Modeler 4.x

Hello 👋🏻

Starting with Camunda Modeler 4.0.0 an error raised a couple of times (more than 6k error events) inside our error tracking tools which we identified from this plugin (cf. camunda/camunda-modeler#2001)

TypeError: Cannot read property 'extensionElements' of undefined
  at addStyle (~/build/client-bundle.js:124:71)
  at None (~/build/client-bundle.js:44:13)
  at None (~/build/client-bundle.js:2153:43)

I reproduced it when I tried to trigger the overlays for a participant with no processRef. Hard to reproduce though, maybe there is an easier way to reproduce.

Element Documentation Icon

Icon to represent that the element documentation field has content.
Might be better to make this a secondary toggle.

edit: could be good for Pool's Process Documentation as well

Modeler looses it's history when this plugin is installed

The modeler seems to loose it's most recent open file history when this plugin is installed. Toggling it on and off has no effect either. If you close the modeler with a model open and displayed, and then re-invoke the modeler, it opens without any model. It should open with the most recent open model displayed and all other models that were open at the time in additional tabs.

Plugin Breaks Camunda Modeler When Using Collapsed Participants

Using this plugin can break the Camunda Modeler. To reproduce this issue:

1. Use this plugin
2. Create a collapsed participant

The error occurs because a collapsed participant does not have a processRef property which the plugin doesn't account for: https://github.com/mesoneer-ag/camunda-modeler-property-info-plugin/blob/master/client/PropertyInfoPlugin.js#L123

The error message: TypeError: Cannot read properties of undefined (reading 'extensionElements')

Asynchpoints missing

At CamundaCon 2018 the plugin was able to show a lot of things, including asynch points (blue square). I downloaded the current version from GIT and included it into the modeller and... asynch points are missing.

Was the demo at CamundaCon 2108 running with a newer version or do I have to modifiy some configuration somehow?

Plugin should not be enabled/toggled-on by default

Currently the plugin is enabled by default. It should be disabled by default.

Selection Markers?

have a use case that i thought might be a good use for property-info-plugin.

Often we are sharing/printing a BPMN and there are specific sections we want to highlight.

So say there was 5 activities we wanted to label/highlight.
We dont want to make changes to the actual BPMN as its version controlled with GIT.

But something such as doing a multiple select, or going into "select" mode that would like you click N number of elements which would then be numbered, or possibly show the IDs, or some sort of numbers/text based identifier.

The purpose is that once the BPMN is exported to an image, there is a write-up that occurs explaining the each of the elements.

Thoughts?

Conflict with registering plugin name

Please change registering plugin name on PropertyInfoPlugin.js file. The name exported (clientPlugin) is a bit overused because it's camunda-modeler-plugin-example, 'propertyInfoPlugin' is more talkative.

Add option to show element ID as a label.

At times you want to see the element IDs on all elements. Could be for writing migrations or checking errors, etc.

Would be great to have a the ability to toggle the showing of element IDs.

CVE-2023-46234 security vulnerability in package browserify-sign 4.2.1

Hi,
we are using your plugin and the OWASP dependency-check reports a security vulnerability (https://nvd.nist.gov/vuln/detail/CVE-2023-46234) in the package browserify-sign 4.2.1 which could be fixed with version 4.2.2. Is there any possibility that you could provide a fix for this?

Regards,
Sascha

Tasks: Extension icon is not removed from overlay when Extension is deleted.

Documentation badge doesn't fit on Events