> For the complete documentation index, see [llms.txt](https://center-for-the-integration-of-id.gitbook.io/generate-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://center-for-the-integration-of-id.gitbook.io/generate-documentation/user-guide/settings/metadata.md).

# Metadata

The new Metadata feature in Generate 12.0 provides an option to refresh the metadata from the EDPass system directly within the user interface. This enhancement simplifies the process of updating file specification metadata by automating the retrieval and integration of the most current data from EDPass.

### Overview:

* By selecting this option, Generate will use an API to pull the latest file specification metadata from EDPass.
* This metadata includes changes such as file layouts, category sets, and permitted values that affect the structure and validation of ED*Facts* submissions.

### Process:

1. **Navigate to gear icon and select Metadata from the dropdown.**

<figure><img src="https://2887782118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrRyeWMyPKDUxlv4sroOL%2Fuploads%2Fgf8i6QbrpS9AATh0lB6d%2Fimage.png?alt=media&amp;token=5a5a83ee-e346-4923-826b-8dbd750573a6" alt="Settings menu with the Metadata option selected." width="185"><figcaption></figcaption></figure>

2. **Single Click Operation:** Clicking the Metadata refresh button will initiate the process, and Generate will:
   * Retrieve the most current metadata file from EDPass.
   * Process the file and load the updated metadata into the relevant tables within the Generate environment.

<figure><img src="https://2887782118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrRyeWMyPKDUxlv4sroOL%2Fuploads%2FokgiPtBMNk7X0IZlG3YZ%2Fimage.png?alt=media&amp;token=0e71a0f6-3b5c-4ad4-8c51-826d3a55b119" alt="Metadata page with the refresh button for retrieving EDPass specifications."><figcaption></figcaption></figure>

3. **Duration:** The process can take anywhere from 30 minutes to an hour, depending on system performance and the size of the metadata file.

{% hint style="info" %}
**Note:** While the metadata update is in progress, other Generate functionalities, including migrations, will be unavailable until the update is complete.
{% endhint %}

### Benefits:

* You can refresh metadata on demand at any point, ensuring you are working with the most up-to-date file specifications.
* This allows greater flexibility, especially during periods when file specification updates are critical to your work.
* File Specification Metadata Only: This process applies solely to the metadata related to ED*Facts* file specifications provided by the Department of Education. It does not apply to state-specific metadata, such as state supplemental survey responses.

### Frequency of Metadata Updates:

* Metadata from EDPass: EDPass updates metadata in chunks based on the upcoming ED*Facts* reporting windows. It is not updated daily, so there’s no need to run the refresh daily.
* Expected Timelines: Metadata changes are typically rolled out well in advance of submission deadlines, giving you ample time to refresh and validate your data with the latest specifications.

### Limitations During Metadata Refresh:

While the metadata update is in progress, you will not be able to run data migrations or other Generate processes until the update is complete. Plan your work around this downtime, especially during heavy data submission periods.


---

# 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://center-for-the-integration-of-id.gitbook.io/generate-documentation/user-guide/settings/metadata.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.
