Enable Entity Exploration

Entity Exploration lets authorized project contributors find and review entities identified in an analyzed project. Use it after a project has been created and analyzed so contributors can search the available model instead of manually locating entities in project documentation.

Overview

Entity Exploration provides a searchable view of analyzed entities within the context of a project. Contributors can use the Search entities… field to locate an entity by name and focus their review on the relevant part of the product model.

You typically enable access to Entity Exploration by making sure contributors can open the correct project and its documentation area. Entity availability depends on the project having analyzed content; an empty or newly created project may not yet provide entities to search.

This task is important when you want project contributors to explore the same analyzed model, review entity relationships, and use project documentation without switching between separate projects.

📷 Screenshot pending: Entity Exploration showing the Search entities… field and available analyzed entities.

Prerequisites

Before you begin, make sure that:

• You can access the Projects area.
• The project has already been created.
• The project contains analyzed source material or generated documentation.
• The people who need to explore entities are authorized project contributors.
• You know which project should provide the entities.
• You can open the project dashboard using Open Project Dashboard.

Step-by-Step Instructions

1. Open Projects from the application navigation.

2. Use the Search projects... field to locate the project that contains the analyzed entities you want to share.

3. Select the appropriate project from the project list.

4. Click Open Project Dashboard to enter the focused project workspace.

📷 Screenshot pending: A project in the Projects list with the Open Project Dashboard action available.

5. Open the project’s documentation area from the project workspace.

6. Confirm that the project is selected before continuing. If the documentation area displays Select a project to view documents, return to Projects and open the intended project dashboard.

7. Locate the entity exploration area within the project documentation.

8. Click the Search entities… field.

9. Enter the name of an analyzed entity that contributors should be able to find.

10. Review the matching entity results to confirm that the project’s analyzed entities are available for exploration.

11. Share the project with the authorized contributors through your organization’s established project-access process.

12. Ask contributors to open Projects, select the same project, and use Search entities… to locate the entities they need.

13. Verify access with a contributor account or with a contributor who has been granted access.

14. If contributors need to return to the project list, instruct them to select ← Back to Projects or ← Back to Projects, depending on the screen they are using.

Tips and Best Practices

• Keep related entities in the same project whenever possible. Entity search is performed in the context of the selected project, so contributors should open the correct project before searching.

• Use clear, recognizable entity names in the underlying analyzed material. This makes results easier to find when contributors type into Search entities….

• Confirm that analysis or documentation generation has completed before asking contributors to explore entities. If no analyzed material is available, the search experience may not return useful results.

• Use Search projects... before opening a dashboard when your organization has many projects. This reduces the risk of enabling contributors to work in the wrong project.

• Treat project access as the boundary for Entity Exploration. Only provide project access to contributors who should be able to view the analyzed product model.

• If you manage several projects, use the project name and project dashboard as the primary context check before reviewing entity results. Do not assume that similarly named entities belong to the same project.

Related Pages

• Create a Project
• Open a Project Dashboard
• View Project Documentation
• Search Entities
• Manage Project Contributors
• Generate Technical Documentation

Troubleshooting

The documentation area says “Select a project to view documents”

You are not currently working in a selected project context. Click ← Back to Projects, locate the project with Search projects..., and select Open Project Dashboard before opening documentation again.

No entities appear when you use “Search entities…”

Confirm that you opened the correct project and that the project contains analyzed source material or generated documentation. A new project may not have entities available until analysis has been completed.

A contributor cannot find or open the project

Verify that the contributor has been granted access to the intended project through your organization’s project-access process. Then ask them to open Projects, search for the project using Search projects..., and select Open Project Dashboard.