Versions Compared

Key

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

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

...

Expand
titleClick to view ACARA settings


FieldDescription
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
luGenderThis lookup table is not editable in Lookup Table Maintenance.
luLanguageSee luLanguage lookup table.
luYearLevelSee luYearLevel lookup table.


...

Expand
titleClick 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 TokenUsed to generate and store the myEdOnline authorisation token.


...

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

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.


...

Expand
titleClick 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 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: This field is not editable 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 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.


...