This command launches the real-time failure note window for the specified template row. It uses the color, message and sound that you specify, and it uses the DE_OPT 6 setting for forcing the user to choose a corrective action.
Syntax
RT_NOTE row_number, data_index, "message", color_ID_number, "sound_file"
The row_number specifies the template row for which you are displaying the real-time failure note window. For the current row, use a row_number of 0.
To display the message in one of the Data point alert notes boxes, set the data_index to the number of the data point where you want the message to appear (e.g., to display the message in the box for data point 2 in the subgroup, use a data_index of 2). To display the message in the Subgroup alert notes box, set the data_index to any number that is less than 1 or greater than the subgroup size used on the specified row_number.
The "message" is the text you want to display in the Data point alert notes or Subgroup alert notes box that is specified by the data_index parameter.
The color_ID_number parameter determines the color of the note window. To specify the color, set this parameter to the desired color ID number. To use the default color for the note window (e.g., when clicking the Notes button or executing the DE_NOTE command), set this parameter to the number -1. This parameter will override the de_showcolors= setting in Cms.ini.
If you specify a path and file name of a "sound_file", GainSeeker will play this sound when this command launches the note window. To avoid playing a sound file, set this parameter to an empty string ("").
Return value
This command does not return a value.
Notes
This command ignores the current configuration setting for automatically storing, editing or displaying real-time failure notes.
Unlike the real-time failure notes that are automatically generated by GainSeeker, this command cannot flag the data record with the Special designation of "FN" (failure note) or make it appear on the failure monitor or a real-time failure dashboard.
If you change a data value after the RT_NOTE command has been executed but before the subgroup is saved, then the Data point alert notes for the corrected data value and the Subgroup alert notes will be cleared so that they no longer reflect the real-time check or any operator entry. (The Operator notes will not be changed even if data values are corrected.)
If the text you specified for the "message" parameter already exists in the Data point alert notes or Subgroup alert notes box that is specified by the data_index parameter, this command will not append the message to the same note box a second time.
This command should be executed before the current data subgroup is saved.
GainSeeker converts three backslashes ( \\\ ) to two ( \\ ) for literal (UNC) filename parameters (for example: \\\hsdc01xz\data\xfer\mtc.wav). If you were to instead use two backslashes as in this example, \\hsdc01xz\data\xfer\mtc.wav , it results in a filename of \hsdc01xz\data\xfer\mtc.wav , which is invalid as a UNC. This is because the double backslash is considered an escape sequence, and the system auto-converts it to a single backslash.
However, if the filename parameter is a variable (for example: MySvar "Path"), you should only use two backslashes. Using three slashes in this event causes an error.
If you are upgrading from GainSeeker version 8.0 or earlier and using UNC paths, you must update your templates to reflect this.
Examples
RT_NOTE 0, 0, "Failed MAV check", 39423, ""
This formula launches the real-time failure note window for the current template row. In the Subgroup alert notes box, it displays the message "Failed MAV check". The color of the window is orange, and no sound is played when this note window is launched.