Notes

<< Click to Display Table of Contents >>

Navigation:  Professional > Tables & Views >

Notes

Overview

Displaying Notes

Notes Fields

 

Overview

 

Within the DT_NOTE table, EQuIS can store notes for a data record. Administrators can access the DT_NOTE table from Open > Data Tables. This page describes the structure and behavior of EQuIS notes. For information on adding or editing notes, see the Notes Form page.

 

Other than reference table RT_NOTE_TYPE, DT_NOTE has no relationships with other tables. Instead, the table stores the EQuIS Unique Identifier (EUID) of the parent record in the DB_RECORD_ID field. If the EUID field for the parent record is blank, clicking the Notes PRO_Notes-Toggle-16 cell for that row will populate it. For the few system tables without EUID columns, the following message will appear when attempting to add a note within the table:

Key not found: 'euid'

 

The Notes feature involves several components:

The Notes column within a table

Within that column, the Notes field for each record

The Notes Form to add or edit notes

 

Notes options include the following:

Add or edit notes.

Attach files to a note.

Set due dates.

Add notes onto other notes, creating a hierarchy.

 

EQuIS saves event parameters from the Data Quality Module (DQM) in the DT_NOTE table. There are multiple notes for each event, as each specification (such as a check) has an individual note. The parent record for these notes is the DQM Exceptions Report by EDD user report saved for the event in the ST_USER_REPORT table.

 

 

Displaying Notes

 

The Notes column contains fields with the Notes PRO_Notes-Toggle-16 icon. Although the Notes column appears in the Grid View, it is not a column in EQuIS data tables, nor do Notes fields affect the data in a displayed table. The Notes display is just a user interface to interact with the DT_NOTE table records associated with that table.

 

If there are no notes in the database (i.e., DT_NOTE is empty), the Notes column is automatically hidden. Show or hide the Notes column in one of two ways:

1.Click the Notes button on the grid toolbar, or

2.Toggle the Key = Notes entry at the top of the list within the Column Chooser.

 

PRO_Notes-Toggle-Example

 

A record with at least one note has a brighter Notes icon, outlined in green and yellow; otherwise, the icon is greyed out.

 

Within Views, the Notes button is disabled; turning on Notes via the Column Chooser within a view will display notes associated with the EUID listed for that view. Consequently, EarthSoft does not recommend editing notes from within a view.

 

 

Notes Fields

 

Fields for notes consist of the following (all stored in the DT_NOTE table):

NOTE_ID – The ID of the note, equal to its EUID value. If an attachment file is associated with a note, DT_FILE.OBJECT_EUID is populated with the NOTE_ID.

PARENT_NOTE_ID – The NOTE_ID/EUID of the parent record, which users can set to an existing NOTE_ID in the DT_NOTE table.

DB_RECORD_ID – The EUID of the parent record NOTE_TITLE: the note title. DQM events use the note title “DQM Event”.

NOTE_TEXT – The note text. DQM events populate this field with the event name.

NOTE_TYPE – The note type, with available options coming from the RT_NOTE_TYPE table.

NOTE_CATEGORY_1 to _3 – Freeform fields to store note categories. A DQM Event note populates these fields with the following event summary details, respectively.

Check Name

Type of Sample or Result Reviewed

Method Used to Find Associated Results

CREATED_DATE, DUE_DATE, STARTED_DATE, COMPLETED_DATE – Date fields for the note.

RECURRENCE

CONTACT_1 to _3 – People or companies associated with the note. These fields are freeform, but contacts do not have to be in the DT_PERSON or RT_COMPANY table.

CUSTOM_FIELD_1 to _5 – Custom fields for any desired data. DQM Events populate CUSTOM_FIELD_1 and _2 with check information.

EBATCH – The Electronic Data Deliverable (EDD) batch for any notes uploaded via EDD (e.g., via the Geotechnical_v2 format).

EUID – The EQuIS Unique Identifier for the note, which also determines the NOTE_ID.

VALUE_1 to _5 – Any desired values. DQM events populate the VALUE_1 through _4 fields with the following values from a check, respectively.

Total Number of Results

Number of Results Review

Number of Exceptions

Number of Results Associated