### Ed-Fi Getting Started Guide and Configuration Source: https://support.aeries.com/support/solutions/14000072219 A guide to getting started with Ed-Fi, including initial configuration and understanding the Code Mappings tab. -------------------------------- ### Server Setup Tasks for Aeries Source: https://support.aeries.com/support/solutions/articles/14000108281-installing-aeries-and-reporting This describes the essential server setup tasks required for Aeries installation, including checking and adding server roles and features. It also notes specific font requirements for the Reporting Service. ```text Server Setup Tasks: * Check and/or add server roles and services: * Web Server * ASP.NET * .NET Extensibility * Static Content Compression * Dynamic Content Compression * Check and/or add server features: * Recent .NET Framework * WCF Services (all sub features) * Message Queuing * HTTP Support (optional) NOTE: A separate Aeries Reporting server does not require IIS to perform the Aeries Reporting task, however, it does need a current .NET Framework. The server hosting the Aeries Reporting Service will need the **RSWIDE39.TTF** and **Wingdings2.TTF** fonts installed to produce barcodes and checkboxes on certain print jobs. Minimally Microsoft .NET Framework 4.8 should be installed on older servers if not already present. You may install newer .NET frameworks as they come available ``` -------------------------------- ### Initial Configuration for ParentSquare in Aeries Source: https://support.aeries.com/support/solutions/folders/14000115552 This guide covers the initial setup for ParentSquare within Aeries, including API security, SAML configuration, service provider setup, and user permissions for notifications. ```ParentSquare Initial Configuration API Security Enable ParentSquare SAML Configuration Add SAML Service Provider Grant User/Group Permissions User Group Security Notification Ty... ``` -------------------------------- ### Pagination Support Example Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Demonstrates how to paginate results for various API endpoints by including 'StartingRecord' and 'EndingRecord' query string parameters. ```REST GET /api/v5/schools/{SchoolCode}/gpas?StartingRecord=10&EndingRecord=20 ``` -------------------------------- ### Aeries SAML Configuration - Service Provider Setup Source: https://support.aeries.com/support/solutions/articles/14000105404-saml-idp-in-aeries This covers the setup of Service Providers within Aeries for Single Sign-On (SSO). It includes options for importing metadata from a URL or manually entering details, and configuring various SSO-related settings. ```powershell 1. Select 'Add' in the 'Service Providers' bar. 2. If metadata is online, select 'Import MetaData' and enter the metadata URL. 3. Populate fields manually if metadata is not imported. 4. Configure settings like 'Allow Aeries to Initiate SSO?', 'Sign SAML Response?', 'Sign Assertion?', 'Require Signed Authn Request?', and 'Disabled?' as needed for the Service Provider. ``` -------------------------------- ### Get Bell Schedule API Example Source: https://support.aeries.com/support/solutions/articles/14000113682-aeries-api-school-related-end-points This snippet shows an example JSON response for the Aeries API endpoint that retrieves bell schedule information for a specific school. It details the structure of the data returned, including school code, period, start time, and end time. ```JSON [ { "SchoolCode": 994, "Period": "0", "StartTime": "1905-12-30T07:05:00", "EndTime": "1905-12-30T07:55:00", "CalendarDate": null }, { "SchoolCode": 994, "Period": "1", "StartTime": "1905-12-30T08:00:00", "EndTime": "1905-12-30T08:50:00", "CalendarDate": null }, { "SchoolCode": 994, "Period": "2", "StartTime": "1905-12-30T08:55:00", "EndTime": "1905-12-30T09:45:00", "CalendarDate": null }, { "SchoolCode": 994, "Period": "3", "StartTime": "1905-12-30T10:05:00", "EndTime": "1905-12-30T10:55:00", "CalendarDate": null }, { "SchoolCode": 994, "Period": "4", "StartTime": "1905-12-30T11:00:00", "EndTime": "1905-12-30T11:50:00", "CalendarDate": null } ``` -------------------------------- ### OneRoster API: Setup Source: https://support.aeries.com/support/solutions/14000072378 This documentation provides instructions on setting up the OneRoster API integration. It covers the necessary steps to enable and configure the API for data exchange. ```API Configuration 1. Obtain API credentials (Client ID, Client Secret). 2. Configure the OneRoster API endpoint URL in Aeries. 3. Set up authentication methods (e.g., OAuth 2.0). ``` -------------------------------- ### Setup Disposition Codes for Suspensions Source: https://support.aeries.com/support/solutions/articles/14000070182-assertive-discipline-and-suspension-letter-setup This guide explains how to set up Disposition (DS) codes, which represent penalties or consequences for student behavior. It details entering these codes in the DSP table, including the requirement that suspension codes must start with 'SUS' for the system to recognize them for printing suspension letters. ```Aeries Support All Disposition (DS) codes will be set up in the DSP table and should contain all penalties or consequences. The disposition codes can also be sorted and can be translated into up to six languages. Disposition Suspension codes (DSP.DS) need to start with letters of "SUS" for the Suspension letters to print the total # of days. There can be additional characters after "SUS, but they must start with those characters for the system to recognize what they represent ``` -------------------------------- ### List Civil Rights Options in Aeries Query Source: https://support.aeries.com/support/solutions/articles/14000139460-civil-rights-setup-using-query-to-review-civil-rights-set-up-options This query retrieves all entries from the District Options (DPT) table where the name (NM) field starts with 'CVR'. This is useful for getting a comprehensive list of Civil Rights related configurations. ```Aeries Query LIST DPT IF NM : CVR ``` -------------------------------- ### Aeries API: Quick Reference Guide Source: https://support.aeries.com/support/solutions/14000072378 This provides a concise overview of the Aeries API, including common endpoints, authentication methods, and basic usage examples for quick reference. ```API Usage Summary Base URL: https://api.aeries.net/v2/ Authentication: OAuth 2.0 Common Endpoints: - /students - /courses - /teachers ``` -------------------------------- ### Install and Log in to Aeries EM2 Source: https://support.aeries.com/support/solutions/articles/14000116143-aeries-em2-installing-and-logging-in-for-the-first-time Instructions for installing the Aeries EM2 app from the AppStore or PlayStore and logging in for the first time. This includes navigating the welcome screen, district search, school selection, and data caching. ```English Search for **Aeries EM2** in either the AppStore (for an iOS device) or PlayStore (for and Android device). Download and install the app to the device. When accessing the app for the first time a **Welcome** screen displays explaining that Aeries EM2 is not intended for use by teachers, students or parents. Tap on **[Get Started]** to connect the app to your district. The **District Search** screen comes up. In the upper right corner there is a circle with the state abbreviation where you are currently located. In the below example the state is California. Tapping on the state will toggle the search between California and Texas school districts. Type the name of the school district and tap on the search icon in the keyboard area. A list of districts will come up based on what was entered in the search criteria and the state. Tap on your school district. More detailed information about the school district is displayed as a means to confirm that the correct school district has been selected. Tap on the **Select This District** button to select the school district. Once the school district is selected the app will proceed to the login screen. Log into Aeries EM2 using your Aeries user name and password. The**Eye Icon** to the right of the password can be used to temporarily display the password to confirm that you have entered it correctly. Tap on the **Login** button. If your district uses Google Authentication, you can use the **Sign in with Google** button to log in. After logging in for the first time Aeries EM2 will require you to select the schools that you want to have access to. Tap on the **Continue** button to select the schools. The schools that the logged in user has permission to view will display in the **Select Schools** screen. Select one or more schools to set up and tap on the **Continue** button. Next the user has the opportunity to download and cache the student data. The **Cache Settings** screen will display the areas that the user has Read permission to. By default all areas are selected. The user can de-select any tables they do not want to download and then tap on the **DOWNLOAD** button to begin the process, or they can **SKIP** the download altogether. When downloading data the EM2 app will update the screen with **Done** as each dataset is downloaded. Tap on the **Continue** button when all of the datasets have been downloaded. You will be directed to the **Student Search** screen. ``` -------------------------------- ### Access Query IF Examples Source: https://support.aeries.com/support/solutions/articles/14000081422-advanced-query Demonstrates practical examples of Access Query IF statements that can be used in Aeries programs like Class Roster Setup. These examples show how to filter data based on specific conditions using operators like '<>' and LIKE. ```Access SQL TN <> 605 - Print all rosters except teacher number 605 TE LIKE "A*" - Print rosters for all teachers whose last name starts with “A” TE NOT LIKE "A*" - Print rosters for all teachers whose last names does NOT start with “A”. AD LIKE "*Alliance*" - In Student Directory by Name for all student’s that have Alliance in their Address. ``` -------------------------------- ### Get Student Groups API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves student group information. Use 'all' for {SchoolCode} to get data for all schools, or a numeric school code for a specific school. ```HTTP GET /api/v5/schools/{SchoolCode}/StudentGroups ``` -------------------------------- ### Install Aeries and Reporting Service Source: https://support.aeries.com/support/solutions/articles/14000108281-installing-aeries-and-reporting This section outlines the steps to install Aeries and the Reporting engine on a web server. It requires logging in to download necessary files from the Aeries website. ```text Use the following steps to install Aeries and the Reporting engine on your web server. You’ll need to login and download the following files from our website at www.aeries.com: ``` -------------------------------- ### OneRoster API Introduction and Setup Source: https://support.aeries.com/support/solutions/folders/14000115099 Provides an overview of the Aeries SIS OneRoster API, which adheres to the OneRoster® 1.1 specification for secure data exchange. It also covers the initial setup process for utilizing the API. ```English Aeries SIS has developed an API based on the OneRoster® 1.1 specification. OneRoster is a standard for securely exchanging data between student information systems (SIS) and other educational applications. ``` ```English Aeries SIS supports the OneRoster® 1.1 specification. OneRoster is a standard for securely exchanging data between student information systems (SIS) and other educational applications. ``` -------------------------------- ### Add Course Request Packet Source: https://support.aeries.com/support/solutions/articles/14000091309-quick-start-guide-for-alt-ed-scheduling This process involves navigating to the 'Classes' page, clicking 'Edit', confirming the start date, and then clicking the 'CrsReqPack' button to add a new Course Request Packet. ```text Pages > Classes Edit button Start Date CrsReqPack button New Course Request Packet ``` -------------------------------- ### Run Basic STU Table Query Source: https://support.aeries.com/support/solutions/articles/14000081220-beginning-query This example demonstrates how to run a query to retrieve all data from the 'STU' (Student) table in Aeries. It shows the basic syntax for selecting a table and executing the query. ```Aeries Query Language RUN ``` -------------------------------- ### Set Up Bell Schedules in Aeries Source: https://support.aeries.com/support/solutions/articles/14000156351-flex-scheduling-process-guide-and-checklist Guidance on setting up bell schedules within Aeries, ensuring they are in place for Flex Scheduling. This involves listing necessary bell schedules in BSD.TY, adding types to the Bell Scheduler page, and using the Bell Schedule Details form for any missing schedules. ```Aeries Scheduling Ensure that every needed bell schedule is listed in BSD.TY. Add the Types to the Bell Scheduler page. Ensure each Bell Schedule used at the school is listed on the Bell Scheduler. Add any missing Bell Schedules using the Bell Schedule Details form. ``` -------------------------------- ### Get Course Information (JSON Example) Source: https://support.aeries.com/support/solutions/articles/14000113686-aeries-api-scheduling-related-end-points This snippet shows an example of the JSON response when retrieving course information from the Aeries API v5. It includes various fields related to course details, grading, and administrative information. ```json { "VocationalEducationSubjectAreaCode": "", "VocationalEducationCourseLevelCode": "", "CourseLevelCode": "", "CourseTypeCode": "", "NextCourse": "", "TermSequence": 0, "YearSequence": 0, "TraditionalGender": "", "NCLBCoreCode": "N", "NCLBCoreArea1Code": "", "NCLBCoreArea2Code": "", "ContentGroupCode": "", "NCESCode": "", "CIPCode": "", "BoardAdoptionDate": null, "LastRevisionDate": null, "RevisionTypeCode": "", "InactiveDate": null, "AcademicWeight": 0, "MeetsAlgebraIRequirement": false, "AlgebraICreditRequired": 0.0000, "ServiceIDCode": "", "PopulationServedCode": "", "ClassTypeCode": "", "CourseSequenceCode": "", "NonCampusBasedInstructionCode": "", "OnRampsDualEnrollmentIndicator": "", "IncludeForExtracurricularActivityEligibilityIndicator": "", "HoursForCompletion": 0.0000, "CostOfCourse": 0.0000, "ContentSubcategoryCode": "", "StandardsGradeRangeCode": "", "ContentStandardsAlignmentCode": "", "CharterNonCoreIndicator": "", "AdvancedCourseStateCode": "", "CollegeStateCourseCode": "", "MiddleSchoolCoreIndicator": "", "CorrespondenceLanguageCode1": "", "TitleForLanguage1": "", "CorrespondenceLanguageCode2": "", "TitleForLanguage2": "", "CorrespondenceLanguageCode3": "", "TitleForLanguage3": "", "CorrespondenceLanguageCode4": "", "TitleForLanguage4": "", "CorrespondenceLanguageCode5": "", "TitleForLanguage5": "", "CorrespondenceLanguageCode6": "", "TitleForLanguage6": "", "UserCode1": "", "UserCode2": "", "UserCode3": "", "UserCode4": "", "UserCode5": "", "UserCode6": "", "UserCode7": "", "UserCode8": "", "ID": "0001", "Title": "No Zero Period", "LongDescription": "", "Notes": "", "ContentDescription": "", "NonAcademicOrHonorsCode": "", "SubjectArea1Code": "", "SubjectArea2Code": "", "SubjectArea3Code": "", "DepartmentCode": "Z", "StateCourseCode": "6012", "CSFCourseList": "", "CollegePrepIndicatorCode": "", "CreditDefault": 0.0000, "CreditMax": 0.0000, "TermTypeCode": "Y", "LowGrade": 9, "HighGrade": 12, "CSU_SubjectAreaCode": "", "CSU_Rule_CanBeAnElective": "", "CSU_Rule_HonorsCode": "", "CSU_Rule_ValidationLevelCode": "", "UC_SubjectAreaCode": "", "UC_Rule_CanBeAnElective": "", "UC_Rule_HonorsCode": "", "UC_Rule_ValidationLevelCode": "0", "TeacherAideIndicator": false, "PhysicalEducationIndicator": false, "InactiveStatusCode": "", "PrerequisiteCourse": "", "AlternateCourse": "", "DefaultMaxStudents": 0, "NextYearInactiveStatusCode": "" } ``` -------------------------------- ### Get School Calendar API Example Source: https://support.aeries.com/support/solutions/articles/14000113682-aeries-api-school-related-end-points This snippet shows an example JSON response from the Aeries API for retrieving school calendar data. It includes details like CalendarDate, HolidayCode, and attendance figures for a specific school. ```json { "TrackHolidays": [], "SchoolCode": 994, "CalendarDayNumber": 130, "CalendarDate": "2021-01-01T00:00:00", "HolidayCode": "#", "AttendanceMonth": 7, "TotalApportionment": 0, "TotalEnrollment": 0, "PeriodBlockPattern": "", "ABDay": "", "AttendanceMonthLocked": false }, { "TrackHolidays": [], "SchoolCode": 994, "CalendarDayNumber": 131, "CalendarDate": "2021-01-04T00:00:00", "HolidayCode": "", "AttendanceMonth": 7, "TotalApportionment": 0, "TotalEnrollment": 0, "PeriodBlockPattern": "", "ABDay": "", "AttendanceMonthLocked": false }, { "TrackHolidays": [], "SchoolCode": 994, "CalendarDayNumber": 132, "CalendarDate": "2021-01-05T00:00:00", "HolidayCode": "", "AttendanceMonth": 7, "TotalApportionment": 0, "TotalEnrollment": 0, "PeriodBlockPattern": "", "ABDay": "", "AttendanceMonthLocked": false } ``` -------------------------------- ### Create Aeries Admin User and District Source: https://support.aeries.com/support/solutions/articles/14000108281-installing-aeries-and-reporting This SQL script creates an administrative user ('admin') with the password 'welcome' and a 'District' location. It's used for initial setup in the Aeries Web Version. ```SQL INSERT INTO UGN ([UID], UN, PW, SY, TY, UTY, HT, EM) VALUES (1, 'admin', 'welcome', 'AERIES.NET', 1, 'admin', -1, 'someone@example.com') GO INSERT INTO LOC ([SC], [NM]) VALUES (0, 'District') GO ``` -------------------------------- ### Configure Scheduling Setup for Flex Scheduling Source: https://support.aeries.com/support/solutions/articles/14000135113-converting-from-elementary-to-flex-for-next-year This describes the process of configuring the 'Scheduling Setup' page within Aeries for elementary schools transitioning to Flex Scheduling. It includes enabling specific options and the implications for related tables and settings. ```Aeries Configuration Navigate to: Scheduling Process > Configurations > Scheduling Setup Enable Option: Use Flex Scheduling for Next Year Enable Option: Track Primary Classes for Students for Next Year (if applicable) Action: Select 'Blank out the SSS table' Action: Select 'Blank out the SMS table' Process: Click 'Initialize Scheduling' button. Notification: An email will be sent upon completion. ``` -------------------------------- ### Get Teacher Information API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves information about a teacher. The TeacherNumber parameter is optional. ```REST GET /api/v5/schools/{SchoolCode}/teachers/{TeacherNumber} ``` -------------------------------- ### Get School Graduation Requirements API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves graduation requirements for a specific school. ```REST GET /api/v5/schools/{SchoolCode}/GraduationRequirements ``` -------------------------------- ### Aeries Deep Link Examples Source: https://support.aeries.com/support/solutions/articles/14000077402-deep-linking-to-aeries-pages Provides practical examples of Aeries deep links for various scenarios, demonstrating how to link to specific student profiles and utilize different parameter combinations. ```URL https://demo.aeries.net/aeries/Helpers/SetStudentAndRedirect.aspx?ID=99400001&DU=StudentProfile.aspx ``` ```URL https://demo.aeries.net/aeries/Helpers/SetStudentAndRedirect.aspx?SC=994&SN=1&DU=StudentProfile.aspx ``` ```URL https://demo.aeries.net/aeries/Helpers/SetStudentAndRedirect.aspx?ID=99400001 ``` -------------------------------- ### Get Final Mark Ranges API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves the final mark ranges configured for a gradebook. ```REST GET /api/v3/gradebooks/{GradebookNumber}/FinalMarks ``` -------------------------------- ### Get Assignments API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves assignment information within a gradebook, by GradebookNumber, AssignmentNumber, or UniqueID. ```REST GET /api/v3/gradebooks/{GradebookNumber}/assignments ``` ```REST GET /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber} ``` ```REST GET /api/v3/gradebooks/Assignments/{UniqueID} ``` -------------------------------- ### Introduction to Power Automate for Automation Source: https://support.aeries.com/support/solutions/folders/14000117997/page/12 This session offers an introduction to Power Automate, a tool for automation. It is tailored for beginners eager to start automating tasks. ```English Session 1004 - Power Automate Session Description Unlock the potential of automation with our introductory session on Power Automate! This session is tailored for beginners eager to str... ``` -------------------------------- ### Aeries Scheduling Setup Navigation Source: https://support.aeries.com/support/solutions/articles/14000135006-elementary-primary-class-scheduling-scheduling-setup Provides instructions on how to navigate to the Scheduling Setup page within the Aeries system. It outlines two methods for accessing the configuration settings. ```text Navigate to**Student Data > Demographics** ``` ```text Filter **Pages** by "Scheduling Setup" or navigate to **Scheduling Process > Configurations > Scheduling Setup. ** ``` -------------------------------- ### Get Section Information API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves information about a specific section. The SectionNumber parameter is optional. ```REST GET /api/v5/schools/{SchoolCode}/sections/{SectionNumber} ``` -------------------------------- ### Get Course Information API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves information about a specific course. The CourseID parameter is optional. ```REST GET /api/v5/courses/{CourseID} ``` -------------------------------- ### Convert to Flex Scheduling Process Source: https://support.aeries.com/support/solutions/articles/14000069816-scheduling-setup This section details the steps and conditions for converting to Flex Scheduling. It covers prerequisites like feature flag enablement, school option selections, and data requirements (SMS records). It also explains date validations for Class Calendar records and the backup process before conversion. ```English The **Convert to Flex Scheduling** section will display for districts under the following conditions: If scheduling for next year: * The Feature Flag for Flex Scheduling has been enabled * The school has selected the **Scheduling Setup** option: **Scheduling students into classes for the next school year, using their grade level next year** (not the **Use Flex Scheduling for Next Year** option) * The school has at least one **SMS** record (the**Copy current master schedule (MST) table to new SMS table process** can accomplish this) If scheduling for the current year after the New Year Rollover: * The Feature Flag for Flex Scheduling has been enabled * The **School Options > Scheduling Type** field is NOT set to **Flexible** * The school has the following **Scheduling Setup** option selected: **Scheduling students into classes for the current school year** * **MST** records cannot exist prior to using this conversion process The **Convert to Flex Scheduling** section has a **Class Calendar Start Date** and a **Class Calendar End Date**. These dates require the user to select a **Start Date** after July 1 of the next academic year, and will be used to create **Class Calendar** records for the next academic year**.** The **Class Calendar End Date** will auto-populate with a 6/30 end date by default. This can be changed to the appropriate last day of school of the following year. Warning messages display if the start or end dates do not fall within the next academic year and the Convert to Flex Scheduling button is clicked. If **Next Year Start Date (LOC.NSD)** is populated on the **School Options** page and it is after the last day of the current school year, then the **Class Calendar Start Date** will be auto-populated as the default **Start Date** value. If Next Year Start Date **(LOC.NSD)** is blank, then the **Start Date** field will be blank. The dates cannot fall on a Saturday or a Sunday. If the start date entered is not a Monday and the **Convert to Flex Scheduling** button is initialized, the process will successfully create the Class Calendar records and upon completion, the Start Date that was entered will be selected. For example: If the first day of school is a Tuesday 8/20/2024 and the conversion process is run, the Class Calendar will have the date 8/20/2024 selected. **NOTE:** After the rollover, the **Class Calendars** can be adjusted in the new year with different dates for the full school year. If scheduling in the new year database after rollover but prior to the start of school, the date picker will default to the first Monday of school if the **DAY** table is populated. Otherwise, it will default to the next Monday after today (or today, if today is Monday). After a sample date is entered, clicking the **Convert to Flex Scheduling** button will display a **Yes/No** confirmation dialog. After clicking **Yes** , the date picker will be validated. It must not be blank, and it must be a Monday. If not, a red alert text will display with the proper message. If validation is successful, the process to **convert to Flex SMS** will begin by first performing a scheduling backup. This is the same process as if the backup was done using the **Backup and Restore Scheduling Results** page. The Description will be labeled as **Pre-Conversion to Flex Scheduling**. ``` -------------------------------- ### Get Student Transcripts API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves student transcript information. The StudentID parameter is optional. ```REST GET /api/v5/schools/{SchoolCode}/Transcript/{StudentID} ``` -------------------------------- ### Download Master Schedule Building Theory Documentation (PDF) Source: https://support.aeries.com/support/solutions/articles/14000079379-session-320-master-schedule-building-theory Provides links to download PDF documentation related to Session 320: Master Schedule Building Theory. Includes the main session document and an Aeries Compatibility document. ```N/A pdf 320 Master S... (252 KB) ``` ```N/A pdf 320 AeriesCo... (2.3 MB) ``` -------------------------------- ### Get Student GPA API Source: https://support.aeries.com/support/solutions/articles/14000070569-api-quick-reference-guide Retrieves Student GPA information. The StudentID parameter is optional. ```REST GET /api/v5/schools/{SchoolCode}/gpas/{StudentID} ```