# Report

UDiTH includes a powerful yet easy-to-use reporting engine.
To create a report, click **Add** in the **Files** tab and then select **Report**.

<img src="./media/FilesAddReport.png" width="250" height="">

## Report Definition Dialogue

<img src="./media/ReportSelection.png" width="200" height="">

The report definition selection shows a list of predefined reports. These are defined in the Excel file **IntelliPidReportDefinition.xlsx**.

> For more details about predefined report definitions, see **Report definitions** in the **Custom settings** chapter.

When you select a report definition, the report results page opens and additional filters can be applied. Two buttons are available next to each report definition:

<table>
<tr><th><img src="./media/ButtonEdit.png" width="44" height="44"></th><td>

**Report Settings**

This opens the Report Editor and allows you to modify the predefined report definition. For more details, see **Report Editor** below.

</td></tr>
<tr><th><img src="./media/ButtonSave.png" width="44" height="44"></th><td>

**Save Report**

This opens the save dialogue directly. You can save the report results as an **.xlsx** or **.csv** file for further use outside UDiTH.

</td></tr>
</table>

> If none of the existing report definitions is suitable, click **New** to open the Report Editor.

## Report Editor

The Report Editor helps you create reports easily:

-   Select whether you want to include sketch data and attributes assigned to sketch items shown in blue.

-   Choose the scope of the report. `All elements` includes all elements in the model.

-   Select the attributes you want to include in the report by dragging them to the right.

<img src="./media/IntelliPID_image164.png" width="632" height="511">

The **Reset** button clears the **Selected attributes** table. All other settings remain unchanged.

Click **OK** to generate the report and display the **Report Results** view.

## Report Results

The report results are displayed in the **Report Results** screen. The screen is divided into the **Report Menu** on the left and the results grouped by attributes. You can select multiple results by holding down the **Ctrl** key while clicking the lines:

<img src="./media/IntelliPID_image165.png" width="652" height="280">

### Report Menu

The report menu contains functions that help you narrow down the results, locate items on the P&ID, or export the results:

<table>
<tr><th><img src="./media/IntelliPID_image166.png" width="44" height="44"></th><td>

**Reload Report** - Updates the report, for example if custom attributes have changed.

</td></tr>
<tr><th><img src="./media/ButtonFit.png" width="44" height="44"></th><td>

**Fit in model** - Highlights the selected items in the corresponding P&IDs or 3D tabs. If the P&IDs are not already open, they are opened automatically and shown in the tab bar.

</td></tr>
<tr><th><img src="./media/IntelliPID_image167.jpg" width="44" height="44"></th><td>

**Select underlying objects** - This function currently produces the same result as **Fit in model**.

</td></tr>
<tr><th><img src="./media/ButtonCopy.png" width="44" height="44"></th><td>

**Copy current report definition** - Copies the current report definition to the clipboard so that it can be saved in the report definition file. For more details, see **Report definitions** in **Custom settings files**.

</td></tr>
<tr><th><img src="./media/ButtonEdit.png" width="44" height="44"></th><td>

**Customise Report Settings** - Opens the Report Editor and allows you to modify the current report definition. For more details, see **Report Editor** above.

</td></tr>
<tr><th><img src="./media/IntelliPID_image168.jpg" width="44" height="44"></th><td>

**Toggle quick filter** - Toggles the quick filter to narrow down report results. When activated, another line is shown below the attribute names. Wildcards can be used:

</td></tr>
</table>

<img src="./media/IntelliPID_image169.png" width="559" height="53">

<table>
<tr><th></th><td>

The line consists of a filter string field and two additional buttons:

</td></tr>
<tr><th><img src="./media/IntelliPID_image170.png" width="44" height="44"></th><td>

**Hide/show exclusive clauses** - Allows you to set additional filters to show or hide exactly defined values and displays the current number of values set.

</td></tr>
<tr><th><img src="./media/IntelliPID_image61.png" width="44" height="44"></th><td>

**Clear filter** - Clears and resets all filters.

</td></tr>
<tr><th><img src="./media/IntelliPID_image62.png" width="44" height="44"></th><td>

**Filter combine mode** - If several filters are set, they are combined with an **OR** operator by default, meaning only one filter condition must be true. If you switch to **AND**, all filter conditions must be met for an item to be listed.

</td></tr>
</table>

### Right-Click Filter

To refine the results further, you can also right-click, or long-tap, an attribute value in the results list. A pop-up appears, allowing you to show or hide the selected values exclusively.

<img src="./media/IntelliPID_image63.png" width="404" height="78">

All lines with the corresponding values are then either shown or hidden in the results list.

### Custom Attribute Editing

If multiple lines are selected and a custom attribute with a CodeList is included in the report, changes can be applied in bulk to all selected items:

<img src="./media/IntelliPID_image64.png" width="382" height="228">
<img src="./media/IntelliPID_image65.png" width="382" height="228">
<img src="./media/IntelliPID_image66.png" width="382" height="228">

> For even more detailed reporting and advanced reporting features, use **CAXperts UniversalReporter**.

### Filter and Sorting

You can **sort alphabetically** by clicking an attribute. **Combine** multiple search strings with a **space**, and **exclude** search strings by using **!**.