Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

...

Expand
titleOpening the Interface Settings window

To open the SynWeb Interface Settings window:

  1. Click Module > System > Interface Settings.
    The Interface Settings window is displayed.
  2. 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

FieldDescription

Image Modified

















Select the external system

. You can select:
  • 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.

    Image Removed

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

    Buttons

    ...

    Image Removed

    ...

    Image Removed

    ...

    Go back to the previously selected setting.

    Image Removed

    ...

    Image Removed

    ...

    Add a new record to the Interface Settings window.

    Note: You can currently only add SIF Consumers. See Adding SIF consumers.

    ...

    Image Removed

    ...

    Image Removed

    ...

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

    ...

    Image Removed

    ...

    Lookup table mapping fields

    Note: These fields are displayed when the Outbound or Inbound setting is selected in the settings tree.
    Image Removed

    ...

    Code

    ...

    Code of the lookup table record. Refer to the selected lookup table in Lookup Table Maintenance.

    ...

    Description

    ...

    Lookup table mapping buttons

    ...

    Image Removed

    ...

    Edit mapping for the selected lookup table record.

    Image Removed

    myEdOnline settings

    ...

    External systemDescription

    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.


    Expand
    titleClick to view ACARA settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used for mapping outbound Synergetic lookup table values to ACARA values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.
    luLanguageSee luLanguage lookup table.
    luYearLevelSee luYearLevel lookup table.



    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.


    Expand
    titleClick to view ACTEDUDIR settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used for mapping outbound Synergetic lookup table values to ACT Government Education Directorate values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    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.


    Expand
    titleClick to view

    ...

    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.

    ...

    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.

    ...

    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.

    ...

    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

    ...

    ACTGOVDEMO settings

    Image Added

    FieldDescription

    ...

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

    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to ACT Demographic export values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.
    luYearLevelSee luYearLevel lookup table.



    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.


    Expand
    titleClick to view APIClient settings

    Image Added

    Fields

    FieldDescription
    NameName 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 slidersDescription
    Image Added
    Click to enable or disable the selected API client.
    Image Added
    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.


    Expand
    titleClick to view AUSGOVNGSC settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to Student Census - Australian Non-Governmental Schools values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luYearLevelSee luYearLevel lookup table.



    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.


    Expand
    titleClick to view AUSGOVSTATS settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to STATS values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGender

    See luGender lookup table.

    luYearLevel

    See luYearLevel lookup table

    Note: You need to clear the IncludeInCensusFlag on the luYearLevel lookup table for Preparatory and Senior Kindergarten prior to running the STATS export.



    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.


    Expand
    titleClick to view CESA settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to CESA values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luReligionSee luReligion lookup table.
    luYearLevelSee luYearLevel lookup table.



    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.

    Expand
    titleClick to view CSNSW settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to LEA values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luReligionSee luReligion lookup table.
    luYearLevelSee luYearLevel lookup table.



    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.


    Expand
    titleClick to view LEVNT settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to LEA values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luReligionSee luReligion lookup table.
    luYearLevelSee luYearLevel lookup table.



    myEdOnline - myEdOnline

    Select this external system to configure access to the myEdOnline eLearning platform.


    Expand
    titleClick to view myEdOnline settings

    Image Added

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


    Expand
    titleClick to view NSWGOVDEMO settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to NSW Demographic values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    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.


    Expand
    titleClick to view NTGOVDEMO settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to demographic values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.
    luRelationshipSee luRelationship lookup table.
    luYearLevelSee luYearLevel lookup table.



    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.

    Expand
    titleClick to view NTGOVDEMO settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to NZMOE values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    QAS - QAS Validation Provider

    Select this external system to configure address validation using the Quick Address System (QAS).


    Expand
    titleClick to view QAS settings

    Image Added

    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

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


    Expand
    titleClick to view QCAA settings

    Image Added

    FieldDescription
    OutboundLists 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
    luCountrySee luCountry lookup table.
    luGenderSee luGender lookup table.
    luLanguageSee luLanguage lookup table.
    luLearningPathwaySee luLearningPathway lookup table.
    luStateSee luState lookup table.



    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.


    Expand
    titleClick to view QCAANAPLAN settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to NAPLAN values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    SACE - South Australian Certificate of Education

    Select this external system to map Synergetic lookup table values to values included in the SACE exportSee Import_Export Student Data - SACE tab.


    Expand
    titleClick to view SACE settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to SACE values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    SAGOV - South Australian Government
    Select this external system to map Synergetic lookup table values to values included in the Persistent Non-Attendance report. See Import_Export Student Data - SA GOV 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.


    Expand
    titleClick to view SAGOV settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to demographic values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luAbsenceTypeSee luAbsenceType lookup table.



    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.


    Expand
    titleClick to view SAGOVDEMO settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to demographic values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    SIF - Systems Interoperability Framework

    Select this external system to configure Synergetic to access data using the Systems Interoperability Framework (SIF).


    Expand
    titleClick to view SIF settings

    Image Added

    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 VersionDefines 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 RetrieveDefines the maximum number of records to retrieve in a single request.
    SIF Provider ServiceDisplay 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 ServiceDetermines whether the SIF Provider Service is enabled to allow other applications to request data in the SIF format.
    SchoolInfoView school information settings.
    SchoolInfo Settings
    Enable SchoolInfoUsed to determine whether details about your organisation and its campuses can be provided to other applications.
    StaffAssignmentView 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.

    StaffPersonalView 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 StaffPersonalUsed to determine whether personal details of staff members employed at your organisation can be provided to other applications.
    StudentAttendanceTimeListView student attendance time settings.
    StudentAttendanceTimeList settings
    Enable StudentAttendanceTimeListUsed to determine whether more detailed information about student attendance throughout the day can be provided to other applications.
    StudentContactPersonalView student contact personal settings.
    StudentContactPersonal settings
    Full Name for StudentContactPersonalUsed to define the field used to populate requests for student contact names. You can select:
    • LegalFullName
    • NameInternal
    • NameExternal
    • MailNamePrimary.
    EnableStudentContactPersonalUsed to determine whether personal details of student contacts of students attending at your organisation can be provided to other applications.
    StudentContactRelationshipView relationship settings for student contacts.
    StudentContactRelationship settings
    Enable StudentContactRelationshipUsed to determine whether personal details of staff members employed at your organisation can be provided to other applications.
    StudentPersonalView personal settings for students.
    StudentPersonal settings
    Full Name for StudentPersonalUsed 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.

    StudentSchoolEnrolmentView student enrolment settings.
    StudentSchoolEnrolment settings
    Enable StudentSchoolEnrolmentUsed to determine whether details about student enrolment at your organisation can be provided to other applications.
    TeachingGroupView teaching group settings that relate to classes and the students and teachers involved in each class.
    TeachingGroup settings
    Enable TeachingGroupUsed 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 StudentSchoolEnrolmentSee the StudentSchoolEnrolment setting.
    Ref ID

    View settings related to your organisation's unique reference identifier.

    Ref ID settings
    Full Name for Student PersonalSee the Full Name for StudentPersonal setting.
    Enable StudentPersonalSee the Enable StudentPersonal setting.
    School Sector TypeView settings related to your organisation's school sector. For example, Non-Government.
    School Sector Type settings
    Enable Teaching GroupSee the Enable TeachingGroup setting.

    SIF Versions settings

    Field

    Description

    SIF ConsumersLists 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

    ...

    ...

    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

    See luGender lookup table.

    ...

    titleClick to view QCAA settings

    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.

    ...

    titleClick 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:EnabledFlag configuration setting. See SIF_EnabledFlag configuration setting.

    SIF Provider Service settings

    ...

    Field

    ...

    Description

    ...

    Defines the picture of a student, student contact or a staff member.

    Note: This field is not editable.

    ...

    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.

    ...

    Inbound lookup tables

    ...

    luAbsenceReason

    ...

    luAbsenceType

    ...

    luGender

    ...

    Outbound

    ...

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to SIF values.

    ...

    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

    ...

    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

    ...

    luStudentLeavingReason

    See luStudentLeavingReason lookup table.

    luStudentStatus

    See luStudentStatus lookup table.

    luVisaSubClasses

    See luVISASubclasses lookup table.

    luYearLevel

    See luYearLevel lookup table.



    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.


    Expand
    titleClick to view TASGOVDEMO settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to demographic values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    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.


    Expand
    titleClick to view VCAAVASSVSN settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to VASS values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    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.


    Expand
    titleClick to view VICGOVDEMO settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to VIC demographic values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    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.


    Expand
    titleClick to view WAGOVDEMO settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to WA demographic values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    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.


    Expand
    titleClick to view WASCSA settings

    Image Added

    FieldDescription
    Outbound

    Lists the outbound lookup tables used to map outbound Synergetic lookup table values to SCSA values. See Configuring external system lookup table mapping.

    Outbound lookup tables
    luGenderSee luGender lookup table.



    Image Added

    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

    ButtonsDescription

    Image Added

    Expand or collapse the list of settings for the selected external system.

    Image Added

    Go back to the previously selected setting.

    Image Added

    Image Added

    Add a new record to the Interface Settings window.

    Note: You can currently only add SIF Consumers. See Adding SIF consumers.

    Image Added

    Refresh the displayed external system settings.

    Image Added

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

    Image Added

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

    FieldDescription
    Active OnlySelect 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.
    ActiveWhether the selected lookup table record is active.
    Interface CodeCode mapped to the selected lookup table record.

    Lookup table mapping buttons

    ButtonDescription

    Image Added

    Edit mapping for the selected lookup table record.

    Image Added