Project

General

Profile

Operations Portal – Notepad

1 General description

Notepad tool allows any valid user to send messages to any site in his scope. For that the user should choose the Notepad tool of the site he would contact.
A message consists of two elements:
  • a subject, and
  • a message body text.
There are two different possibilities to use the Notepad tool. By choosing the type, you can send
  1. a Note (default), or
  2. an Email + Note.

In both cases, the messages are displayed in the Notepad box of the site in question, and could be consulted directly. Once a message is sent, it could not be modified any more.

In the second case, the user can as well simultaneously send the same message by email to the Site Administrators and/or to the ROC administrators that the site belongs to. If the ROC is not defined, the message will be sent to the ROD administrators. In the C-COD view, the messages can be sent to the Site, ROC and/or to the C-COD administrators.

2 Technical description

There is one Symfony action to fill out and to submit a Notepad message. This action also manage the form display and its submission (database writing and email sending):

# trunk/apps/frontend/modules/dashboard/actions/actions.class.php
executeNotepad

To retrieve site's Notepad messages use the function in the site class:

getLastNotepadEntries($nbentries = NULL)

The parameter nbentries [= number of the last notepad to retrieve, actually 5 or all (NULL = all)]
returns an array of Notepad Table Records.

3 Dependencies – Workflow

Form Classes: notepad
Table: COD_NOTEPAD