Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Words and Phrases
| Search for | Example | Results |
|---|---|---|
| A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
|
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Using Boolean Operators
| Search for | Operator | Example |
|---|---|---|
|
Two or more words in the same topic |
|
|
| Either word in a topic |
|
|
| Topics that do not contain a specific word or phrase |
|
|
| Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
| A combination of search types | ( ) parentheses |
|
Detailed return codes from Document Engine
The System Administrator can manipulate the detailed return code by setting the value of $L.exit in the Document Engine process’s final expressions to one of the following:
| Action or Error Situation | $L.exit value |
|---|---|
| record has changed since it was selected | changed |
| cancel processing the record | cancel |
| record is locked | locked |
| Request failed validation | bad.val |
| record was deleted since it was selected | deleted |
| exit processing | exit |
| normal exit | normal |
| Record should get unlocked | unlock |
| Sets exit value to menu to return to the menu | menu |
| Record was added, screen will be refreshed | added |
| Processing will restart – starting with init of file variable | restart |
| Processing will proceed with a new state record | newstate |
| Displayed records will be refreshed | refresh |
| Displayed joinfile records will be refreshed | refreshjoinfile |
| Category changes | newcat |
| Position in record list will be changed | reposition |
| Record will be reset to original values | resetrec |
| Mode will be set to close and close processing will start | closestate |
| Restart processing starting with init of file variable | restart |
| Mode will be set to add, which goes into the open state | openstate |
| Initializing values to add record | setupadd |
| An undefined action was passed to the document engine | invalid.action |
| User is not authorized for this action | no auth |
