This topic describes how to navigate within the IBM® FileNet® P8 help system.
Except in the documentation for Workplace and eForms, which are restricted applications, you can access every topic within the FileNet P8 help system from the table of contents or from links in the beginning help directory pages. When a topic displays, it is also highlighted in the table of contents. Links to PDF files, Javadoc™ API documentation, and documents that are provided via the Web open in a new browser window.
When you open the FileNet P8 help system, it opens to the "By user type" help directory page with a global table of contents located on the left side of the window. However, if you open the FileNet P8 help system from one of the restricted applications (Workplace or eForms), the table of contents contains topics for that application only. Make selections from the table of contents to access the online topics and related documents. Links to PDF documents and to documents that are available via the IBM support page are designated by the suffix "(PDF)" or "(Web)," respectively. To download documentation from the IBM support page, see Accessing FileNet Documentation.
Place the cursor over an item in the table of contents to display a tool tip for that entry. The tool tip indicates if the entry is a topic, an external document, or if it is a container for additional topics. Clicking on a topic entry displays the topic in the topic content area. When you double-click a container entry, it will expand or collapse. You can also click on the plus and minus icons to expand and collapse a branch of the help.
You can access the FileNet P8 help system either by clicking the Help Directory link in the upper-right corner of most help topics, or by starting the help from the documentation server.
NOTE The help directory link is not available from the Workplace or eForms user help.
The FileNet P8 help system has two different beginning help directory pages: "By user type" and "By task", each with a set of links to selected topics. Because the help directory pages contain generally categorized links, they do not contain links to every topic in the documentation.
For example, if you need specific instructions for performing a particular task, click the "By task" tab, which has links to various common tasks. If you need information as an administrator or developer, click the "By user type" tab, which has links grouped according to the type of user who would typically need them.
If you have installed the FileNet P8 help system as a Web site on a Web server that supports Java™ applications, you can use the Search feature to locate information anywhere within the installed help system. You can specify the word or phrase to search for, and you can choose to limit the search to specific areas of the documentation (such as only the Content Engine documentation). Click the Contents link in the banner to return to the table of contents.
Included in the FileNet P8 help system is a glossary of terms. Throughout the help system, you'll see highlighted glossary terms (typically with a dashed underline). Click on a glossary term to display its definition in a new browser window. The window will remain open for reference until you close it.
To look up a word or term, click the Glossary link in the upper-right corner of a help topic and, using the alphabet links provided, navigate to the entry you need.
You can display the help system from within many of the FileNet P8 applications. For example:
TIP Create browser shortcuts (favorites) to the topics you use most often.
The FileNet P8 help system includes some reduced-size images. Click on a reduced image to display it full size.
You can print the contents of a topic using the browser's Print command. Make sure that you click on (or otherwise set the focus to) the frame you want to print before you click Print. When printing a topic that has a large illustration or code example that extends beyond the browser margins, use landscape mode to avoid clipping the edge of the page.
Most glossary links display the glossary in a new window. If you have already used the glossary but did not close the window, the glossary window will remain open but might be hidden behind other windows. When this occurs, selecting another glossary link will load the definition into the open window, but it will not display the glossary window in front of other windows. You will need to locate the correct browser window and bring it to the front. (For example, in Windows® you select the glossary window from the Taskbar.)
Some links in the documentation will display additional information in a new external window. Since this displays information in a new browser window, the Back button might not be available, or might behave unexpectedly. Also, as with the glossary, the window might be hidden behind other windows.
The FileNet P8 help system has three access keys available for use with the table of contents: