> For the complete documentation index, see [llms.txt](https://docs.openbrim.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openbrim.org/quick-guides/report-builder.md).

# Report Builder

{% hint style="info" %}
Follow the steps below to add design reports to a project after running analysis.
{% endhint %}

## Create the Design Report

1. Click **DOCS.** in the left bar, or click the **No Report** button and then **Open Documents**.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-132734.png?api=v2)

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-133257.png?api=v2)
2. Click the **+** sign next to the project name.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-134344.png?api=v2)
3. Choose **New Design Report**.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-134505.png?api=v2)
4. Enter a title for the design document (for example, **Design Reports**) and click **Create**. The new section appears under the project name.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-135245.png?api=v2)
5. Click the **+** sign next to the new section to add content.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-135517.png?api=v2)

{% hint style="info" %}
To rename or remove a Design Report later, use the checkbox next to it in the document tree, then use the rename or delete action.
{% endhint %}

## Add Code Checks to the Report

1. Choose **Add Code Check**. The selection dialog lists every workflow in the project, with the available code checks shown beneath each workflow.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-135717.png?api=v2)
2. Pick the code checks you want to include and click **Select**.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-135947.png?api=v2)

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-140127.png?api=v2)

{% hint style="info" %}
You can pick code checks from multiple workflows in a single Design Report.
{% endhint %}

## Run the Design and View the Report

1. After **Select**, the **No Report** button in the top-left changes to **Design**.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-140607.png?api=v2)
2. The selected code checks are listed for the Design Report.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-141241.png?api=v2)
3. Click **Design** to compute the parametric design parameters and collect the analysis results needed for the reports. Track progress in the top-middle of the screen during the run.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-141501.png?api=v2)

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-141836.png?api=v2)

{% hint style="warning" %}
Keep the design tab visible until the run completes. Hiding or minimizing the page pauses result collection.
{% endhint %}

4. When the run finishes, click **OK** to start viewing the reports.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-142415.png?api=v2)
5. Click **Report** and **Detailed Report** in succession to display the available reports.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-143116.png?api=v2)
6. **Detailed Report** opens the reports for every workflow you added to the project.

   ![](https://openbrim.atlassian.net/wiki/download/attachments/2407989257/image-20240313-142850.png?api=v2)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openbrim.org/quick-guides/report-builder.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
