SMS data exchange set up and configuration

Owned by
Former user (Deleted)
Last updated: Nov 04, 2019 by
Andrew Rose
Version comment
2 min read

The SMS data exchange project allows data to be exchanged between school management systems (SMS), such as Synergetic, and the New Zealand Ministry of Education (NZ MOE).

Web Service
The web service is provided by the NZ MOE. To locate and connect to the web service, the following items are required:

  • WSS Wrapper (Wrapper)
  • internet Connection between the Wrapper and the web service
  • web address of the web service (expressed as a Web Service Definition Language (WSDL) URL with parameters)
  • correct certificates and password.

Wrapper
For Electronic roll returns (eReturns), the wrapper:

  • accepts the MOE file from eReturns
  • wraps (encrypts) the MOE file
  • forwards this encrypted MOE file to the NZ MOE's web service.

When Managing New Zealand student NSNs and identity details (Roll returns), the wrapper:

  • accepts data from the Get/Check NSN function
  • wraps (encrypts) the data
  • forwards this encrypted data to the NZ MOE's web service.

Optionally, the Wrapper can check the status of connectivity to the web service.

Installation of WSS Wrapper
Before commencing you must first install the Wrapper application on a computer. These instructions assume that you are installing the Wrapper on the same machine that the Synergetic database runs on.
Download the wrapper from the https://support.synergetic.net.au/cda/downloads/NZ/  (As of 2019 the latest version of the wrapper is Wrapper3 Synergetic.zip)

WssWrapper_windows_3_0.exe
This will install the application as a service (WssWrapper_Java5) which is configured to auto start. See Checking, disabling and restarting Wrapper.
Once the wrapper is installed you can click the following link. http://localhost:7123/control/index.html If all went well a web page should be displayed
Possible causes for the test application to fail to connect to the web service:

  • No internet connection is available. Please check that you are properly connected to the Internet.
  • Firewall. Please make sure that the connection between the Wrapper and the web service is clear and not restricted. By default, the Wrapper runs at port 7123.

Note: It is also important to note that the Wrapper is not using standard HTML content, even though it's communicating through HTTP protocol. Therefore it is advisable to configure the firewall to allow these contents as well.

  • Incorrect WSDL URL. The Wrapper will not be able to locate the web service if the WSDL is incorrect.
  • Incorrect certificates (please see below).

Wrapper certificates
For new installations, the Wrapper comes with:

  • .keystore factory default certificate
  • dextest.xml is the XML test file to test the installation.

From time to time, the NZ MOE issues new certificates. See Renewing certificates for eReturns.