-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[FEAT] Add a new experimental API to get a edge/node by name #2453
Comments
As part of process-analytics/bonita-day-demo-2023#10, I have introduced an object (internal to the demo) in charge of retrieving the corresponding BPMN element or id given a name. It does the job with what is publicly available in bpmn-visualization, there may be performance issues and it doesn't include tests. So, consider it as extra experimental. I plan to later extract it into a dedicated experimental npm package for reuse at least in other demos. It will also help to iterate on this feature, challenge the API and the implementation. |
Duplicated with #14 ? |
I don't understand, I gess you mean another issue number? The currently mentioned issue is about "Validate that the library performs better than Bonita Enterprise visualization" |
Available as experimental add-ons in https://github.com/process-analytics/bv-experimental-add-ons/releases/tag/v0.1.0 |
Currently, we only provides APIs that take BPMN element ids as parameters.
However, there are scenario where the ids in the BPMN diagram have been generated and are unknown by the application. Instead, the app knows the name of the elements.
So having APIs that take element names as parameter will allow such application to better interact with the diagram.
Use cases that require the new API
bv-experimental-add-ons
API using "name" parameters bpmn-visualization-pm4py#14bv-experimental-add-ons
API using "name" parameters icpm-demo-2022#86We may need #953 to implement this request.
Important name
While the BPMN spec enforce unique ids, there is no guarantee that the names are unique in the diagram.
So, when several elements have the same name, we will have to choose one or generate an error. This needs to be clarified prior starting the implementation.
In any case, this should be explicit in the API documentation.
The text was updated successfully, but these errors were encountered: