| Field | Description |
|---|
| Select the external system 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. |
| 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.
Click to view ACARA settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to ACT. See RegionCode configuration setting.
Click to view ACTEDUDIR settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to ACT. See RegionCode configuration setting.
Click to view ACTGOVDEMO settings |
| APIClients - API Clients | Select this external system to configure clients that allow users to access the Synergetic API Portal. See /wiki/spaces/SYNWEB/pages/2290128237.
Click to view APIClient settings .png?version=1&modificationDate=1657125024973&cacheVersion=1&api=v2&width=756&height=250)
Fields | Field | Description |
|---|
| Name | Name of the API client. This field is editable. | | GUID | Unique identifier. The GUID and shared secret values (see below) are submitted as parameters in POST Authentication requests to return an authentication token that is used to validate API calls. Important: You must ensure the security of these values. If these values are leaked, people outside your organisation can submit POST Authentication requests to gain access to your data. | | Shared secret | Unique cryptographic key. The GUID and shared secret values (see below) are submitted as parameters in POST Authentication requests to return an authentication token that is used to validate API calls. Important: You must ensure the security of these values. If these values are leaked, people outside your organisation can submit POST Authentication requests to gain access to your data. |
Buttons | Buttons and sliders | Description | | Click to enable or disable the selected API client. | | Click to copy the shared secret. |
|
| AUSGOVNGSC - Department of Education, Skills and Employment (Schools Hub) - NGSC | Select this external system to map Synergetic lookup table values to values included in the Student Census - Australian Non-Governmental Schools report.
Click to view AUSGOVNGSC 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.
Click to view AUSGOVSTATS settings |
| CESA - Student Religion Census | Select this external system to map Synergetic lookup table values to values included in the CESA export. See Import_Export Student Data - CESA tab. Note: You can view this external system by configuring:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to SA. See RegionCode configuration setting.
Click to view CESA settings |
| CSNSW | Select this external system to map Synergetic lookup table values to values included in the CSNSW export. See Import_Export Student Data - CSNSW tab.
Note: You can view this external system by configuring:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to NSW. See RegionCode configuration setting.
Click to view CSNSW settings |
| LEA | Select this external system to map Synergetic lookup table values to values included in the LEA export. See Import_Export Student Data - LEA tab.
Click to view LEVNT settings |
| myEdOnline - myEdOnline | Select this external system to configure access to the myEdOnline eLearning platform.
Click to view myEdOnline settings .png?version=1&modificationDate=1586256784030&cacheVersion=1&api=v2&width=756&height=396)
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. |
|
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to NSW. See RegionCode configuration setting.
Click to view NSWGOVDEMO settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to NT. See RegionCode configuration setting.
Click to view NTGOVDEMO settings |
| 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. Click to view NTGOVDEMO settings |
| QAS - QAS Validation Provider | Select this external system to configure address validation using the Quick Address System (QAS).
Click to view QAS 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. | | 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 |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to QLD. See RegionCode configuration setting.
Click to view QCAA settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to QLD. See RegionCode configuration setting.
Click to view QCAANAPLAN settings |
| 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.
Click to view SACE settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to SA. See RegionCode configuration setting.
Click to view SAGOVDEMO settings |
| SIF - Systems Interoperability Framework | Select this external system to configure Synergetic to access data using the Systems Interoperability Framework (SIF).
Click to view 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 | 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: 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 |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to TAS. See RegionCode configuration setting.
Click to view TASGOVDEMO settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to VIC. See RegionCode configuration setting. Click to view VCAAVASSVSN settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to VIC. See RegionCode configuration setting.
Click to view VICGOVDEMO settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to WA. See RegionCode configuration setting.
Click to view WAGOVDEMO settings |
| 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:
• CountryCode configuration setting to AU. See CountryCode configuration setting.
• RegionCode configuration setting to WA. See RegionCode configuration setting. Click to view WASCSA settings |
| 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=1&modificationDate=1559322284750&cacheVersion=1&api=v2&width=756&height=250)
.png?version=1&modificationDate=1559322431620&cacheVersion=1&api=v2&width=756&height=250)
.png?version=1&modificationDate=1559733418817&cacheVersion=1&api=v2&width=756&height=354)
.png?version=1&modificationDate=1559815382223&cacheVersion=1&api=v2&width=311&height=37){kind=small}
.png?version=2&modificationDate=1592825369483&cacheVersion=1&api=v2&width=756&height=334)
.png?version=2&modificationDate=1592825561330&cacheVersion=1&api=v2&width=756&height=221)
.png?version=2&modificationDate=1592825579340&cacheVersion=1&api=v2&width=756&height=279)
.jpg?version=1&modificationDate=1596534110553&cacheVersion=1&api=v2&width=756&height=321)
.png?version=1&modificationDate=1658831184803&cacheVersion=1&api=v2&width=756&height=311)
.png?version=1&modificationDate=1662131932617&cacheVersion=1&api=v2&width=756&height=337)
.png?version=2&modificationDate=1660060955653&cacheVersion=1&api=v2&width=756&height=308)
.png?version=3&modificationDate=1592825658533&cacheVersion=1&api=v2&width=756&height=220)
.png?version=2&modificationDate=1592825764893&cacheVersion=1&api=v2&width=756&height=221)
.png?version=3&modificationDate=1592830059170&cacheVersion=1&api=v2&width=756&height=251)
.png?version=2&modificationDate=1592830206753&cacheVersion=1&api=v2&width=756&height=389)
.png?version=2&modificationDate=1592831245267&cacheVersion=1&api=v2&width=756&height=221)
.png?version=2&modificationDate=1592831262460&cacheVersion=1&api=v2&width=756&height=222)
.png?version=2&modificationDate=1592831285840&cacheVersion=1&api=v2&width=756&height=223)
.png?version=2&modificationDate=1592831327167&cacheVersion=1&api=v2&width=756&height=221)
.png?version=2&modificationDate=1592831343773&cacheVersion=1&api=v2&width=756&height=225)
.png?version=2&modificationDate=1592831370610&cacheVersion=1&api=v2&width=756&height=221)
.png?version=2&modificationDate=1592831390030&cacheVersion=1&api=v2&width=756&height=221)
.png?version=2&modificationDate=1592831407397&cacheVersion=1&api=v2&width=756&height=222)
.png?version=1&modificationDate=1559816260127&cacheVersion=1&api=v2&width=278&height=37){kind=small}
.png?version=1&modificationDate=1559816085957&cacheVersion=1&api=v2&width=40&height=37){kind=small}
.png?version=1&modificationDate=1559830499757&cacheVersion=1&api=v2&width=40&height=41){kind=small}
.png?version=1&modificationDate=1559830706757&cacheVersion=1&api=v2&width=291&height=363)
.png?version=1&modificationDate=1559830332587&cacheVersion=1&api=v2&width=42&height=40){kind=small}
.png?version=1&modificationDate=1559816377697&cacheVersion=1&api=v2&width=41&height=42){kind=small}
.png?version=1&modificationDate=1559816612553&cacheVersion=1&api=v2&width=41&height=42){kind=small}
.png?version=1&modificationDate=1559816943167&cacheVersion=1&api=v2&width=344&height=231)
.png?version=1&modificationDate=1559820681537&cacheVersion=1&api=v2&width=18&height=20){kind=small}
.png?version=1&modificationDate=1563879596883&cacheVersion=1&api=v2&width=600&height=137)
.png?version=1&modificationDate=1559834827277&cacheVersion=1&api=v2&width=25&height=27){kind=small}
.png?version=1&modificationDate=1559834870087&cacheVersion=1&api=v2&width=390&height=203)