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 |
|
Documentation tasks
The following table lists maintenance tasks that the System Administrator needs to perform in the Documentation area. For information about other areas, see Areas of maintenance tasks.
Event or frequency |
Task |
Automatable |
---|---|---|
Before going to production |
No |
|
On demand |
Document the application of patches, hotfixes, and custom tailoring |
No |
On demand |
No |
|
After modifying credentials | Document credentials in a safe place | No |
Document fallback procedures
All fallback strategies must be documented to cover their applicable scenarios, precautions to be taken, and restoration procedures, so that they are available when needed.
Document the application of patches, hotfixes, and custom tailoring
The administrator is responsible for documenting all changes applied to the system, such as the application of patches and hotfixes, or custom tailoring releases. This includes the following information:
- Date and time of the application
- Information about the change
- Status after the application (error or warning messages, and results of initial functionality tests)
This document is required for analysis if an issue is observed.
Note The standard question from Software Support engineers about the last change before first observation is directly referring to this document.
Document all automated administrative tasks
Diligence in implementation, documentation, and maintenance of these automated tasks is important because changes of the system configuration, or tailoring may directly result in a requirement to modify automated maintenance tasks as well.
Document credentials in a safe place
Service Manager automatically encrypts credentials in configuration files and in the Service Manager Integration Suite (SMIS) configuration. Therefore, credentials can no more be looked up from these files or SMIS.
These credentials include credentials for the relational database, LDAP server, SSL keystore files, or external applications that Service Manager integrates with.
To address the risk of not being able to access required resources because of failure, document all credentials in a secure place.
Related topics