Set Up the Aeries–SIRAS Integration
This guide takes district and SIRAS staff through the complete setup, testing, approval, and production activation of the bidirectional Aeries–SIRAS integration.
| Direction | Purpose |
|---|---|
| Aeries → SIRAS | SIRAS uses the Aeries API to update approved demographic, enrollment, school, language, and contact information. |
| SIRAS → Aeries | Aeries uses its Special Ed Data Import to retrieve nightly student and service files produced by SIRAS. |
Use SIRAS SFTP Connection Settings and File Access for the current host, port, district username convention, secure credential process, manual connection test, common files, and troubleshooting.
Do not send an Aeries API Certificate/key, SFTP password, or replacement credential through ordinary email. Contact [email protected] for the approved secure exchange process.
Use the Aeries–SIRAS Integration Configuration & Approval Workbook to document contacts, options, local mappings, training results, and production approval. Do not enter credentials in the workbook.
Implementation Milestones
Plan the Integration and Assign Contacts
The district should identify:
- a Special Education administrator or SEDS Coordinator who can approve field behavior and review student records;
- an Aeries administrator or district IT contact who can create the API Certificate and configure scheduled imports;
- a CALPADS/SIS contact who can resolve enrollment, SSID, school, and identity questions; and
- the staff who should receive Aeries Special Ed Data Import completion emails.
Document the intended options, including:
- demographic updates;
- contact updates;
- creation of new SIRAS records;
- district transfer requests;
- Next School and District Enrollment Date behavior;
- 504 record processing; and
- local Student ID, SSID, school-code, and mapping exceptions.
The implementation team is identified, both data directions are documented, and local exceptions have been identified for testing.
Configure Aeries → SIRAS API Access
Follow Aeries’ current SIRAS API instructions to create an API Certificate for SIRAS. The Aeries administrator should:
- create the SIRAS API Certificate;
- grant the required read permissions;
- identify the Aeries base URL; and
- provide the Certificate/key and base URL to SIRAS through the approved secure method.
The current read areas include:
- Student Data / Student Data;
- Student Data / Student Programs / Special Programs;
- Student Data / Student Programs / Special Education;
- Student Data / Contacts; and
- Attendance / Enrollment History.
See Aeries API to SIRAS: Fields, Preferences, and Processing Rules for the available fields and configurable behavior.
Configure SIRAS → Aeries File Import
In Aeries, configure the Special Ed Data Scheduled Import using the district-specific secure connection supplied by SIRAS.
| File location | Select Secure FTP. |
| Server, port, username and password | Use the values and secure credential process in SIRAS SFTP Connection Settings and File Access. |
| Import directory | Leave blank unless SIRAS provides a district-specific directory. |
| Student filename | tableA.csv |
| Service filename | tableB.csv |
| Files to include | Include both Student and Services. |
| Schedule | Run after SIRAS has generated the nightly files. SIRAS will confirm the appropriate time. |
| Email recipients | Use current district SPED/SEDS and Aeries staff who will review the completion results. |
Aeries file-location settings showing Secure FTP, port 7472, district CDS-code username, and the legacy tableA/tableB filenames.
Wait until SIRAS has completed the initial Aeries API run and the district has reviewed the resulting SIRAS records.
Test Both Connections
Test SIRAS → Aeries file access
- Use the manual test in SIRAS SFTP Connection Settings and File Access.
- Confirm that the expected student and service files are visible.
- Confirm that Aeries can connect using the same information.
- For a new Aeries database without Special Education data, a one-time import may be used to verify credentials and completion-email delivery.
- For an existing Aeries database already populated with Special Education data, do not perform a one-time import until the implementation sequence has been reviewed.
Test Aeries → SIRAS API access
- SIRAS tests the base URL and API Certificate.
- SIRAS confirms the required endpoints and permissions.
- SIRAS confirms that the intended academic-year database is being queried.
- SIRAS runs the import in the Training environment.
| Direction | Where to review results |
|---|---|
| Aeries → SIRAS | Tools → SIRAS Admin → Scheduled Task Logs; download the latest api_import_log.csv. |
| SIRAS → Aeries | Aeries Special Ed Data Import completion email and attached student/service reports. |
Validate Results on the Training Server
Review representative records from multiple schools and several student/contact situations.
- Local Student ID and SSID behavior;
- school attending, school of residence, and district information;
- grade and school track;
- race, ethnicity, gender, language, EL status, and RFEP date;
- District Enrollment Date and Next School behavior when enabled;
- contacts and Educational Rights Holder selection;
- new-record creation and transfer requests when enabled; and
- ignored schools, inactive records, duplicates, and mapping exceptions.
Review api_import_log.csv:
- INFO identifies changes applied;
- WARNING identifies source or status differences requiring review; and
- ERROR identifies records or connections requiring correction.
Resolve mapping, contact, school, matching, and configuration issues in Training before approving Production.
Approve and Activate Production
- The district’s designated Special Education/Aeries contact approves the reviewed Training results.
- SIRAS enables the approved Aeries → SIRAS settings in Production.
- The district enables or confirms the Aeries Special Ed Data Import schedule.
- Both sides review the first Production cycles.
Review:
- approved demographic and contact changes in SIRAS;
- the Production
api_import_log.csv; - the Aeries completion email and attachments; and
- expected active and exited records in Aeries.
Both nightly directions have completed, the first results have been reviewed, and district staff know where to find the logs and support procedures.
Add Contacts to an Existing Integration
- Confirm how contacts and Educational Rights Holder status are maintained in Aeries.
- SIRAS enables contact updates on Training.
- The district reviews representative students from multiple schools and family configurations.
- SIRAS and the district resolve anomalies.
- The district approves the Training results.
- SIRAS enables contact updates in Production at the agreed transition point.
Contact testing is required. Do not enable contact replacement in Production without reviewing linked contacts, addresses, phone numbers, email addresses, ordering, and Educational Rights Holder behavior.
Maintain the Integration and Complete the Checklist
| Change | Required action |
|---|---|
| Aeries hosting or base URL changes | Provide SIRAS the new base URL and schedule an API test. |
| API Certificate/key changes | Provide the replacement securely and confirm permissions. |
| SFTP password or technical contact changes | Use SIRAS SFTP Connection Settings and File Access, rotate the credential securely, and retest. |
| School codes or district structure changes | Review mappings, ignored schools, and on-demand school identifiers. |
| Integration options change | Test revised behavior in Training before Production. |
| District changes SIS | Contact SIRAS before migration planning begins. |
Integration completion checklist
- IT/Aeries and SPED/SEDS contacts identified.
- Data directions, options, and local exceptions documented.
- API Certificate and base URL exchanged securely.
- Required API permissions granted.
- Aeries Special Ed Data Import saved with correct connection and filenames.
- District manually tested SFTP access.
- SIRAS tested the API and confirmed the academic-year database.
- Logs and completion emails generated.
- Demographics and contacts reviewed on Training.
- Multiple schools and representative records checked.
- Errors and material warnings resolved or documented.
- District approval received.
- Approved Production options and schedules enabled.
- First Production cycles reviewed.

