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 |
|
Knowledge documents
In the Knowledge Management (KM) system, a knowledge document typically consists of information about a particular topic. The amount of detail and length depends on the complexity of the topic and the audience for the document. Knowledge documents can include attachments that can be images, text files, PDF files, or Word files for example. In the out-of-box system, the types of knowledge documents are error messages, external documents, question/answer documents, problem/solution documents, and reference documents. All knowledge documents are assigned to at least one document category and may be placed in multiple categories. A typical document category might be technical documents or HR procedures.
- Draft documents - These are documents that are being created, but have not yet been submitted to be published..
- Published documents - These are documents that are available for searching and viewing. Some documents may only be viewed by internal users, while others can be viewed by internal and external users. Published documents can be edited by users with the Edit in place a published document option selected for their KM security profile. Users can add feedback to published documents. Users with appropriate privileges can create a working copy of the document and then make revisions.
- Working copy - A document becomes a working copy when a published document goes into the workflow to be updated. When the working copy of the document is published, it replaces the original document. A working copy of a published document has an "R" appended to the document ID. A new document submitted to be published is also considered a working copy while it is in the workflow waiting to be published, but there is no "R" appended to the document ID.
- Retired documents - These are documents that become out-of-date and have been archived for some reasons. Retired documents are not searched when users perform a knowledgebase search. KM ADMIN users can delete retired documents.
Knowledge documents typically have a life cycle that includes draft, triage, pending documents in the approval workflow, published, and retired.
Related topics
Create a working copy of a knowledge document
Retire a knowledge document
