Use the Interface Settings window to configure Synergetic to interface with external systems including:
...
Interface Settings window key fields and buttons
Fields
| Field | Description | |
|---|---|---|
| Select the external system | |
.png?version=1&modificationDate=1559815382223&cacheVersion=1&api=v2&height=37){kind=small}
- ACARA - Australian Curriculum and Assessment Authority
- myEdOnline
- QCAA - Queensland Curriculum and Assessment Authority
- QAS - Quick Address System
- SIF - Systems Interoperability Framework.
from the drop-down list. 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. |
.png?version=1&modificationDate=1559816260127&cacheVersion=1&api=v2&height=37){kind=small}
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
...
.png?version=1&modificationDate=1559816085957&cacheVersion=1&api=v2&height=37){kind=small}
...
.png?version=1&modificationDate=1559830499757&cacheVersion=1&api=v2&height=41){kind=small}
...
Go back to the previously selected setting.
.png?version=1&modificationDate=1559830706757&cacheVersion=1&api=v2&width=300)
...
.png?version=1&modificationDate=1559830332587&cacheVersion=1&api=v2&height=40){kind=small}
...
Add a new record to the Interface Settings window.
Note: You can currently only add SIF Consumers. See Adding SIF consumers.
...
.png?version=1&modificationDate=1559816377697&cacheVersion=1&api=v2&height=42){kind=small}
...
.png?version=1&modificationDate=1559816612553&cacheVersion=1&api=v2&height=42){kind=small}
...
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..png?version=1&modificationDate=1559816943167&cacheVersion=1&api=v2&height=231)
...
.png?version=1&modificationDate=1559820681537&cacheVersion=1&api=v2&width=25){kind=small}
...
Lookup table mapping fields
Note: These fields are displayed once an Outbound or Inbound lookup table is selected in the settings tree..png?version=1&modificationDate=1563879596883&cacheVersion=1&api=v2&width=600)
...
Code
...
Code of the lookup table record. Refer to the selected lookup table in Lookup Table Maintenance.
...
Description
...
Lookup table mapping buttons
...
.png?version=1&modificationDate=1559834827277&cacheVersion=1&api=v2&width=41){kind=small}
...
Edit mapping for the selected lookup table record.
.png?version=1&modificationDate=1559834870087&cacheVersion=1&api=v2&height=203)
ACARA settings
...
| External system | Description | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ACARA - Australian Curriculum and Assessment Authority | Select this external system to map Synergetic lookup table values to values included in the Student Background Data File export. See Exporting the Student Background Data file.
| |||||||||||||||||||
| ACTEDUDIR - ACT Government Education Directorate | Select this external system to map Synergetic lookup table values to Australian Capital Territory Education Directorate values. Note: You can view this external system by configuring:
| |||||||||||||||||||
| ACTGOVDEMO - ACT Government Demographic Data Collection | Select this external system to map Synergetic lookup table values to values included in the ACT Demographic and NAPLAN exports. See: Note: You can view this external system by configuring:
| |||||||||||||||||||
.png?version=2&modificationDate=1592825369483&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592825561330&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592825579340&cacheVersion=1&api=v2&width=756)
...
| |||
...
| ||||||
...
...
|
...
myEdOnline settings
...
...
| AUSGOVSTATS - Commonwealth Governments Student Attendance Collection | Select this external system to map Synergetic lookup table values to values included in the STATS export. See Import_Export Student Data - STATS tab.
|
...
| ||||||
.png?version=4&modificationDate=1592825724840&cacheVersion=1&api=v2&width=756)
...
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.
...
Used to store the callback endpoint used when launching MyEdOnline via Synergetic.
...
| ||||||||||||||
| myEdOnline - myEdOnline | Select this external system to configure access to the myEdOnline eLearning platform.
| |||||||||||||
.png?version=1&modificationDate=1586256784030&cacheVersion=1&api=v2&width=756)
QAS key settings
...
| title | Click to view QAS settings |
|---|
Base Address Validation Settings
...
Field
...
Description
...
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.
...
Determines whether address validation is enabled.
Note: This is the same functionality as the AddressValidation:EnabledFlag configuration setting. See AddressValidation:EnabledFlag configuration setting.
...
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.
...
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.
...
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.
...
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
...
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.
...
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.
...
| NSWGOVDEMO - New South Wales Government Demographic Data Collection | Select this external system to map Synergetic lookup table values to values included in the NSW Demographic and NAPLAN exports. See: Note: You can view this external system by configuring:
| |||||||||||||||
| NTGOVDEMO - NT Government Demographic Data Collection | Select this external system to map Synergetic lookup table values to values included in the NT Demographic and NAPLAN exports. See: Note: You can view this external system by configuring:
| |||||||||||||||
| NZMOE - New Zealand Ministry of Education | Select this external system to map Synergetic lookup table values to values included in the MOE exports. See Import_Export Student Data - MOE tab.
| |||||||||||||||
| QAS - QAS Validation Provider | Select this external system to configure address validation using the Quick Address System (QAS).
| |||||||||||||||
.png?version=3&modificationDate=1592825658533&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592825764893&cacheVersion=1&api=v2&width=756)
.png?version=3&modificationDate=1592830059170&cacheVersion=1&api=v2&width=756)
.png?version=1&modificationDate=1559752688683&cacheVersion=1&api=v2&width=756)
...
|
...
|
...
...
|
...
|
...
|
...
|
...
...
|
...
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.
...
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.
...
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
...
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QCAA - Queensland Curriculum and Assessment Authority | Select this external system to map Synergetic lookup table values to values included in the QCAA export and QLD Demographic export. See: Note: You can view this external system by configuring:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QCAANAPLAN - Queensland Curriculum and Assessment Authority - for NAPLAN | Select this external system to map Synergetic lookup table values to values included in the QLD NAPLAN export. See Import_Export Student Data - NAPLAN tab. Note: You can view this external system by configuring:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SACE - South Australian Certificate of Education | Select this external system to map Synergetic lookup table values to values included in the SACE export. See Import_Export Student Data - SACE tab.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SAGOVDEMO - South Australian Government Demographic Data Collection | Select this external system to map Synergetic lookup table values to values included in the SA Demographic and NAPLAN exports. See: Note: You can view this external system by configuring:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SIF - Systems Interoperability Framework | Select this external system to configure Synergetic to access data using the Systems Interoperability Framework (SIF).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
.png?version=2&modificationDate=1592830206753&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592831245267&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592831262460&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592831285840&cacheVersion=1&api=v2&width=756)
.png?version=1&modificationDate=1559752785950&cacheVersion=1&api=v2&width=756)
...
| |||
...
|
...
| title | Click to view QCAA settings |
|---|
...
...
| ||||||||
...
| |||||||||||||||
...
|
...
|
...
|
...
...
|
...
...
| title | Click to view SIF settings |
|---|
Base SIF settings
...
Field
...
Description
...
Determines whether Synergetic can request data from other applications in SIF format.
...
Defines the system architecture used for SIF requests.
...
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
...
Defines the picture of a student, student contact or a staff member.
Note: Pictures are saved in the Synergetic Photo Maintenance window. See Photo Maintenance window.
...
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.
...
Used to define the field used to populate requests for staff member names. You can select:
- LegalFullName
- NameInternal
- NameExternal
- MailNamePrimary.
...
- LegalFullName
- NameInternal
- NameExternal
- MailNamePrimary.
...
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.
...
School-Info settings
...
Field
...
Description
...
View settings related to your organisations local ID.
Note: This is the CEOM number for Catholic schools.
...
View settings related to your organisation's unique reference identifier.
...
SIF Versions settings
...
Field
...
Description
...
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
...
luAbsenceType
...
luGender
...
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
...
...
luCitizenshipStatus
...
See luCitizenshipStatus lookup table.
...
luCountry
...
...
luESLProficiencyLevel
...
See luESLProficiencyLevel lookup table.
...
luEthnicGroup
...
See luEthnicGroup lookup table
...
luGender
...
luImmunisationFormStatus
...
See luImmunisationFormStatus lookup table.
...
luLanguage
...
...
luMaritalStatus
...
See luMaritalStatus lookup table.
...
luOccupationPosition
...
See luOccupationPosition lookup table.
...
luQualificationLevel
...
See luQualificationLevel lookup table.
...
luRelationship
...
See luRelationship lookup table.
...
luReligion
...
...
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
...
| |||||||||||||||||||||||
| TASGOVDEMO - Tasmanian Government Demographic Data Collection | Select this external system to map Synergetic lookup table values to values included in the TAS Demographic and NAPLAN exports. See: Note: You can view this external system by configuring:
| ||||||||||||||||||||||
| VCAAVASSVSN - Victorian Curriculum and Assessment Authority for VASS and VSR | Select this external system to map Synergetic lookup table values to values included in the VASS export. See Import_Export Student Data - VASS tab. Note: You can view this external system by configuring:
| ||||||||||||||||||||||
| VICGOVDEMO - Victorian Curriculum Demographic Data Collection | Select this external system to map Synergetic lookup table values to values included in the VIC Demographic and NAPLAN exports. See: Note: You can view this external system by configuring:
| ||||||||||||||||||||||
| WAGOVDEMO - Western Australian Government Demographic Data Collection | Select this external system to map Synergetic lookup table values to values included in the WA Demographic and NAPLAN exports. See: Note: You can view this external system by configuring:
| ||||||||||||||||||||||
| WASCSA - WA School Curriculum and Standards Authority | Select this external system to map Synergetic lookup table values to values included in the WA SCSA export. See Import_Export Student Data - WA SCSA tab. Note: You can view this external system by configuring:
| ||||||||||||||||||||||
| 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. | ||||||||||||||||||||||
.png?version=2&modificationDate=1592831327167&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592831343773&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592831370610&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592831390030&cacheVersion=1&api=v2&width=756)
.png?version=2&modificationDate=1592831407397&cacheVersion=1&api=v2&width=756)
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.
|