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.
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. |
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 |
|
Managing document categories
All knowledge documents in the knowledgebase are assigned to a document category. Categories for knowledge documents are ordered into hierarchies. The document categories order documents into top-level categories and subcategories. Each subcategory has a parent category that is the category immediately above it in the ordered list of categories. A top-level category is also a parent category of the subcategory immediately below it in the ordered list of categories.
The following is an example of category and subcategory hierarchy:
Animal > Dog > Retriever or Category > subcategory > subcategory
- Animal is the top-level category for Dog and Retriever.
- Animal has no top-level category or parent category.
- Dog is the parent category for Retriever.
For a top-level category, the level in the hierarchy is always zero (0).
A category and subcategory has associated with it a set of permissions. These permissions specify the profiles and knowledge groups that have access to the category or subcategory. When a profile and knowledge group is given access to a category or subcategory that profile and knowledge group also has access to all of the subcategories below that point in the hierarchy.
If there are any published documents assigned to the category, they cannot be deleted. You cannot delete a document category before deleting a category. Assign any of the published documents to another document category. You can delete a document category if there are only retired documents assigned to the category. If you decide to unretire those documents, a KM Admin will provide a new document category for the document as part of the unretire process.
Deleting document categories
You can delete a document category, but you should verify first that there are no documents in the category or in the subcategories under the category. When you delete a category, the system will not allow you to delete the category if there are documents in the category or one of its subcategories. However, if the documents are retired, the system will warn you that there are documents present in the category or its subcategories, but it will still allow you to delete the category. The category being deleted is removed from the retired documents record so that the document is no longer associated with the deleted category.
Documents cannot be managed in the knowledge management system without an assigned category because the Knowledge Management uses document categories to control access to the knowledge documents. All published documents and pending documents must have a category associated with them. Draft and retired documents do not require an assigned category.
A user with a KM ADMIN profile can view and unretire a document that does not have a category associated with it. If the KM ADMIN unretires a retired document without a category, the document is put in the workflow as a draft document.
When you unretire a document that has at least one category associated with it, the system puts the document into the workflow as a pending document.
Add subcategories to a document category
User role: System Administrator, Knowledge Administrator
All documents in the knowledgebase are assigned to a document category. The document categories order documents into top-level categories and subcategories. Each subcategory has a parent category that is the category immediately above it in the ordered list of categories.
To add subcategories to a document category, follow these steps:
- Click Knowledge Management > Configuration > KM Document Categories.
- Select a top-level category.
- On the Subcategories tab, click New.
- Type the name of the new subcategory.
- Click Add.
- You can continue adding subcategories by clicking New Subcategory, or you can begin to specify permissions for the subcategories.
- Click Save to continue saving your changes.
- Click OK.
Add a new top-level document category
User role: System Administrator, Knowledge Administrator
All documents in the knowledgebase are assigned to a document category. Categories for knowledge documents are ordered into hierarchies. The document categories order documents into top-level categories and subcategories. A top-level category is a parent category of the subcategory immediately below it in the ordered list of categories.
To add a new top-level document category, follow these steps:
- Click Knowledge Management > Configuration > KM Document Categories.
- Click New.
- Type the name of the new top-level category.
- Click Add.
- Click Save.
Add permissions for a document category or subcategory
User role: System Administrator, Knowledge Administrator
A Knowledge Management document category or subcategory has associated with it a set of permissions. These permissions specify the profiles and knowledge groups that have access to the category or subcategory.
To add permissions, follow these steps:
- Click Knowledge Management > Configuration > KM Document Categories.
- Double-click a top-level category or search for a subcategory to display the category for which you are adding permissions.
- Click the Permissions tab on the Category Details form.
- Click Add.
- Select a knowledge group from the list, and then double-click the knowledge group you select.
- Select a profile from the list, and then double-click the profile you select.
- Repeat the steps to add additional permissions.
- When you are finished adding permissions, click the Permissions tab to verify your selections.
- Click Save.
- Click OK.
Provide all users access to a document category
Applies to User roles: System Administrator
You can make all externally published documents associated with a single document category (such as Human Resources) to be viewable by all users.
To provide all users access to a document category, follow these steps:
- Click Knowledge Management > Configuration > KM Document Categories.
- Click the Category Search tab.
- Type HR in the Search box.
- Click the Search button.
- Double-click HR.
- Click the Permissions tab.
- Click the Add button.
- Select and then double-click Default Knowledge View Group.
- Select and then double-click the DEFAULT profile. In the out-of-box system, the DEFAULT profile is set to search external access.
- Click the Permissions tab to verify your changes.
- Click Save.
Note If you want all users to be automatically included in the Default Knowledge View Group, be sure to select the Assign the Default Knowledge Group to all operators check box in the Knowledge Management Application Environment form.