Searching WorkFlows Help
The WorkFlows client uses the Java Help™ technology for presenting and indexing help topics. Four methods of accessing WorkFlows Help topics are available.
For more information about navigating about the Help viewer, see About the Java Help Windows.
It’s easy to access a help topic for the current wizard, search, helper, or gadget using the following methods.
- Click the Help button (book icon with question mark) on the current toolbar, and context help for the active window will appear.
- Select Context from the Help menu, and context help for the active window will appear.
- Right-click the mouse over a wizard icon, select Help from the shortcut menu, and the wizard help topic will appear.
Tip Use this search method to find a help topic within the wizard work flow.
Table of Contents
The Table of Contents (TOC) organizes help topics conceptually, primarily by module. The TOC folders are arranged as follows.
- About the Module
- Module Toolbar – Wizards
- Wizard Properties
- Working with the Module
- Wizard Tabs
- Wizard Fields
Use this search method to find help topics that relate to a specific module.
The Index organizes help topics alphabetically, specifically grouping wizard topics with their properties topics, “about” topics, and FAQs. All available FAQs are listed alphabetically. Additional and alternate access points have been added to assist in finding help topics.
An index search feature is available. Type a phrase and the first instance of the phrase will be highlighted in the Index list. Press ENTER to view the next match.
In the Index search, you cannot search terms that begin with a diacritic or special character. This could cause the WorkFlows client to become unresponsive, and you may have to use Windows Task Manager to end the client program or restart your workstation. This is a known issue with the Java Help technology and will be corrected in a future version of Java Help.
Use this search method when you know the topic title, subject, or keyword.
The Java Help full–text search uses a natural language search technology which analyzes your search text and locates specific passages where answers to your queries may be found.
To search the WorkFlows Help, type a natural language query, such as “billing a user,” in the Find text box on the Search tab. A list of topics with relevant passages will appear. Circles indicating relevance ranking will appear next to these topic titles, along with the number of times your query was matched in the topic. There are five possible rankings (from highest to lowest): full circle, ¾ full, ½ full, ¼ full, and empty.
By design, Java Help will only report up to 100 relevant match hits. The number of topics that appear in the list will depend on the number of relevant hits per topic. For instance, it’s possible that only five topics will appear in a list, if the sum of relevant hits in these topics is 100.
It is wise to refine your search with multi–word, natural language queries, rather than one term or keyword.
Use this search method to search questions, phrases, or keywords.
Because of Java search indexing limitations, you cannot search a term that contains a diacritic in the first character.
If you find that your search “hangs,” try typing a longer, natural language search, or type variant forms of your search terms. For instance, if you type “Display note” in the Find text box, and the search does not display results, simply type “Display notes.”
The following stop words are defined for the Java Help search.
a about after all also am an and another any are as at be because been before being between both but by came can come copyright corp corporation could did do does each etc for from get goes got had has have he her here him himself his how if in inc into is it its let like make many me might more most much must my never nor not now of off on one only or other our out over own reserved rights said same see set shall she should since so some still such take than that the their them then there these they this those though through to too under us use very was way we well were what when where which while who why will with would yes yet you your