This page is being moved to the alfresco documentation

What are Folder and Document Notes?

Folder Notes

Folder notes are notes attached to a folder. The default note type is hpi_note. An hpi_note has the following attributes:

• note_detail: abbreviated note_content <= 3000 characters
• note_type: a classification given to each note, such as "Authority", "Corrspondance, "Procedural", etc. pulled from form support in a note_type picklist
• note_attachment: if the note was created from Document Notes, note_attachment is the objectId of the parent document. Otherwise, it is undefined

These notes are stored in a hidden folder inside the parent container called .folder-notes (originally called .hpi-info).

Document Notes

Notes can also be attached to individual documents with the Document Notes action. All document notes are stored in the .folder-notes folder of the parent folder of the document.

Configuration

To configure Folder Notes, navigate to the admin panel > Stage Config > Folder Actions, and find the Folder Notes action in the list of available actions. This action can be configured as either a Modal action or a Right-Side action.

To configure Document Notes, navigate to the admin panel > Stage Config > DocViewer, and find the Document Notes action in the list of available actions.

Notes on some of the available configurations are below.

Form to Display

This is the form that will display to the user when editing or adding a note. It's recommended to have a 'createHPINote' form configured that you can use throughout the application (it's not trac-dependent). The object type on the form should be HPI Note. Typically, we configure the following properties on the form:

• Note Type (optional) - sometimes configured as a picklist
• note_content (required) - usually a hidden textarea
• note_detail (required) - usually a hidden textarea

Note Object Type

The default note object type is "hpi_note". To configure otherwise, replace this value with the appropriate object type.

Note Relationship (required)

Update the Note Relationship option to indicate if you are on Documentum or Alfresco as follows:

Documentum: hpi_folder_note (dctm)

Alfresco: hpi:folder_note (alfresco)