Online Help Tips
Most of the DataFlux documentation is provided as online Help. Online help allows you to search documentation using keywords, browse through a table of contents or index, follow links within help files and even set regularly visited topics as favorites.
This topic explains how to access online help and provides basic information you need to use the online help.
Accessing Documentation
Documentation is located in the doc directory of your DataFlux installation. For example, C:\Program FilesDataFlux\ProductName\version\doc.
You can also access the online help from the software:
- On any DataFlux Data Management Server screen with a Main menu, select Help > Topics. This displays the opening topic for the active component.
- Click Help
on the toolbar.
- If available, click Help (in the lower right corner) on many of the application dialog boxes.
- Click Start > Programs > ProductName version > Documentation.
Note: If you see a message similar to this, "To help protect your security, Internet Explorer has restricted this file from showing active content that could access your computer. Click here for options." Click the notice and select Allow Blocked Content. Depending on your enterprise, you may be permitted to make changes to your settings. See your IT Department for details.
Using the Help
The online help system includes three sections, the help toolbar, the left navigation pane, and the topic area.
Online Help
Help Toolbar
The help toolbar contains the following options:
- Back - Click Back
to go to the previously viewed topic.
- Forward - Click Forward
to return to the last topic you viewed.
- Refresh - Click to Refresh
the topic.
- Stop - Click Stop
to the action currently running, for example a search.
- Print Topic - Click Print Topic
to print the topic you are currently viewing.
- Favorite - If you want to save a topic to your online help Favorites, click Favorites
.
- Quick Search Text Box - Type a name or portion of a name in the Quick Search text box to search the online Help file you are viewing.
Note: The Quick Search option searches an open topic while Search in the left frame searches all topics within the online Help.
- Find - Once you enter the keyword in the Quick Search Text Box, click Find
to locate files on a particular topic.
Left Navigation Pane
Use the left navigation pane to access specific topics in the help system. Click the navigation riser bars to access topics in a variety of ways including:
- Table of Contents - The Table of Contents riser bar provides quick access to topics for online help. To view the available topics, click the book
icon to expand the list of topics or click the question
icon to open the topic in the topic area (right).
- Index - The Index riser bar lists terms used in the online help. To view the topic that contains that term, click the term in the left navigation pane. If more than one topic contains that term, a list of those topics will appear when you click. Click the term definition to open the related help topic.
- Search - The Search riser bar supports a full-text search of the Help. After you type a search word or phrase, press Enter, the names of the topics that contain that word or phrase will appear. Click a topic name to view the topic.
Note: This Search option searches all topics within the online help while the Quick Search option (in the toolbar) searches an open topic.
You can save a search string to your favorites. Click Add Search String to Favorites
.
- Glossary - The Glossary riser bar lists definitions for commonly used terms. Click on a word to view the definition.
- Favorites - The Favorites riser bar lists topics you have selected for your online help favorites.
Topic Area
The topics you select display in the right pane of the online help system. Each topic may include links to related information.
The Doc ID is provided in the lower right corner of every topic. If you have a question and need to refer to a help topic, provide the Doc ID to technical support.