Using the Interface Settings window

Use the Interface Settings window to configure Synergetic to interface with external systems including:

ACARA - Australian Curriculum and Assessment Authority
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.

For each external system you can configure:

Configuration settings without using Configuration File Maintenance. See Configuring external system settings.
Lookup table mapping. See Configuring external system lookup table mapping.

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.

Opening the Interface Settings window

To open the SynWeb Settings window:

Click System > Interface Settings.
The Interface Settings window is displayed.
Select the external system from the drop-down list.

The Interface Settings window is displayed.

Tip: Some settings are duplicated in different sections of the settings tree. You will see multiple settings highlighted in green when a setting with a duplicate is selected.

Interface Settings window key fields and buttons

Fields

Field

Description

Select the external system. You can select:

ACARA - Australian Curriculum and Assessment Authority
myEdOnline
QCAA - Queensland Curriculum and Assessment Authority
QAS - Quick Address System
SIF - Systems Interoperability Framework.

Note: The external systems displayed depends on the state where your organisation is located and the modules purchased.

Selecting an external system populates the page tree with all the settings for the selected external system. For information about the settings in each external system, see the relevant sections below.

Filter the displayed settings based on an entered search term. Matching results are highlighted in bold.

Note: You must select an external system from the drop-down list above to view this field.

Buttons

Buttons	Description
	Expand or collapse the list of settings for the selected external system.
	Go back to the previously selected setting.
	Add a new record to the Interface Settings window. Note: You can currently only add SIF Consumers. See Adding SIF consumers.
	Refresh the displayed external system settings.
	Save changes to the displayed external system settings. Note: You are prompted to save changes before navigating to a different set of external system settings.
	Display a help tip for the selected external system setting.

Lookup table mapping fields

Note: These fields are displayed once an Outbound or Inbound lookup table is selected in the settings tree.

Field	Description
Active Only	Select to only display lookup table records with the ActiveFlag field selected in Synergetic.
Code	Code of the lookup table record. Refer to the selected lookup table in Lookup Table Maintenance.
Description	Description of the lookup table record. Refer to the selected lookup table in Lookup Table Maintenance.
Active	Whether the selected lookup table record is active.
Interface Code	Code mapped to the selected lookup table record.

Lookup table mapping buttons

Button	Description
	Edit mapping for the selected lookup table record.

ACARA settings

Click to view ACARA settings

Field	Description
Outbound	Lists the outbound lookup tables used to map outbound Synergetic lookup table values to ACARA values. See Configuring external system lookup table mapping. Note: You can use these lookup tables to map the Gender, Language and Year Level values for the Student Background Data values. See Exporting the Student Background Data file.
	Outbound lookup tables
	luGender	This lookup table is not editable in Lookup Table Maintenance.
	luLanguage	See luLanguage lookup table.
	luYearLevel	See luYearLevel lookup table.

myEdOnline settings

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.

QAS key settings

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

Field	Description
Outbound	Lists the outbound lookup tables used to map outbound Synergetic lookup table values to QAS values. See Configuring external system lookup table mapping.
	Outbound lookup tables
	luCountry	See luCountry lookup table.

QCAA settings

Note: You can view the QCAA settings by configuring:

• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to QLD. See RegionCode configuration setting.

Click to view QCAA settings

Field	Description
Outbound	Lists the outbound lookup tables used to map outbound Synergetic lookup table values to QCAA values. See Configuring external system lookup table mapping.
	Outbound lookup tables
	luCountry	See luCountry lookup table.
	luGender	This lookup table is not editable in Lookup Table Maintenance.
	luLanguage	See luLanguage lookup table.
	luLearningPathway	See luLearningPathway lookup table.
	luState	See luState lookup table.

SIF settings

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.
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

Field	Description
SIF Consumers	Lists SIF consumers registered to request your organisation's mapped lookup table values.
Inbound	Lists the inbound lookup tables used to map inbound SIF values to Synergetic lookup tables values. See Configuring external system lookup table mapping.
	Inbound lookup tables
	luAbsenceReason	See luAbsenceReason lookup table.
	luAbsenceType	See luAbsenceType lookup table.
	luGender	This lookup table is not editable in Lookup Table Maintenance.
Outbound	Lists the outbound lookup tables used to map outbound Synergetic lookup table values to SIF values. See Configuring external system lookup table mapping.
	Outbound lookup tables
	luAbsenceReason	See luAbsenceReason lookup table.
	luAbsenceType	See luAbsenceType lookup table.
	luBoarder	See luBoarder lookup table.
	luCitizenshipStatus	See luCitizenshipStatus lookup table.
	luCountry	See luCountry lookup table.
	luESLProficiencyLevel	See luESLProficiencyLevel lookup table.
	luEthnicGroup	See luEthnicGroup lookup table
	luGender	This lookup table is not editable in Lookup Table Maintenance.
	luImmunisationFormStatus	See luImmunisationFormStatus lookup table.
	luLanguage	See luLanguage lookup table.
	luMaritalStatus	See luMaritalStatus lookup table.
	luOccupationPosition	See luOccupationPosition lookup table.
	luQualificationLevel	See luQualificationLevel lookup table.
	luRelationship	See luRelationship lookup table.
	luReligion	See luReligion lookup table.
	luStaffCategory	See luStaffCategory lookup table.
	luState	See luState lookup table.
	luStudentLeavingReason	See luStudentLeavingReason lookup table.
	luStudentStatus	See luStudentStatus lookup table.
	luVisaSubClasses	See luVISASubclasses lookup table.
	luYearLevel	See luYearLevel lookup table.