Filtering the help

Applying a filter to the help reduces the number of help topics that are displayed in the navigation tree and in search results. Filtering helps you more easily find pertinent information.

About this task

The product documentation for the Rational® solution for Collaborative Lifecycle Management (CLM) contains help topics for the three products: IBM® Rational DOORS® Next Generation, IBM Rational Team Concert™, and IBM Rational Quality Manager. The help topics also include all the tasks you can do that span the products. As a result, the product documentation is quite large. The help topics probably contain information that is unrelated to you in your particular role and your particular goals.

By setting a filter, you customize the online help to suit your information needs. At any time, you can modify the filter to see fewer or more topics. Alternatively, you can remove the filter to see all the help topics. The filter affects the topics that are listed in both the navigation tree and the search results. However, if you follow an in-topic link to a filtered-out topic, the topic is displayed, but not in the navigation tree or search results.

The following table explains what the information that is associated with each of the filter options. Initially, the product documentation shows all available content. Clearing an option check box removes that content from the navigation tree and search results. Some content is important for all types of users and goals, so that content is never filtered out regardless of which options are selected or cleared. For example, information about accessibility, or how to use the online help system is always available.
Filtering option Description of the content that is associated with the filter option
Role: Users Content about using the software tools to do your work. Content about using the various applications that are part of the Rational CLM solution, such as completing these tasks:
  • Creating work items
  • Managing source code
  • Developing requirements
  • Testing software
  • Planning projects
  • Setting up dashboards
  • Running and customizing reports
Role: Server administrators Content about installing, upgrading, and configuring the solution to suit your team's needs, including this information:
  • Migrating data from other products
  • Managing licenses and permissions
  • Setting up integrations with other products
Role: Project administrators Content about setting up and managing the process, structure, rules, roles, and reusable assets, such as templates, for a requirement, development, or testing project.
Capability: Change management Content about the Change Management application, including work items and workflow process.
Capability: Reporting Content about completing these tasks:
  • Collecting real-time and historical data from requirements development, and testing artifacts
  • Using the data to generate informative and customizable reports that reveal trends, status, health, risk, and other patterns
Capability: Build automation Content about build awareness, build control, and build traceability for development and test teams.
Capability: Planning Content about releases, time lines, plans, tracking, and workload balancing.
Capability: Software configuration management Content about the built-in source-control system.
Capability: Requirements management Content about requirements elicitation, collaborative definition, organization, governance, and traceability, from setting the vision for a project through requirements-driven testing.
Capability: Quality management Content about test project management, planning, workflows, lab efficiency, coverage analysis, and script authoring.
Are you a developer using the Client for Visual Studio? Content about using the Rational Team Concert client for Visual Studio as the development environment.
For more detail about each application and capability, see Applications, capabilities and projects.

Procedure

  1. Click the Filter icon Filter help content icon in the help banner.
  2. Initially, all check boxes are selected, meaning all information is shown. To get the help that pertains to you, clear check boxes that do not relate to you or your goals.
  3. Click OK to view the reduced product documentation.
  4. Click View Help Unfiltered to restore all the help content.

Example

You can filter primarily by your role in your organization. For example, if you are responsible for installing and configuring this solution on your team's servers, clear the User and Project Administrator check boxes. The resulting product documentation includes these topics:
  • Installation
  • Configuration
  • Migration
  • Upgrading
  • Integration setup topics
  • Tutorials
However, information about user or project manager tasks such as creating test plans or customizing workflow process templates is not included.
Alternatively, you can filter by which capabilities you use. For example, if you are a business analyst who collects and refines requirements for your project, and you never use change and configuration management or quality management tools, clear these check boxes:
  • Change management
  • Build automation,
  • Software configuration management, and
  • Quality management
Optionally, keep the Planning and Reporting check boxes checked, if you interact with those capabilities. The resulting help includes information about requirements definition and management (and optionally planning and reporting), and not the features you cleared.

Furthermore, you can select both your role and the capabilities that you use, and narrow the content even further. For example, you can customize your help to contain topics about user tasks for only the Quality Management capability or topics about Project Administrator tasks for only Requirements Management.

Because of the cross-application nature of the Rational CLM solution, many help topics do not fit neatly into the preceding categories, so you might see content that does not apply to you. For example, you might see driving your development work items from requirements, or relating test results to defect work items, or associating a build with a set of failed test cases. Alternatively, if you set a filter and cannot find some information either by browsing or searching, clear all filters, and try Search again.

To limit the scope of the help, you can click Scope, and then click New to create a scope list and select the specific topics to see. Click OK to see only the selected topics and their children. The filter settings are applied to the scoped content so you get topics that are in the scope and in the filtered selection.


video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki