# Newsroom and Compass Data Integration ## How the Integration Works PortalHQ connects to Compass through the Compass API, using the school's Compass site address and an API key the school configures in Compass. Each night, PortalHQ retrieves current students, their parents and carers, and staff from Compass. Newsroom by PortalHQ then refreshes its contact lists from that data, so families and staff who join or leave Compass flow through to mailing lists automatically, with no manual uploads required. Audiences can be built from any of the fields listed below (for example, all parents of Year 7 students, or all parents in a particular form class), and those lists remain current as Compass records change. | Step | Frequency | What happens | |---|---|---| | Compass to PortalHQ | Nightly, around 10:45pm AEST (11:45pm during daylight saving) | Current students, parents and carers, and staff are read from Compass and updated in PortalHQ. Students, parents and staff no longer returned by Compass are deactivated. | | PortalHQ to Newsroom by PortalHQ contacts | Nightly | Newsroom by PortalHQ contacts and dynamic mailing lists are refreshed from the synced records. Families and staff who have left are removed. | ## Current Families (Parents and Carers) Parent and carer details are drawn from the Compass parent records (API method People/GetParents). Each parent is linked to their children using the Compass adult-to-student relationships (API method Person/GetAdultToStudentRelationships), which also supplies the relationship type, such as Mother, Father or Guardian. Only parents and carers linked to at least one current student are included. When a family's last child leaves the school, that family is removed from the current parent audience automatically. A parent or carer without an email address in Compass is not added. Where two carers share one email address in Compass, they share a single Newsroom by PortalHQ contact. ##### Fields retrieved for each parent or carer | PortalHQ field | Source in Compass | Notes | |---|---|---| | Title | Parent record: title | | | First name | Parent record: firstName | | | Surname | Parent record: lastName | | | Email address | Parent record: emailAddress | Parents and carers without an email address are skipped. | | Mobile | Parent record: mobileNumber | | | Relationship | Adult-to-student relationship: typeAdultToStudent | Grouped as Mother, Father, Step-mother, Step-father, Guardian, Carer or Other. Grandparents are grouped as Carer. | | Do not contact | Parent record: contactable | A parent marked as not contactable in Compass is set to unsubscribed in Newsroom by PortalHQ. | ##### Fields inherited from their children (for targeting) | PortalHQ field | Source | |---|---| | Year level(s) | Each current child's year level | | Form class(es) | Each current child's form group | ## Current Students Student details are drawn from the Compass student records (API method People/GetStudents). Only students with a status of Active in Compass are included. Students who have left, and future students who have not yet started, are not brought across. | PortalHQ field | Source in Compass | |---|---| | First name | Student record: firstName | | Surname | Student record: lastName | | Email address | Student details: organisationUserEmail (the school email address). If that is blank, the student record's emailAddress is used. | | Student code | Student record: importIdentifiers (the student import identifier) | | Year level | Current organisation milestone: yearLevel | | Form class | Current organisation milestone: groupA | ## Staff Staff details are drawn from the Compass staff records (API method People/GetStaff). Only staff with a status of Active in Compass are included, and staff without an email address are skipped. When a staff member is no longer returned by Compass, they are removed from the staff audience. | PortalHQ field | Source in Compass | |---|---| | First name | Staff record: firstName | | Surname | Staff record: lastName | | Email address | Staff details: organisationUserEmail (the school email address). If that is blank, the staff record's emailAddress is used. | | Mobile | Staff record: mobileNumber | | Staff code | Staff record: importIdentifiers (the staff import identifier) | A staff member who is also a parent at the school keeps a single contact, which appears in both the staff and the current parent audiences. ## Alumni Alumni are not retrieved from Compass by the automatic sync, which reads current students, families and staff only. Instead, alumni are loaded into Newsroom by PortalHQ from a spreadsheet export, and each contact is tagged as alumni with a Class Of year so that cohorts can be targeted (for example, a Class of 2016 reunion). The import can be repeated whenever the school's alumni records are updated. Schools that maintain alumni records in another system, such as a CRM or foundation database, can also push contacts into Newsroom by PortalHQ through the PortalHQ API. | Newsroom by PortalHQ field | Spreadsheet column | |---|---| | First name | Given name | | Surname | Surname | | Email address | Email (rows without an email are skipped) | | Class Of | Graduating year | | Is Alumni | Set automatically on import | ## Privacy and Preferences - Newsroom by PortalHQ only reads contact data from Compass. It never writes contact details back to Compass. - A parent or carer marked as not contactable in Compass is set to unsubscribed in Newsroom by PortalHQ on every refresh. Clearing that flag in Compass does not re-subscribe them automatically. - Contacts who unsubscribe in Newsroom by PortalHQ remain unsubscribed. A subsequent sync does not re-subscribe them. - Every email sent from Newsroom by PortalHQ includes an unsubscribe link. ## Enquiries For any queries regarding this integration, please contact TeamHQ at [support@teamhq.com.au](mailto:support@teamhq.com.au) or +61 2 8387 7321.