# Report Flags

## Table of Contents

* [Overview](#overview)
* [Getting Started](#getting-started)
* [Flag Statuses and Lifecycle](#flag-statuses-and-lifecycle)
* [Reviewing Flags by Domain](#reviewing-flags-by-domain)
  * [Report Card Flag Status Table](#report-card-flag-status-table)
  * [Drilling Into a Domain](#drilling-into-a-domain)
  * [Viewing Flag Details by Report](#viewing-flag-details-by-report)
* [Reviewing Flags by Organization](#reviewing-flags-by-organization)
  * [Navigating the Organization Hierarchy](#navigating-the-organization-hierarchy)
  * [Viewing Flag Details by Organization](#viewing-flag-details-by-organization)
* [Editing a Flag](#editing-a-flag)
* [Common Scenarios](#common-scenarios)
* [Troubleshooting](#troubleshooting)

## Overview

Report Flags are a quality control and review mechanism for educational reporting data. They allow authorized users to mark specific reports for a given school or organization as needing attention, track the review status of those flags over time, and see at a glance how many flags are open or resolved across domains and organizations.

Each flag is associated with a single report, an academic year, and an organization unit (state, district, or school). When a flag is raised, reviewers can add comments to explain the concern. As the issue is addressed, the flag status moves through a defined lifecycle from raised to lowered to cleared.

The Review Flagged Reports area gives two complementary views of the same flag data: one organized by reporting domain and one organized by the organizational hierarchy. Both views let you drill from a high-level summary into the individual flag records where you can read comments and update status.

## Getting Started

Access to the Report Flags feature requires the Report Flags permission on your account. Your administrator controls which users have this permission.

* To view flag summaries: your account needs the standard Report Flags permission.
* To create new flags: your account needs the Report Flags Create permission.
* To edit flag status and comments: your account needs the Report Flags Edit permission.
* To delete flags: your account needs the Report Flags Delete permission.

To open the Review Flagged Reports area, navigate to it from the main navigation. The first screen you see shows flag counts organized by domain. You can switch to the organization view at any time using the Visualize By control.

If you do not see any flags, confirm that you have selected an academic year from the school year dropdown. No data loads until a year is selected.

## Flag Statuses and Lifecycle

Every flag has a status that describes where it is in the review process. There are four possible statuses:

**Not Flagged** — The default state. The organization has no active concern recorded for this report. A record in this state is essentially a placeholder confirming review coverage, not an active issue.

**Raised** — A concern has been identified. Someone has flagged this report for the organization, indicating that the data requires attention or investigation. Comments explaining the concern are typically added at this stage.

**Lowered** — The concern has been acknowledged and action has been taken, but the flag has not been fully resolved. This intermediate status signals that work is in progress.

**Cleared** — The concern has been fully resolved. The flag is closed. Cleared flags are still visible in summaries and details so there is a complete audit trail of what was reviewed and resolved.

Summary tables throughout the feature display the count of flags in each status side by side — Not Flagged, Raised, Lowered, Cleared, and Total — so reviewers can see the full picture at a glance.

## Reviewing Flags by Domain

The domain view organizes flags by the reporting domain each report belongs to. This is the default view when you open Review Flagged Reports.

### Report Card Flag Status Table

The main table on the domain view lists each domain with a breakdown of flag counts across all organizations for that domain:

| Column      | Description                                                    |
| ----------- | -------------------------------------------------------------- |
| Domain Name | The name of the reporting domain                               |
| Not Flagged | Number of organization-report combinations with no active flag |
| Raised      | Number with an open, unresolved concern                        |
| Lowered     | Number with a concern in progress                              |
| Cleared     | Number with a resolved concern                                 |
| Total       | Total number of flagged records across all statuses            |

Select an academic year from the school year dropdown to load flag data for that year. The table updates automatically when the year changes. You can sort any column by clicking its heading.

### Drilling Into a Domain

To see how individual reports within a domain are performing, click the drill-down action icon on any domain row. This opens the Domain Flag Status view, which lists every report within that domain with the same Not Flagged / Raised / Lowered / Cleared / Total breakdown.

A breadcrumb trail at the top of the page shows your navigation path. Click any breadcrumb to navigate back up to that level.

### Viewing Flag Details by Report

From the Domain Flag Status table, click the preview icon on any report row that has active flags (rows where the Not Flagged count is less than the Total count). This opens the Report Flag Details view.

The Report Flag Details view lists every individual flag record for that report across all organizations. Each row shows:

* **State/District** — The parent organization
* **Organization Name** — The specific school or district the flag belongs to
* **User Name** — The user who created the flag
* **Last Updated** — When the flag was most recently changed
* **Status** — The current flag status
* **Comments** — Any notes recorded when the flag was created or updated

Use the Status dropdown above the table to filter the list to a specific status (Raised, Lowered, or Cleared). The default shows all statuses. Select a different academic year to switch the view to that year's data.

To edit a flag record from this view, click the edit icon on the row. An edit panel appears below the table where you can update the status and comments. See [Editing a Flag](#editing-a-flag) for details.

## Reviewing Flags by Organization

The organization view organizes flags by where each organization sits in the state hierarchy: state, district, or school. Switch to this view by changing the Visualize By dropdown to Organization.

### Navigating the Organization Hierarchy

When you first open the organization view, you see a summary table for the top of the hierarchy your account has access to. The sub-header above the table indicates which level you are viewing (State Flag Status, District Flag Status, or School Flag Status).

Users whose accounts are associated with a specific district or school are automatically placed at the appropriate level in the hierarchy when the page loads. A district user sees the districts under their state. A school user sees only their school's row within the district view.

To drill down into child organizations, click the navigate-children icon on a state or district row. The table reloads to show the organizations one level below. The breadcrumb trail updates to reflect where you are. Click any breadcrumb item to navigate back up to that level.

For each organization, the table shows the same Not Flagged / Raised / Lowered / Cleared / Total counts. Only organizations that have at least one non-zero flag count (Raised, Lowered, or Cleared) show the view-details action icon.

### Viewing Flag Details by Organization

To see individual flag records for an organization, click the preview icon on any row that has active flags. This opens the organization's flag details view, which displays all flagged reports for that organization.

Each row in the details table shows:

* **Report Name** — The name of the flagged report
* **User Name** — The user who created the flag
* **Last Updated** — When the flag was last modified
* **Status** — Current flag status
* **Feedback / Comments** — Notes recorded with the flag

Three filters are available above the table to narrow the list:

* **School Year** — Select the academic year to view
* **Status** — Filter to a specific flag status (Raised, Lowered, or Cleared), or leave set to (All) to see every status
* **Domain** — Filter to a specific reporting domain to focus on one area at a time

To edit a flag from this view, click the edit icon on the row. See [Editing a Flag](#editing-a-flag) below.

## Editing a Flag

When you click the edit icon on a flag detail row (available in both the domain and organization detail views), an edit panel appears. The panel is pre-populated with the current values for that flag record.

In the edit panel you can:

* Change the flag status (Not Flagged, Raised, Lowered, or Cleared)
* Update or add comments to describe the current state of the review

After saving your changes, the table refreshes to show the updated record. To close the edit panel without saving, click Cancel.

A report flag is unique per combination of report, organization, and academic year. You cannot create a second flag for the same report, organization, and year — the system will display an error if a duplicate is attempted. Editing the existing flag is the correct way to update its status or comments.

## Common Scenarios

**Raising a flag on a report for a district.** Navigate to the organization view, drill into the district, and locate the report in question. If no flag record exists for that report yet, an administrator with the Create permission can create one by setting the status to Raised and adding a comment that describes the issue.

**Tracking progress across all open flags.** Open the domain view, select the current academic year, and review the Raised column for each domain. Click the drill-down icon on any domain with a high Raised count to see which specific reports are affected. Then click into a report to see which organizations still have open flags.

**Clearing resolved flags.** After an issue is resolved, open the flag detail for the relevant organization or report, click the edit icon on the flag row, change the status to Cleared, and save. The Cleared count in all summary tables updates immediately.

**Switching between views.** The Visualize By dropdown is available on both the domain summary and organization summary pages. Changing this setting navigates you to the other view while keeping your selected academic year.

## Troubleshooting

**No data appears in the table.** Select an academic year from the school year dropdown. Flag summaries do not load until a year is selected.

**The preview icon is not visible on a row.** The view-details action only appears on rows that have at least one flag with a status of Raised, Lowered, or Cleared. Rows where all flags are Not Flagged (or where total equals not-flagged) do not show the preview action. If you expect to see flags but the icon is missing, confirm you have the correct academic year selected.

**An error appears when creating a flag.** A flag already exists for that combination of report, organization, and academic year. Find the existing flag record and edit it rather than creating a new one.

**You cannot see certain organizations in the hierarchy.** Your account's default organization determines which part of the hierarchy you can navigate. District users see their district and its schools. School users see only their school. Contact your administrator if you need access to additional organizations.

**The edit panel does not appear after clicking the edit icon.** Confirm your account has the Report Flags Edit permission. If the icon is visible but clicking it does nothing, the issue may be a permissions mismatch — contact your administrator.


---

# 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://nimble.docs.otised.com/guides/report-flags.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.
