# Report Builder

{% hint style="info" %}
For projects created with the **All-in-One Bridge Workflow**, follow the steps below to add design reports after running analysis.
{% endhint %}

## Create the Design Report

1. Click **DOCS.** in the top-left menu, 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: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.