Comments
Comments can be stored against any process instance, work item or case object. You can use these comments to create a custom audit trail, for example.
Adding Comments
The AuditService contains the following operations to add comments to an entity:
- addCaseComment - Adds a comment to a case.
- addProcessInstanceComment - Adds a comment to a process instance.
- addWorkItemComment - Adds a comment to a work item.
The request must identify the case, process instance, or work item against which to store the comment, the comment to be stored, and any options for the comment.
The response from the add operations is an audit ID for the comment. You can use this ID to identify the parent comment, which allows you to create a hierarchical view of comments for a BPM process instance, work item or case.
Retrieving Comments
There are a number of ways to retrieve comments that have been stored against an entity.
- Use the AuditService operations available to generate an audit trail (which includes the comments) for an entity:
- Use the AuditService operations available to retrieve comments from an entity:
- Use the available Event Collector functions that return comments stored against a process instance, work item, or case. For information about these functions, see Functions for Comments.
Copyright © Cloud Software Group, Inc. All rights reserved.