Skip to content
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

Closed
csouchet opened this issue Jan 16, 2023 · 4 comments
Closed

[FEAT] Add a new experimental API to get a edge/node by name #2453

csouchet opened this issue Jan 16, 2023 · 4 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@csouchet
Copy link
Member

csouchet commented Jan 16, 2023

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

We 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.

@tbouffard
Copy link
Member

tbouffard commented Mar 14, 2023

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.
Automatic tests will be implemented at that time.

@csouchet
Copy link
Member Author

csouchet commented Jul 6, 2023

Duplicated with #14 ?

@tbouffard
Copy link
Member

tbouffard commented Jul 6, 2023

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"
Did you mean process-analytics/bpmn-visualization-pm4py#14?

@tbouffard
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

2 participants