System Tables: Comments and FileNotes 

The Orixa framework includes 2 framework tables, "Comments" and "FileNotes" which can be linked to any BusinessObject.
Simply tick the "LinkToComments" and "LinkToFilesNotes" tick-boxes in the BusinessObjects EditForm to switch on these features. Then when the Edit Form for the selected BusinessObject is opened these new features will be added to the toolbar.

Once added, any user can add Comments and FileNotes records which are linked to the selected data-record. This can be useful to allow staff to manage change and updates to data.

 

NOTE Comments and FileNotes are shown visually in standard data-edit form windows like all other Orixa BusinessObjects. The "base" data-tables have a fairly simple structure, including standard Orixa formatted entries in the framework tables. A Developer can extend these tables as much as they like, adding extra columns and features.

For general user-guide information review this link Comments and FileNotes Edit Forms

Adding Comments and FileNotes in an Edit Form

Comments and FileNotes from an Edit Form  

To activate this feature: tick "LinkToComments" and / or "LinkToFileNotes" for the chosen BusinessObject

Then, whenever a record is viewed, the Edit Form will show options to add "New Comments" and "New FileNotes." These records can contain user-data and are associated with the selected BusinessObject record via that record's TableName and ID.

The "Comments" and "FileNotes" Framework-tables are similar in structure (their structures are shown below) but "FileNotes" include a link to an on-disk file such as document or spreadsheet.

The "Comments" Framework-table is intended to hold information, updates, and notes.

The "FileNotes" Framework-table allows specific files to be semi-permanently linked to a particular record. For example a PDF showing a microbial test could be linked to a product-purchase record, or a document showing work done could be linked to a work-items record.

Adding Comments and FileNotes from an Edit Form  

From the "New Comment" action, an Edit Window to add and edit a comment will open. The user can add a Name / Title and Memo.

The Comments framework-table includes a "Status" field so that Comments can be grouped. For example a Comment's status might be set to "Urgent" if review is required.

As with other Orixa framework-tables, the Author, DateCreated and DateEdited are stored. 

Comments also include a "Complete" tickbox, which can be used to track whether work described in a comment has been acted on, for example by a manager viewing and checking a Comment.

How you choose to use Comments in your App is up to you. Once activated any BusinessObject record can be linked to as many or as few Comments and FileNotes records as required.

Viewing Comments and FileNotes from an Edit Form  

  1. BusinessObjects linked to Comments and / or FileNotes will also be given a "View ..." button. 
  2. When clicked this will create a window showing all linked Comments and / or FileNotes. Users can click to view these records and click to directly open any linked file.

 

Comments View in Diary  

If it is useful, Comments can be added to the system Diary, so that users can track the addition of Comments over time using the Diary interface.

To enable this, add a "DiaryScript" to the Comments BusinessObject record.

  1. Comments added to the list of "What To Show" in the diary.
  2. Comments entries will be added to the diary, added according to the date the comment was created.

Linked Comments, FileNotes and Images on the "LinksList" Toolbar  

Once users have created Comments, FileNotes and other "child table" records linked to a BusinessObject, their prescence is automatically shown in a special Shortcut Links toolbar at the bottom of the Edit Form.

  1. Shortcut Links are shown along the botton of the screen for each Edit Form.

    Click on each Icon to open the linked record or see the linked Image.

Links Visible in a Worksurface  

Once Images, Comments and FileNotes have been linked to a record they will automatically display as "+" signs on the side of items within Worksurfaces.

  1. Worksurface showing details of a staff members work.
  2. One item has 2 comments linked to it, shown by separate "+" signs.
  3. Click on the "+" and the text of the comment is displayed. If you double click on this text a window opens allowing you to update and edit the text.

The data-structure of the Comments Framework-table

CREATE TABLE "Comments"
( "ID" INTEGER DEFAULT UID() NOT NULL,
  "LinkTable" VARCHAR(40) COLLATE "ANSI",
  "LinkID" INTEGER,
  "Name" VARCHAR(40) COLLATE "ANSI",
  "Memo" CLOB COLLATE "ANSI",
  "StatusID" INTEGER DEFAULT StatusID('General'),
  "AuthorID" INTEGER,
  "DateCreated" TIMESTAMP DEFAULT Current_Timestamp,
  "DateEdited" TIMESTAMP DEFAULT Current_Timestamp,
  "Complete" BOOLEAN DEFAULT false,
CONSTRAINT "PK_Comments" PRIMARY KEY ("ID"),
CONSTRAINT "StatusID" FOREIGN KEY ("StatusID") REFERENCES "Status" ("ID")   ON UPDATE NO ACTION ON DELETE NO ACTION
)

Note that in-use the Orixa Framework collates the "LinkTable" and "LinkField" columns and uses them to create the "LinkRecord" entry that allows the user to link between the Comments / FileNotes record and the original record.

The data-structure of the FileNotes Framework-table

CREATE TABLE "FileNotes"
( "ID" INTEGER DEFAULT UID() NOT NULL,
  "LinkTable" VARCHAR(40) COLLATE "ANSI",
  "LinkID" INTEGER,
  "DateDone" DATE DEFAULT Current_Date,
  "FileName" VARCHAR(250) COLLATE "ANSI",
  "Memo" CLOB COLLATE "ANSI",
  "StatusID" INTEGER DEFAULT StatusID('General'),
  "FileNotesTypeID" INTEGER,
  "AuthorID" INTEGER,
  "DateCreated" TIMESTAMP DEFAULT Current_Timestamp,
  "Complete" BOOLEAN DEFAULT FALSE,
CONSTRAINT "PK_FileNotes" PRIMARY KEY ("ID"),
CONSTRAINT "StatusID" FOREIGN KEY ("StatusID") REFERENCES "Status" ("ID"),
CONSTRAINT "FileNotesTypeID" FOREIGN KEY ("FileNotesTypeID") REFERENCES "Types" ("ID")
)