Overview

Case Notes are used to add comments and observations about cases, which can be read by anyone who has rights to open the case. Case Notes are a new feature available in version 2.0.31 and later.

From version 2.5, by default any user won't be able to add case notes unless a process permission will be configured.

Note: Until version 2.0.42 it is possible to add no more than 150 characters:

From version 2.0.43 it is possible to add no more than 500 characters:

Note: At this time, it is currently not possible to customize the appearance of the case notes pop up screen, it means no modifications on the color of the case notes, selecting specific users to send the case notes, or the number of characters predefined can be done.

Adding Case Notes

Before adding a case notes make sure the permissions are correctly set.

To add a note to a case, go to the HOME menu and open a list of cases.

To add a note to a particular case, click on its icon.

Click on its icon. It will display a new window in which the Note has to be added. Case notes allows up to 150 characters

  • By clicking on the Post button the case note will be added and also an email notification will be sent to all users which participate in the current case, this means that the user assigned to the taks must execute it at least one time to consider him/her as a participant of the case.
  • By clicking on the icon the case note window will be closed, cancelling all the information that might be added.

The added note will be as follows:

Next to Case Notes will appear the number, in parenthesis, of the case notes added for a particular case.

Note: Case Notes can't be deleted.

Viewing Existing Case Notes

  • Right click on the icon of the list cases and a submenu will appear as follows:

  • Click the case to select the information of the case note that need to be displayed, then click on Actions on the above menu and select the option Case Notes.

Sending Email notifications to all Case Participants

Emailing Case Notes

Form version 2.0.44 the possibility to decide if sending email notifications to all users who participate in the case was included, so when a case is running and a case note is created user can decide if the email will be sent or not. Below the content of the case notes a checkbox was added to check it if the email will be sent, on the contrary if it's checked, notifications won't be sent.

If the mouse cursor is over the checkbox a help message will display indicating that the copy will be sent to all participants:

Manipulating Case Notes in PHP

Case notes can be created, updated and deleted using ProcessMaker's AppNotes class (and its parent class BaseAppNotes) which is defined in the file workflow/engine/classes/model/AppNotes.php and needs to be imported with require_once() before using the class.

Creating a Case Note

To create a case note, instantiate an AppNotes object and then call its postNewNote() method in a Trigger. Remember to first pass the content of the case note through PHP's addslashes() function, so that it can be inserted in the database without problems.

For example, the following trigger code posts a note in the current case by the the currently logged-in user to say "This case must be completed by YYYY-MM-DD.", where YYYY-MM-DD is ten days in the future:

$dueDate = date('Y-m-d', strtotime("+10 days")); //ten days from present
$content = "This case <b>must</b> be completed by <font color=red>$dueDate</font>.";
$content = addslashes($content);
require_once("classes/model/AppNotes.php");
$oCaseNotes = new AppNotes();
$oCaseNotes->postNewNote(@@APPLICATION, @@USER_LOGGED, $content);