Facility™ connector setup guide

This guide walks you through the process of configuring your Vivo miles account to connect to your Facility™ MIS via its web API. An appendix to this guide details the data that is transferred in accordance with the Data Protection Act 1998. If you have any problems with the Advanced Learning Facility API, please contact their support desk on 0845 6888400. Their install notes are shown below. Documentation Date: August 2013 Configuration In your admin account for Vivomiles.com, navigate to the setup screen via Manage Data -> Configure MIS Import. On this screen you need to enter the URL locations of your school’s Facility setup. There are 2 URLS that you need to enter; one for the WSDL file and one for the functions. The URLs will look like this: WSDL: https://localhost/API/services/WebService?wsdl Functions: https://localhost/API/services/WebService You will need to replace “localhost” with the IP address of your ePortal installation. Security Access to the API is limited by IP address. On the setup page, you will see our IP address that you will need to add to your API security xml file in Facility. Optionally, you can also add a username and password that is required to access the API if you are setup in this way. Testing There is a ‘test’ button that allows you to test whether Vivo can connect to your school’s API. Please be patient, as this test can take between 30 and 60 seconds to run. Data Transferred This is a list of the data that the application transfers to Vivo on a nightly basis. Student Data: GU-ID Facility™ connector setup guide Gender First name Surname UPN Year Tutor Group House Email Address Staff Data: GU-ID Staff Code Gender First Name Surname Staff Code Email Address Configuring the Facility API Start by opening the XML file located in C:\Facility\ePortal\conf\Catalina\localhost\API.xml and edit the XML shown below. To enable the API to send and receive data you will need to change the contents of “allow” Enter the Vivo IP address of 212.110.166.* and the local IP of 127.0.0.1 so that the XML appears as shown below. If you have a certificate in IIS then you can go to https://localhost/API you should see the following screen. Otherwise please continue to follow the remaining steps to add a certificate before trying this. Adding a certificate to IIS If you already have a certificate set up on IIS you do not need to follow this step. This section will describe how to add a self signed certificate provided as part of this installation. From within the Internet Information Services (IIS) Manager application, expand the Web Sites folder and right click on the Default Web Site option. From the context popup menu choose Properties and then the following screen will appear. Choose the Directory Security tab and the click Server Certificate, the IIS Certificate Wizard will then open. On the first screen click Next On the next screen, choose Import certificate from a .pfx file Click Next and then browse to the provided certificate file, which can usually be found at C:\Facility\ePortal\webapps\API\certs\IIScertSerco.pfx (The IIScertSerco.pfx file is placed in this directory after the installer has been run) The next screen will ask for a password enter 79WSax88 The next screen asks for a port, leave the default 443 Click next and finish the wizard. The certificate has now been installed. You will need to go to Start | Run | and type “iisreset” as shown below

Have more questions? Submit a request