Use the Interface Settings window to configure Synergetic to interface with external systems including:
- myEdOnline Learning Management System
- Queensland Curriculum and Assessment Authority (QCAA), a statutory body of the Queensland Government
- Quick Address Systems (QAS), a real-time address validation tool
- Systems Interoperability Framework (SIF), an open, industry-supported standard used to link together data systems within the school sector.
Important: You must have access to the SYS|Interface Settings security resource to access the Interface Settings window. See Group_User Security Maintenance - Groups View.
To open the SynWeb Settings window:
- Click System > Interface Settings.
The Interface Settings window is displayed..png?version=1&modificationDate=1559322284750&cacheVersion=1&api=v2&width=756&height=250)
- Select the external system from the drop-down list.
.png?version=1&modificationDate=1559322431620&cacheVersion=1&api=v2&width=756&height=250)
The Interface Settings window is displayed..png?version=1&modificationDate=1559733418817&cacheVersion=1&api=v2&width=756&height=354)
Interface Settings window key fields and buttons
myEdOnline settings
.png?version=1&modificationDate=1559752345497&cacheVersion=1&api=v2&width=756&height=384)
Field | Description |
|---|---|
| myEdOnline School Code | Used to define the school code supplied by myEdOnline for identifying your organisation. |
| myEdOnline URL | Used to define the myEdOnline URL |
| myEdOnline Authorisation Token | Used to generate and store the myEdOnline authorisation token. |
QAS key settings
.png?version=1&modificationDate=1559752688683&cacheVersion=1&api=v2&width=756&height=496)
Base Address Validation Settings
Field | Description |
|---|---|
| Address Validation Confirmation Alert | Determines whether confirmation messages are displayed when addresses are validated. Note: This is the same functionality as the AddressValidation:ConfirmOnValidation configuration setting. See AddressValidation_ConfirmOnValidation configuration setting. |
| dAddress Validation is Enabled | Determines whether address validation is enabled. Note: This is the same functionality as the AddressValidation:EnabledFlag configuration setting. See AddressValidation_EnabledFlag configuration setting. |
| Address Validation is Enabled for Community Portal | Determines whether address validation is enabled for the Community portal. Note: This is the same functionality as the Module:CommunityPortal configuration setting. See Module_CommunityPortal configuration setting. |
| Address Validation is Enabled for Online Applications | Determines whether address validation is enabled for Online applications. Note: This is the same functionality as the Module:OnlineApplications configuration setting. See Module_OnlineApplications configuration setting. |
| Address Validation is Enabled for SynWeb | Determines whether address validation is enabled for SynWeb. Note: This is the same functionality as the Module:SynWeb configuration setting. See Module_SynWeb configuration setting. |
| Address Validation is Enabled for Windows | Determines whether address validation is enabled for Windows. Note: This is the same functionality as the Module:Windows configuration setting. See Module_Windows configuration setting. |
Address Validation Provider settings
Field | Description |
|---|---|
| Address Validation Provider Authorisation Token | Used to define the authorisation token of the address validation provider. Note: This is the same functionality as the Provider:AuthToken configuration setting. See Provider_AuthToken configuration setting. |
| Address Validation Provider Name | Used to define the name of the address validation provider. Note: This is the same functionality as the Provider:Name configuration setting. See Provider_Name configuration setting. |
| Address Validation Provider Password | Used to define the password of the address validation provider. Note: This is the same functionality as the Provider:Password configuration setting. See Provider_Password configuration setting. |
| Address Validation Provider Result Limit | Used to define the number of results returned from the address validation search. Note: This is the same functionality as the Provider:ResultLimit configuration setting. See Provider_ResultLimit configuration setting. |
| Address Validation Provider Timeout | Used to define the amount of time in milliseconds before the address validation search is aborted. Note: This is the same functionality as the Provider:Timeout configuration setting. See Provider_Timeout configuration setting. |
| Address Validation Provider URL | Used to define the URL of the address validation provider. Note: This is the same functionality as the Provider:URL configuration setting. See Provider_URL configuration setting. |
| Address Validation Provider UserName | Used to define the username of the address validation provider. Note: This is the same functionality as the Provider:AuthToken configuration setting. See Provider_Username configuration setting. |
QAS Versions settings
| Field | Description | |
|---|---|---|
| Outbound | Use the outbound lookup tables to map outbound Synergetic lookup table values to QAS values. | |
| Outbound lookup tables | ||
| luCountry | See luCountry lookup table. | |
SIF settings
.png?version=1&modificationDate=1559752785950&cacheVersion=1&api=v2&width=756&height=479)
Base SIF settings
Field | Description |
|---|---|
| Enable the SIF Consumer Service | Used to determine whether Synergetic can request data from other applications in SIF format. |
| Default Data Model Version | Used to define the data model version used if no version is provided by the consumer application when requests are made to the SIF Provider Service. |
| Maximum Record to Retrieve | Used to define the maximum number of records to retrieve in a single request. |
| SIF Provider Service | Used to define SIF Provider Service settings. See SIF Provider Service settings (below). |
| SIF Architecture | Used to define the system architecture used for SIF requests. |
| SIF is Enabled | Determines whether SIF is enabled. Note: This is the same functionality as the SIF:EnabledFlag configuration setting. See SIF_EnabledFlag configuration setting. |
SIF Provider Service settings
Field | Description | |
|---|---|---|
| Person Picture | Used to provide a picture of a student, student contact or a staff member. Note: This field is not editable. | |
| Enable the SIF Provider Service | Used to determine whether the SIF Provider Service is enabled to allow other applications to request data in the SIF format. | |
| SchoolInfo | View school information settings. | |
| SchoolInfo Settings | ||
| Enable SchoolInfo | Used to determine whether details about your organisation and its campuses can be provided to other applications. | |
| StaffAssignment | View staff assignment (job position) settings. | |
| StaffAssignment settings | ||
| Enable StaffAssignment | Used to determine whether details about staff member job positions within your organisation can be provided to other applications. Note: This does not provide personal details. | |
| StaffPersonal | View personal settings for staff members. | |
| StaffPersonal settings | ||
| Full Name for StaffPersonal | Used to define the field used to populate requests for staff member names. You can select:
For information about staff member personal details, see Staff Maintenance - Personal tab. | |
| Enable StaffPersonal | Used to determine whether personal details of staff members employed at your organisation can be provided to other applications. | |
| StudentAttendanceTimeList | View student attendance time settings. | |
| StudentAttendanceTimeList settings | ||
| Enable StudentAttendanceTimeList | Used to determine whether more detailed information about student attendance throughout the day can be provided to other applications. | |
| StudentContactPersonal | View student contact personal settings. | |
| StudentContactPersonal settings | ||
| Full Name for StudentContactPersonal | Used to define the field used to populate requests for student contact names. You can select:
| |
| EnableStudentContactPersonal | Used to determine whether personal details of student contacts of students attending at your organisation can be provided to other applications. | |
| StudentContactRelationship | View relationship settings for student contacts. | |
| StudentContactRelationship settings | ||
| Enable StudentContactRelationship | Used to determine whether personal details of staff members employed at your organisation can be provided to other applications. | |
| StudentPersonal | View personal settings for students. | |
| StudentPersonal settings | ||
| Full Name for StudentPersonal | Used to define the field used to populate requests for students. | |
| Enable StudentPersonal | Used to determine whether details about relationships between students and student contacts can be provided to other applications. Note: This does not include personal details of the student or student contact. | |
| StudentSchoolEnrolment | View student enrolment settings. | |
| StudentSchoolEnrolment settings | ||
| Enable StudentSchoolEnrolment | Used to determine whether details about student enrolment at your organisation can be provided to other applications. | |
| TeachingGroup | View teaching group settings that relate to classes and the students and teachers involved in each class. | |
| TeachingGroup settings | ||
| Enable TeachingGroup | Used to determine whether details about classes taught at your organisation including teachers and students involved in each class can be provided to other applications. | |
School-Info settings
Field | Description | |
|---|---|---|
| Local ID | View settings related to your organisations local ID. Note: This is the CEOM number for Catholic schools. | |
| Local ID settings | ||
| Enable StudentSchoolEnrolment | See the StudentSchoolEnrolment setting. | |
| Ref ID | View settings related to your organisation's unique reference identifier. | |
| Ref ID settings | ||
| Full Name for Student Personal | See the Full Name for StudentPersonal setting. | |
| Enable StudentPersonal | See the Enable StudentPersonal setting. | |
| School Sector Type | View settings related to your organisation's school sector. For example, Non-Government. | |
| School Sector Type settings | ||
| Enable Teaching Group | See the Enable TeachingGroup setting. | |
SIF Versions settings
Field | Description | |
|---|---|---|
Inbound | Use the inbound lookup tables to map inbound SIF values to Synergetic lookup tables values. | |
Inbound lookup tables | ||
luAbsenceReason | See luAbsenceReason lookup table. | |
luAbsenceType | See luAbsenceType lookup table. | |
luGender | ||
Outbound | Use the outbound lookup tables to map outbound Synergetic lookup table values to SIF values. | |
Outbound lookup tables | ||
luAbsenceReason | ||
luAbsenceType | ||
luBoarder | ||
luCitizenshipStatus | ||
luCountry | ||
luESLProficiencyLevel | ||
luEthnicGroup | ||
luGender | ||
luImmunisationFormStatus | ||
luLanguage | ||
luMaritalStatus | ||
luOccupationPosition | ||
luQualificationLevel | ||
luRelationship | ||
luReligion | ||
luStaffCategory | ||
luState | See luState lookup table. | |
luStudentLeavingReason | ||
luStudentStatus | ||
luVisaSubClasses | ||
luYearLevel | ||