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

Redundant description field in ProcessInstance #2510

miguelruizdev opened this Issue Feb 14, 2019 · 1 comment


None yet
2 participants
Copy link

miguelruizdev commented Feb 14, 2019

The description of a process instance comes from the process definition it's based on.

The engine does not support the fact of passing any specific value to it at process creation. Neither it does when updating the process instance.

This fact makes the Description field in a process instance redundant, since it never gets populated.

As this question raised in Activiti forums shows, the fact that the API offers the possibility to populate it in the same fashion as the name is rather misleading.

Since extracting the value of description from the process definition and set it in each instance does not enrich the instance itself (as it occurs with processDefinitionId), there's no reason why description should exist as a field in our Process Instance Model.

@miguelruizdev miguelruizdev changed the title Extra description field in UpdateProcessPayload Redundant description field in ProcessInstance Feb 14, 2019

@miguelruizdev miguelruizdev self-assigned this Feb 14, 2019

@miguelruizdev miguelruizdev added this to the 1.1 milestone Feb 14, 2019


This comment has been minimized.

Copy link
Contributor Author

miguelruizdev commented Feb 14, 2019

@erdemedeiros just copying you here for you to be aware of this change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.