Use the Interface Settings window to configure Synergetic to interface with external systems including:
...
Expand |
---|
title | Click to view ACARA settings |
---|
|
|
...
Expand |
---|
title | Click to view myEdOnline settings |
---|
|
Field | Description |
---|
myEdOnline School Code | Used to define the school code supplied by myEdOnline for identifying your organisation. Note: This is the same functionality as the myEdOnline:SchoolCode configuration setting. See MyEdOnline:SchoolCode configuration setting. | myEdOnline URL | Used to store the callback endpoint used when launching MyEdOnline via Synergetic. Important: This topic is for reference purposes only. You must not change this value as it may affect how Synergetic integrates with MyEdOnline. Note: This is the same functionality as the myEdOnline:URL configuration setting. See MyEdOnline:URL configuration setting. | myEdOnline Authorisation Token | Used to generate and store the myEdOnline authorisation token. |
|
...
Expand |
---|
title | Click to view QAS settings |
---|
|
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. | Address 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 | Defines 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 | Defines 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 | Defines 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 | Defines 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 | Defines 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 | Defines 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 | Defines 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
|
...
Expand |
---|
title | Click to view SIF settings |
---|
|
Base SIF settings
Field | Description |
---|
Enable the SIF Consumer Service | Determines whether Synergetic can request data from other applications in SIF format.
| Default Data Model Version | Defines 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 | Defines the maximum number of records to retrieve in a single request. | SIF Provider Service | Display SIF Provider Service settings. See SIF Provider Service settings (below). | SIF Architecture | Defines the system architecture used for SIF requests. | SIF is Enabled | Determines whether SIF is enabled. Note: This is the same functionality as the SIF:Enable configuration setting. See SIF:Enable configuration setting. |
SIF Provider Service settings Field | Description |
---|
Person Picture | Defines the picture of a student, student contact or a staff member. Note: This field is not editable Pictures are saved in the Synergetic Photo Maintenance window. See Photo Maintenance window. | Enable the SIF Provider Service | Determines 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: - LegalFullName
- NameInternal
- NameExternal
- MailNamePrimary.
| 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:- LegalFullName
- NameInternal
- NameExternal
- MailNamePrimary.
| 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
|
...