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

Mark some processes as non-executable in process model settings #742

Closed
harmeet-status opened this issue Nov 23, 2023 · 21 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@harmeet-status
Copy link
Collaborator

harmeet-status commented Nov 23, 2023

Some processes are not meant to be executed, they may be just quick idea dump or some type of brainstorming exercise. We should allow processes to be marked as non-executable in the process model settings.

This would also mean that the start button disappears from these process models and they do no show up in the Start new section either. Also add some indication that it has been disabled by unchecking the flag.


When making a call activity, check to see if we are calling a non-executable process, fail that call.

@harmeet-status harmeet-status converted this from a draft issue Nov 23, 2023
@harmeet-status harmeet-status added the enhancement New feature or request label Nov 23, 2023
@harmeet-status harmeet-status added this to the Status Sprint Tickets milestone Nov 23, 2023
@burnettk
Copy link
Contributor

we discussed that there is an executable flag on each bpmn file. elizabeth suggested that perhaps this flag might not be the right way to implement this, however. if we implemented this, it might be nice to bury the configuration in some way so it isn't an extra point of confusion when you are creating process models, etc.

@calexh-sar calexh-sar moved this from New Issue to Backlog in SpiffWorkflow Jan 8, 2024
@burnettk
Copy link
Contributor

elizabeth clarified that she wouldn't want us to use that property for a non-BPMN purpose, which makes sense. it does sound like the thrust behind the ticket is well aligned with the purpose of the property as described in the BPMN spec, however. so if the property is true, the process is not just documentation, and it is meant to be executed. this means we should have a start button, and the process should be allowed to be started like that or to be started by another process (used as a "called activity").

we may want to follow on with this change with other changes, including the ability to restrict certain processes to ONLY be started as a "called activity" or only to be started via messages (#921, etc), but it seems like making the executable property function as described in the BPMN spec is separable from these concerns.

@harmeet-status
Copy link
Collaborator Author

I'm happy for you guys to suggest the best way to make this work.

@burnettk
Copy link
Contributor

I think we have a handle on this one, yeah. We’ll start with making the executable flag operate per spec.

@burnettk burnettk self-assigned this Jan 31, 2024
@burnettk burnettk moved this from Backlog to In Progress in SpiffWorkflow Jan 31, 2024
@essweine
Copy link
Collaborator

essweine commented Feb 1, 2024

This PR makes the library completely compliant with the spec: sartography/SpiffWorkflow#382

@harmeet-status
Copy link
Collaborator Author

How will you make sure that there is also some type of visual aid, looking at a process model page clearly tells you this one is non-executable?

@burnettk
Copy link
Contributor

burnettk commented Feb 1, 2024

That the start button was taken away was my first thought, but open to ideas. I guess we could instead disable the button and tell you why it is disabled if you mouse over it.

@burnettk
Copy link
Contributor

burnettk commented Feb 1, 2024

filed a follow-on issue, #938, to consider UX improvements related to communicating to the user why the process model is not startable.

@burnettk burnettk moved this from In Progress to Ready for QA in SpiffWorkflow Feb 1, 2024
@madhurrya
Copy link
Contributor

madhurrya commented Feb 12, 2024

Feature works as explained above (https://dev.app.spiff.status.im/process-models/misc:qa:non-executable-model)

  1. The 'Start' button is hidden when 'Executable' property is not selected.
    image
    image
    image

  2. When the 'Executable' property is not selected, that model doesn't show up in the 'Start new' section

  3. The Start button is hidden when listed in the Process list
    image

@madhurrya madhurrya moved this from Ready for QA to Documentation in SpiffWorkflow Feb 12, 2024
@madhurrya
Copy link
Contributor

@burnettk What is the PR related to this ticket? Is it already in test.app or just in dev.app?

@burnettk
Copy link
Contributor

the PR is #934. it is only in dev.app.

@madhurrya
Copy link
Contributor

Tested on test.app also and work as expected.

@burnettk
Copy link
Contributor

let's ensure that when process A calls process B via a call activity, and when process B is marked non-executable, that it fails. i believe elizabeth has indicated that it should error, but i think i've seen otherwise.

@madhurrya
Copy link
Contributor

@burnettk If I call it from a Call activity it get executed.
https://dev.app.spiff.status.im/process-models/misc:qa:call-activity-with-non-executable-model
Do I need to create a new ticket for that?

May be better to not show Non executable models in the call activity search as well.

@burnettk
Copy link
Contributor

Thank you. I like both of those ideas, new ticket and restrict list of called activities available.

@madhurrya
Copy link
Contributor

Created a new ticket for the above. #1086

@madhurrya
Copy link
Contributor

Released to Prod on 2024 February 20th

@danfunk danfunk removed this from the Status Sprint Issues milestone Mar 12, 2024
@madhurrya
Copy link
Contributor

@usama9500 @calexh-sar is this feature already documented? Can I close this?

@calexh-sar calexh-sar added the documentation Improvements or additions to documentation label Aug 22, 2024
@calexh-sar
Copy link
Contributor

Deferring to @usama9500 on documentation status.

@usama9500 usama9500 self-assigned this Aug 23, 2024
@usama9500
Copy link
Collaborator

I’ll leave this open since it’s not documented. I haven’t seen this issue before, so I’ve self-assigned it and added it to the documentation queue.

@usama9500
Copy link
Collaborator

@github-project-automation github-project-automation bot moved this from Documentation to Resolved in SpiffWorkflow Jan 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Resolved
Development

No branches or pull requests

7 participants