v69 - Interface Settings - QAS, QCAA and SIF

Owned by Graham Kidd
Last updated: Apr 30, 2019
4 min read

First Release Version

69.13

Contents


Overview

The Interface Settings functionality allows clients to configure their instance of Synergetic to interact with specific external systems.  Within Interface Settings specific Synergetic data fields have their values mapped to corresponding values for specific external systems or frameworks.  Mappings exist for both inbound and outbound data flows.

Clients can also configure the interfaces within Interface Settings, without having to go to Configuration File Maintenance.

This configuration allows Synergetic to transfer data to and from the following external frameworks and systems:

  • QCAA - Queensland Curriculum and Assessment Authority, a statutory body of the Queensland Government.
  • QAS - Quick Address Systems, a real-time address validation tool.
  • SIF - Systems Interoperability Framework, is an open, industry supported standard used to link together data systems within the school sector.
  • myEdOnline - myEdOnline Learning Management System

New Navigation in v69

Interface Settings functionality is SynWeb only functionality.  Previously this existed in v68 as System > Settings - SIF.  This navigation is now:

SynWeb > System > Interface Settings


Access to Interface Settings

To grant users access to see this menu item, permission must be provided to the relevant user groups via Group/User Security Maintenance:

Resource: API Roles

Security Key: SYS | Interface Settings

Access to SIF

Access comes with access to Interface Settings.

Access to QAS

Access comes with access to Interface Settings.

Access to my EdOnline

Access comes with access to Interface Settings.

(Note:     MyEdOnline is currently settings configuration only.)

Access to my QCAA

Schools whose Region Code is QLD see QCAA in Interface automatically.

  • System > Configuration File Maintenance

Using the Interface Settings

Configuration Maintenance

As well as introducing extended configuration functionality, such as mapping SIF values; Interface Settings also mirrors currently existing configuration functionality in Syn Main, such as:

  • SynMain > System > Configuration File Maintenance, 

Mirrored in:

  • SynWeb > System > Interface Setings > QCAA - Queensland Curriculum and Assessment Authority

Allowing Interface configuration to be managed in Interface Settings.

  • To edit a configuration, select the item to edit, modify the value and Save.

Mapping of Codes

To map codes in Interface Settings navigate there and select:

  • Interface to map codes for, eg SIF:

Select either Inbound or Outbound code mappings

(Note: Not all interfaces will have both inbound and outbound.)


A list of fields to map will display. 

The fields to map are displayed Fields display in the right hand panel. 

  • Warnings ,  are displayed for fields with mappings yet to be done.0

Select the field you wish to map codes for:

The field (luAbsenceReason) displays in the right hand panel.

The warnings icon is now displaying that there are field values requiring mapping - .

Each field requiring mapping is marked with a  symbol.

To map a value:

  • click on 

  • click on

  • Drop down appears
  • Select the value to map to

  • and Save

    • You can make multiple mappings before Saving

Outbound - 'Active Only' filter

In Outbound mapping screens there is an Active Only switch; when on, this switch will filter out all of the In-Active look up values for the lu table currently being mapped.