Differences

This shows you the differences between two versions of the page.

--- code:commercial:hse-error-code-helper:overview [2023/05/10 07:32] – alexander.elbert
+++ code:commercial:hse-error-code-helper:overview [2026/07/27 11:46] (current) – [Error XML Files] alexander.elbert
@@ Line 5: / Line 5: @@
 ===== How it works =====
-The plugin will bring up a dialogue window with a search field and a list of pre-defined error codes. Codes are separated into several sections. The first section called "Library Errors" contains errors specific to the code module from which the tool was invoked. All following sections contain generic error definitions.
+The plugin will bring up a dialogue window with a search field and a list of pre-defined error codes (see [[#error_code_definitions|below]]). Codes are separated into several sections. The first section called "Library Errors" contains errors specific to the code module from which the tool was invoked. All following sections contain generic error definitions.
 {{:code:commercial:hse-error-code-helper:ech-dialog.png?500|}}
 The user can search for errors by typing in numbers (error codes) or keywords (error descriptions). Pressing enter (or double-clicking an entry) will finish the selection process and close the dialogue.
+----
 ===== What it does =====
@@ Line 36: / Line 38: @@
 If the user does not select a code but types in a new code (integer) into the search field, the tool will create a new error constant VI and place it into the lvlib/lvclass containing the VI from which the QD was invoked.
-It will open an additional window and query the user for the error source string and if the newly created constant VI should have a string input for additional information. Eventually, it will place the new VI on the cursor to drop.
+To add a new code open the QD plugin and press enter, without a code. This will open an additional window and query the user for the error source string and if the newly created constant VI should have a string input for additional information. Eventually, it will place the new VI on the cursor to drop.
+{{:code:commercial:hse-error-code-helper:ech-new.png?direct&600|}}
 ----
@@ Line 54: / Line 58: @@
 ==== Error XML Files ====
-Generic error code definitions are stored in NI's error XML format and installed into the ''<LabVIEW>\project\errors'' directory. The plugin will parse all XML files named ''HSE*-errors.txt'' and show contents in alphabetical order.
+Generic error code definitions are stored in NI's error XML format and installed into the ''<LabVIEW>/project/errors'' directory. The plugin will parse all XML files named ''*-errors.txt'' and show contents in alphabetical order.
-[[https://www.ni.com/docs/de-DE/bundle/labview/page/lvhowto/dist_error_code_files.html|How to distribute via installer.]]
-<WRAP left round info 100%>
-**HSE Error Code Definitions.vip:** \\
-At HSE, we maintain our generic errors in a separate repository and we distribute those error definitions via a VI package (.vip). \\
-The error XML files are named ''HSE 1xx SomeCategory--errors.txt'', with ''xx'' being a 2-digit number. This allows a dedicated order for different categories of generic errors. Customers can add more files named ''HSE 0xx …'' or ''HSE 2xx …'' etc. When updating the HSE Generic Error Definitions, VIPM will remove all ''HSE 1xx'' files before installing the new set of files.
+<WRAP>At HSE, we maintain our own set of [[code:hse-labs:hse-error-code-definitions|Error Code Definitions]].
 </WRAP>
-{{:code:commercial:hse-error-code-helper:ech-folderlocation.png?600|}}
-You can use the built-in editor via //Tools -> Advanced -> Edit Error Codes...//:
-{{:code:commercial:hse-error-code-helper:ech-ecdeditor.png?600|}}