# Metadata Report Builder

{% hint style="info" %}
The user must be granted access to the report builder by an Administrator of the Stewardship Organisation.
{% endhint %}

This feature in the Registry allows Administrators of the Stewardship Organisation to generate reports related to metadata items by adding a relationship to the item fields, which is already established between different metadata in the Registry.

### Steps to navigate to the Report Builder from the Dashboard&#x20;

1. From the Dashboard, select the "Toolbox" from the drop-down list or the side panel.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FKVVqHwW6vu2KDbKIq14K%2Fimage.png?alt=media&#x26;token=99b66cbb-5587-4c3f-a188-772aee6f0fae" alt=""><figcaption></figcaption></figure>

2\. Click on "Go to Metadata Reports" under Metadata Reports on the Toolbox page.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FS8ewkyoxTxX1YRexisa7%2Fimage.png?alt=media&#x26;token=07cb99e4-bf47-4c59-bc19-8603fdb728a8" alt=""><figcaption></figcaption></figure>

3\. Users can create a report from this page. They can also import reports previously generated by the report builder if they have JSON code saved for that generated report.

### Steps to Create a New Report

1. Click on "New Report" on the metadata report builder page.&#x20;

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FNfALrfElXPDFwPyQ16Pl%2Fimage.png?alt=media&#x26;token=1a1391f0-eaa7-4389-b950-ca19bf20be9e" alt=""><figcaption></figcaption></figure>

**Select a Steward Organisation:** Users must select the Stewardship Organisation for which they want to generate a metadata report.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FORfpSH3H1qcS90MV0I5k%2Fimage.png?alt=media&#x26;token=1be15f44-2b84-4db2-96ae-727a649948a1" alt=""><figcaption></figcaption></figure>

**Select a Base Model:** After Selecting the Stewardship organisation, the user must select a base model for the report builder.&#x20;

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FHt0lKE710MsHH64B99ge%2Fimage.png?alt=media&#x26;token=29b5df70-dad2-4ea4-8592-5c897aa7ddb7" alt=""><figcaption></figcaption></figure>

2. After Selecting the base model, the user can access the side panel to select items and extract the report of existing relationships between metadata of the selected base model. They have access to two different fields on the left side panel:

**Relational Fields:** All the sections under this field can help a user to create a relationship with the item fields.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F3z60Ic63xAIL31ob2yAu%2Fimage.png?alt=media&#x26;token=5d7ca727-c914-4021-b482-500763e49033" alt=""><figcaption></figcaption></figure>

**Item Fields:** This section will give users all the information for the base model they selected.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2Fz2GbCCmOAV3KwTwEXadE%2Fimage.png?alt=media&#x26;token=d837864e-c219-4db8-8a62-8d666ce072b4" alt=""><figcaption></figcaption></figure>

**Add Columns:** The user can drag and drop the items from the item field here.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FdFimiaAd2N05vDpezPV1%2Fimage.png?alt=media&#x26;token=682a57f3-bbab-4365-bd82-9c3fe03f87a6" alt=""><figcaption></figcaption></figure>

To extract the Relationship for this item field, the user can click on relations listed under the Relational Field section and drag the items from the Item Fields section.&#x20;

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FmMnMP1FFQKwQ5jNAuT1Q%2Fimage.png?alt=media&#x26;token=a451372b-e62b-4cf9-aed8-99b00ef7cdcd" alt=""><figcaption></figcaption></figure>

For example, if the user wants to know the status of the metadata item, the user can select "Statuses" under the "Relational Field" and can drop the relevant items from the "Item fields".

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FZ3MGfX9Lz1OfiiJfabJG%2Fimage.png?alt=media&#x26;token=3e77a3d2-b5f2-4ffb-86b2-068fe8248ed2" alt=""><figcaption></figcaption></figure>

**Add Filters:** the user can add filters by dragging and dropping the item under the "Item Fields" from the left side panel.

Users can filter the metadata reports as per their requirements.  &#x20;

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FAxOSmggUTM8zXPQCyBNZ%2Fimage.png?alt=media&#x26;token=218d4cc2-8528-4863-8a80-0d410aaced51" alt=""><figcaption></figcaption></figure>

3. Click on <img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FoaiSJVnObo60vzpzxGAT%2Fimage.png?alt=media&#x26;token=d6ddc1a7-e25a-4c18-ab1d-a66fd531f0cc" alt="" data-size="line"> to view the outcome of the report generated after performing all the relevant steps by the user.&#x20;
4. Users can download the report in Excel and CSV file Format.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F9TkQ8Lt7S2CgYfeLenE2%2Fimage.png?alt=media&#x26;token=cb6a3573-2315-4633-906e-ddf874b1ded1" alt=""><figcaption></figcaption></figure>

Users can also save this report in the Registry for future reference.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FQh8AAJloA7aFLK1508In%2Fimage.png?alt=media&#x26;token=81de3d64-1528-468c-9a1e-6cc768d8053f" alt=""><figcaption></figcaption></figure>

Users can also export this generated report to other Administrators by selecting "Export Report".

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FOfYjrtX0POXr2Yvbcptr%2Fimage.png?alt=media&#x26;token=71d69da6-f6d3-4b3c-b1c9-2875ac91f505" alt=""><figcaption></figcaption></figure>

Users can copy this JSON code and share it with other Administrators so that they can also view this report.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F7iVEEzaH9QK8JB3yeg2p%2Fimage.png?alt=media&#x26;token=3c5f831f-0095-4594-a146-28c14ccb765d" alt=""><figcaption></figcaption></figure>
