--- title: Report Builder slug: report-builder docTags: createdAt: 2026-04-15T14:35:39.915Z --- The Report Builder allows you to create custom reports using Data Warehouse tables. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/-OHxpa64d3S0qfn5pQ3Rj_image.png) Think of the Data Warehouse as a simplified, organized set of data designed specifically for reporting. Instead of working with hundreds of system tables, the Data Warehouse provides a smaller set of structured tables that contain the most relevant information. Using the Report Builder, you can: - Choose what data you want to report on - Filter results to show only what you need - Group and organize your data - Customize which columns appear in your report Before creating a report, it’s important to understand how the **Primary Tables** work, since this is what everything in your report is built from. # Understanding Primary Tables When you create a report, the **Primary Table** is your starting point. It determines what data you’re working with, how your report is structured, and how detailed your results will be. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/FjXHCoCsXiVQkFuPc2npp_image.png) The Data Warehouse organizes tables into clear, purpose-built datasets, so you don’t need to work with raw or complex database tables. Start by asking: *what am I trying to report on?* If you want a **complete snapshot of each student**, use: - **DW Student Overview** – combines academic, financial, attendance, and program data into a single view If you’re working with **students or admissions data**, use: - **DW Students** – core student and prospect information - **DW Prospects** – admissions pipeline data like stages and sources - **DW Prospect Stage History** – tracks how prospects move through stages over time If your report is about **courses, instructors, or scheduling**, use: - **DW Courses** – course details like schedule and status - **DW Course Instructors** – instructor assignments - **DW Instructors** – instructor information - **DW Sessions** – academic terms and date ranges If you’re analyzing **academic performance**, use: - **DW Student Academic Summary** – GPA, credits, and academic standing - **DW Student Enrollments** – course-level data including grades and attendance - **DW Student Grades** – detailed grade records If you want to track **student progress over time**, use: - **DW Student Programs** – program-level progress and completion - **DW Student Sessions** – performance by term or session If your focus is **attendance**, use: - **DW Student Attendance Summary** – totals and high-level metrics - **DW Student Attendance** – detailed attendance records If you need **financial data**, use: - **DW Student Financial Summary** – balances and aging - **DW Student Account Activity** – transaction-level detail # Creating a New Report Go to **Reports → Report Builder** and click **New Report Builder Report** to open the setup window. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/4pIBWOP6ygg25L1ix7AzS_image.png) - **Report Name (required):** The name of the report as it will appear in the list. Use something clear and easy to recognize. - **Description:** Optional note to explain what the report is used for. - **Data Source:** Where the report pulls data from. Select **Data Warehouse** for all new reports. The Production Tables (Legacy\*) option is being phased out. - **Primary Table:** The main dataset your report is built on. This determines what data is available and how it is structured. Choose based on what you want to report on. - **Read Only Access:** Roles that can view the report but cannot make changes. - **Read / Update Access:** Roles that can edit the report. - **Location Access:** Locations that are allowed to access the report. Click **Add** to create the report. You will then be taken to the **Edit Report Builder Report** page, where you build and customize your report by adding fields, filters, grouping, and sorting. :::hint{type="danger"} Legacy tables may still appear as a Data Source option temporarily, but they are being phased out. Existing reports that use legacy tables will continue to work, but new reports should be built using Data Warehouse tables. ::: # Details The **Details** section contains the basic information for your report. This is the same information entered when the report was first created. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/Trm_CwCqrUl9psxuWLseg_image.png) - **Report Name:** The name of the report as it appears in the Report Builder list. You can update this at any time. - **Description:** Optional note explaining what the report is used for. This is helpful for other users who may access the report. - **Primary Table:** The main dataset the report is built on. This **cannot be changed after the report is created**, so if you need a different table, a new report will need to be created. - **Read Only Access:** Roles that can view the report but cannot make changes. - **Read / Update Access:** Roles that can edit the report. - **Location Access:** Locations that are allowed to access the report. Click **Save Report Details** after making any changes. # Parameters Parameters allow you to add user input to a report. This lets users customize the results when running the report (for example, selecting a date range or filtering by a specific value). ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/Uj4uX6jsjPx6INk7gVJUy_image.png) - **Parameter Name (required):** The name of the parameter used in the report. - **Parameter Label:** The label users will see when running the report. This should be clear and user-friendly. - **Parameter Type (required):** The type of input the user will provide. Options include: - **Boolean** – true/false values - **Date** – must be in YYYY-MM-DD format - **Integer / Number** – numeric values - **String** – text input - **List** – predefined list of values - **Time** – must be in HH\:mm\:ss format - **Default Value:** An optional value that will be pre-filled when the report is run. Click **Add** to create the parameter. Once added, parameters can be used in the report’s conditions to dynamically filter results. # Joins Joins allow you to bring in additional data from another table into your report. Joins are typically used for more complex reports. Most standard reports can be built using a single Data Warehouse table. Use a join when: - the data you need is **not available in your primary table** - you need to combine information from **two different datasets** ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/ewEsGIML0465725Hs7ZSh_image.png) - **Join Type:** Controls how data from the two tables is combined - **Inner:** Only shows records that exist in both tables - **Left:** Shows all records from your main (primary) table, plus matching data from the second table - **Right / Cross:** Less commonly used and typically not needed for standard reports - **Left Table:** The primary table your report is built on - This is automatically set and cannot be changed - **Left Column:** The field from the primary table used to match data - This is usually an ID or key field (for example, student\_id) - **Right Table:** The additional table you want to pull data from - You can select from any available Data Warehouse table - **Right Column:** The field in the second table that matches the Left Column - This must correspond to the same type of data (e.g., student ID to student ID) - **Join Right Table As:** A name for the joined table - Used internally in the report - Must be unique and contain no spaces # Conditions Conditions allow you to filter your report results so only specific records are shown. For example, you may want to: - Show only **active students** - Show students from a specific program - Show records within a certain date range To add a condition, click **Add Condition Group**. A condition area will appear with an **AND / OR toggle** and an option to add conditions. - **AND:** All conditions in the group must be true - **OR:** Any condition in the group can be true ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/l8CEcgKrzHxDDKWfs-PRo_image.png) Then, click **Add Condition** to add a filter. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/sHXiohsPdFRJLsckROhqG_image.png) Each condition is made up of the following: - **Table:** The table the field belongs to - This is automatically set based on your report and cannot be changed - **Column:** The field you want to filter on - Example: student\_status, current\_program\_name, balance - **Operator:** How the value is compared - Examples: - \= equals - != not equal - \> greater than - \< less than - LIKE contains text - **Value:** The value you are filtering by - Enter the value you want to match - **Parameter (optional):** - Allows users to enter a value when running the report - Requires a parameter to be created in the **Parameters** section first - If no parameter exists, selecting this will show an error You can add multiple conditions within a group to further refine your report results. Use the **AND / OR** toggle to control how those conditions are applied. # Group By Group By allows you to organize your report results into categories, making the data easier to read and summarize. For example, instead of seeing a long list of students, you can group them by program to see how many students are in each program. To add a Group, click **Add Group By** to open the grouping options. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/etRU9rD0MPnYRB9QnZf7b_image.png) - **Group By Table:** The table the field belongs to. This is typically your primary table and usually does not need to be changed - **Group By Column:** The field you want to group your data by - **Group By Header (required):** The label that will appear in your report - **Column Function (optional): **Applies a function to the selected column (advanced use). Examples include formatting text, working with dates, or rounding numbers. In most cases, this can be left as **None** Grouping helps turn raw data into something easier to understand. Without it, your report will display as a simple list of records rather than organized results. # Order The Order section controls how your report results are sorted. Click **Add Order** to open the ordering options. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/GdbeRLbascEkVeFShl8i4_image.png) Each order is made up of the following: - **Order Table:** The table the column belongs to - This is automatically set based on your report and cannot be changed - **Order Column Name:** The field you want to sort by - Example: student\_name, current\_program\_name, created\_date\_time - **Order Column Function (optional):** Applies a function to the column (advanced use) - In most cases, this can be left as **None** - **Order Direction (required):** Determines how the results are sorted - **Ascending:** A → Z, lowest → highest - **Descending:** Z → A, highest → lowest **For example, **to sort students alphabetically: - **Order Column Name:** student\_name - **Order Direction:** Ascending This will display students in alphabetical order. # Columns The Columns section controls which data appears in your report and in what order. To add columns, simply check the boxes next to the fields you want. Selected columns will appear in the **Selected Columns** area below. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/LfSLqZAYIxuevahWTzPKT_image.png) You can then: - **Reorder columns:** Drag and drop within the Selected Columns list - **Edit a column:** Click the edit icon (pencil) - **Remove a column:** Uncheck it from the list When editing a column you have selected, the following options are available: ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/e_JApTDZjg2r1ZB2MGVsd_image.png) - **Column Header:** The name that will appear at the top of the column in your report. You can rename this to be more user-friendly (e.g., “Student Name” instead of student\_name) - **Column Function (optional):** Applies a function to the column (advanced use). In most cases, this can be left as **None** - **Group Aggregate (optional):** Used when your report includes grouping. Lets you summarize data (e.g., count, sum, average). Only needed for grouped or more advanced reports # Preview The Preview section lets you test your report and review the results before saving it. Click **Preview** to generate the report. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/-MTlGnqNDTy-G87D2-_9Y_image.png) - **Generated Query:** - Shows the SQL query being built behind the scenes - This is mainly for advanced users or troubleshooting - **Preview Results:** - Displays the first 10 rows of your report - Lets you confirm your columns, filters, and data are correct - **Report Parameters (if applicable):** - If your report uses parameters, you’ll be prompted to enter them before previewing - If none are set, this section will remain empty Once you’re satisfied with the results, click **Create Report** to save it and make it available in the Reports section. # Create Report After previewing your results, click **Create Report** to save and finalize your report. This will open a form where you can configure how the report is saved and accessed. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/zJ8ZQJKdjAFgfBBZ_HoTL_image.png) - **Report Name (required):** The name of your report as it will appear in the Reports section - **Description:** Optional notes about what the report is for - **Page Orientation:** Choose how the report is formatted when exported (Portrait or Landscape) - **Output Options:** Select which formats the report can be exported as (PDF, CSV, XML, TXT) - **Stretch With Overflow:** Automatically expands row height to fit content. Typically left enabled (disable only for CSV-only reports) - **Read Only Access / Read & Update Access:** Controls which users or roles can view or modify the report. Can be left as default if not needed - **Location Access:** Restricts which locations can access the report Once everything is set, click **Create Report** to save it. Your report will now appear in the [ Home / Reports / Institution Custom ](docId\:lvAkEuYLyU4OJzOzIhd7U)section and can be run like any other report. ![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/6LvsnjVNpjNxswCvuWaah_image.png) # Legacy Tables The Report Builder is designed to use Data Warehouse tables. Legacy tables may still appear as a Data Source option temporarily, but they are being phased out. Existing reports that use legacy tables will continue to work, but new reports should be built using Data Warehouse tables.