Document status tracking

thenon · November 22, 2014, 11:36pm

When looking at a document, I want to view the changes in the document status - i.e. changed from status a to b, at time c, by user d.

Is there anything like that already?

Or more generically, an audit table that records the changes to any property?

Many thanks.

rmehta · November 24, 2014, 5:27am

There is no audit table, but the Submit action is not added to Comments.

thenon · November 24, 2014, 10:18pm

So to do this, I think I would create an app that uses a server side hook, to register an “on save” hook for ALL doc types, and when that fires, create a new instance of a DocType “AuditRecord”, with appropriate columns (entity doctype, entity id, user, time, new value).

a) Does that sounds correct, and doable, within the framework?
b) Specifically, is the hook for ALL doc type changes possible?

If so, I will be happy to contribute it back.

Thanks.

rmehta · November 25, 2014, 4:44am

I thint the best place to add this is in Comments. Comment already had a “type” property and we already log events like attachment added, removed, assigned, etc.

What we can do is:

In DocType, add a property Track Changes

If that is set, always add a comment on insert and every update (also save a diff of the properties changed).

This is how comments are added on submit

github.com

frappe/frappe/blob/develop/frappe/model/document.py#L446


      
          				df.options, {"parent": self.name, "parenttype": self.doctype, "parentfield": fieldname}
          			)
          
          
	def get_doc_before_save(self) -> "Document":
          		return getattr(self, "_doc_before_save", None)
          
          
	def has_value_changed(self, fieldname):
          		"""Returns true if value is changed before and after saving"""
          		previous = self.get_doc_before_save()
          		return previous.get(fieldname) != self.get(fieldname) if previous else True
          
          
	def set_new_name(self, force=False, set_name=None, set_child_names=True):
          		"""Calls `frappe.naming.set_new_name` for parent and child docs."""
          
          
		if self.flags.name_set and not force:
          			return
          
          
		# If autoname has set as Prompt (name)
          		if self.get("__newname"):
          			self.name = validate_name(self.doctype, self.get("__newname"))
          			self.flags.name_set = True

You can just modify this method and add a condition to check “track_changes” and then add comment also for “Save”

If you push your code, will be happy to guide you!

mayur_hotmail · November 25, 2014, 3:29pm

This will be a very useful functionality to have. We have been waiting for this for a while. Look forward to this being developed.

Kind regards,
MP

morrismwaura · September 7, 2015, 8:45am

Has there been any updates on this? Has anyone implemented this successfully, I’ll be happy to get any pointers. I have also raised a similar issue at Status of Audit Trail or How to Implement

Regards,
Morris

umair · September 7, 2015, 1:01pm

Morris,

There has been upgrade on this front in ERPNext V5. In the Comments section, actions like Save, Submit, Cancel, attachments are updated.

strixaluco · January 10, 2017, 3:02am

The feature is implemented in Frappe 7.3