Cypad/Capita SIMS Connector installation

This Quick Ref describes the Cypad/SIMS Integration App and shows you how to install it. It is aimed at school admin staff with SIMS permission.

To operate effectively, the Meal Selection, Meal Register and Payments Modules require specific information about students. This data is exported from the school’s pupil management system and imported using a Comma Separated Values (.CSV) file into Cypad or alternatively the Cypad/SIMS Integration App.

Data Processing Agreement

When you run the Cypad/SIMS Integration App you will be asked to sign the Cypad Data Processing Agreement which states that by installing this application you allow Cypad to access pupil information.

Cypad/SIMS Integration

For the integration to work the Cypad SIMS Integration app is manually installed by Cypad on the PC where SIMS is installed, this may be on a physical server or in the ‘cloud’. Every night the App copies the student name, year, class, Free School Meal (FSM) status, Photo, SIMSID, their Dietary needs and the Student ‘open’ or ‘close’ status of every child to a secure file on the Cypad server.

Before you install the Cypad/SIMS Integration App

On the SIMS user creation form enter your user details in the Basic Details [1] section. The Username and Password [2] for the Cypad/SIMS Integration app are in the SIMS Settings section. Add two new User Groups [3]. One group must be titled Class teacher and the other titled Third-Party Reporter. Both user groups will need permissions set to read student details from the SIMS database (permission are defined in the group by SIMS).

SIMS User creation form

mceclip5.png

Install the Cypad/SIMS Integration App

Select the installation link provided by Cypad:

http://app.cypad.net/simsintegration/cypadsimssetup194.zip

  1. Save the zipped folder to your computer
  2. Right-click on folder and click Extract All
    NOTE: This is just zip extraction process, this will differ based on the client extraction software. (User can extract anywhere they want) Click Extract
  3. Enter password: CypadSIMS 
  4. Locate setup files and double click setup.exe to start the Cypad/SIMS Integration InstallShield wizard
  5. Click Next.
    mceclip0.png
  6. Accept the terms in the License Agreement [1] and click Next [2].
    mceclip2.png
  7. The Destination Folder [1] should be set to C:\Programme Files (x86), then click Next [2].
    mceclip3.png
  8. Click Install.
    mceclip4.png
  9. Click the Next button to finalise the installation.
    mceclip5.png
  10. Click Finish to complete the installation process.
    mceclip6.png

The Cypad/SIMS Integration Settings User Interface will automatically open for editing. Before you start the next step contact Cypad to confirm the SIMS School ID matches what Cypad has on its records.

NOTE When adding the User Name and Password to the SIMS Integration Settings enter the newly created SIMS username and password you have been provided.

  1. In the Settings [1] tab, enter the Server Name [2], Database [3], User Name [4], Password [5] and School ID [6].  mceclip0.pngNOTE The School ID [6] for Meal Manager sites is their 7 digit DFE number. For sites using Meal Selection via a caterer/local authority, this is the Cypad site ID assigned for their school by the caterer.
  2. To confirm the Server Name [1] and Database Name [2] navigate from your Local Disk (C:) to the SIMS folder and open the connect.ini file with Notepad. The SIMS connector application automatically reads the connect.ini file and applies it to the SIMS connector settings.dat file to simplify the set-up process.
  3. Click Test Connection. If the data is correct you will see a message telling you that you have successfully connected to the SIMS server.mceclip1.png
  4. The app automatically reads the School ID and displays it inside the School ID pop-up, click the Yes button to confirm the ID is correct.
  5. If the data is incorrect you will get the following Error message.
  6. If the server is behind a proxy server open the Connection [1] tab, click the Use a proxy server [2]  checkbox to enter the Protocol [3], IP or URL Address [4] and Port [5].mceclip2.pngNOTE  If needed, user can get the local proxy configuration in the Internet explorer > connections tab > LAN settings.
  7. Click Validate [1] in to open the School List [2]. Using the School site ID [3], select the appropriate school and click OK [4].mceclip6.png
  8. Repeat Steps 4 and 5. If the School ID is correct perform the following:
  9. If the Service URL is correct a Success message will confirm the URL is available.
  10. If the Service URL is incorrect or unable to connect to the service URL a Failure message will confirm the URL is unavailable.

    NOTE Check the service URL in a browser, contact Cypad if it fails to read the service URL in the browser.
  11. Click OK [1].
  12. Click Save & Close.

Check the App status and for updates

  1. To check the Cypad/SIMS Integration App status, and for updates, go to the Status tab [1] and click the Check for Update [2] button.
    mceclip3.png
  2. If an update is available, a pop-up screen will confirm an update is available. Click Yes to perform the update.
    mceclip1.png
  3. You will be asked to accept the License Agreement. Accept the License Agreement [1] and click Next [2] to install the update.
    mceclip4.png
  4. When the update installation is complete a pop-up will confirm the version has been updated. Click Close and the app will reload the Cypad/SIMS Integration Settings form.

    NOTE Run the application as Administrator to prevent installation permission issues.
  5. If there is no update, a pop-up will confirm the current version is up to date. Click OK to close the pop-up.

FAQs

I am unable to update Cypad with changes in SIMS?

Admin users can access the SIMS connector error reports to check the connectivity status and identify connectivity failures and the reason behind the failure. 

Proxy Error:

To make sure that the App is working click Status in the Cypad/SIMS Integration Settings screen.

mceclip4.png

If the Last report uploaded date is more than three day’s old from the current date, the App is not updating Cypad with the latest SIMS data. To resolve this issue, do the following:

  1. Press (Windows Key + E) on your keyboard to open the File Explorer.
  2. In the File Explorer select the Local Disk (C:), this will open in the File Explorer window.
  3. Double click the Program Files (x86) folder.
    NOTE  The user may install program in a different folder.
  4. Double click the Cypad Ltd folder.
  5. Double click the CYPAD SIMS Integration folder.

  6. If the Integration service and Updater service are Running locate the log files in the Log folder of the Cypad SIMS Integration folder and email them to Cypad support for analysis.
  7. After Cypad has analysed the Logs we will be in contact.

Proxy needs to be changed

  1. Press (Windows Key + E) on your keyboard to open the File Explorer.
  2. In the File Explorer select the Local Disk (C:), this will open in the File Explorer window.
  3. Double click the Program Files (x86) folder.
    NOTE The user may install program in a different folder.
  4. Double click the Cypad Ltd folder.
  5. Double click the CYPAD SIMS Integration folder.
  6. When If the Integration service and Updater service are Stopped, right mouse click on each of the identified configuration files, select Open with… and use Notepad to modify the proxy settings for the following .exe.config files:
    CypadSIMSService.exe.config - Report uploading service [1]
    CypadSIMSServiceUpdater.exe.config - Service updater and log file uploader [2]
    CypadSIMSUpdater.exe.config - Service and application updater [3]
    SIMSIntegration.exe.config - Integration settings validation application [4].

    NOTE When opening each of the .exe.config files DO NOT tick the checkbox to ‘Always use this App to open .exe.config’ files.

    NOTE Contact your IT department for support to provide you with the proxy details before doing the next step.
  7. Select the following text and copy (Ctrl+C):
  8. Open the Report uploading service [1] file using Notepad. Open the Find window [8] (Ctrl+F) and search for tag [6].
  9. Close the Find window [8], highlight the content tag [7], right mouse click to open the options and click Paste [9] (Ctrl+P). This will replace the content with the copied content in step 7.
  10. Click File [10] and select Save [11] (Ctrl+S) to save the changes made to the .exe.config file.
  11. Repeat these steps for the following exe.config files:
    CypadSIMSServiceUpdater.exe.config - Service updater and log file uploader [3].
    CypadSIMSUpdater.exe.config - Service and application updater [4].
    SIMSIntegration.exe.config - Integration settings validation application [5].
  12. Follow the steps in Restarting/starting Cypad SIMS Integration services.

Restarting/starting Cypad SIMS Integration services

  1. Open the task manager (Ctrl+Alt+Del) and open the Services tab [12] to select the following services:
    CypadSIMSIntegrationService [13]
    CypadSIMSServiceUpdater [14]
    mceclip5.png
  2. Select the CypadSIMSIntegrationService [12].
    If the service is running, right mouse click and select Restart.
    If the service is stopped, right mouse click and select Start.

How do I uninstall the App?

NOTE You will need permission from the administrator to uninstall the App.

  1. In Windows 10 type Uninstall Cypad SIMS Integration in the search bar and follow the uninstall instructions.
  2. In older operating systems the un-install shortcut is in the Start menu or go to control panel, select the application (Cypad SIMS Integration) and click uninstall. In older XP and Server versions go to Start >All Programs >Cypad Ltd > Uninstall Cypad SIMS Integration Settings.

Data Processing Agreement: Is other information or data about parents included?

Cypad will not take any other information other than that described above.

Data Processing Agreement: Is allergy information included?

This feature is now available.

Daily email of new SIMS connector sites

A daily email is sent to cypadprojects@cypad.com at 7pm containing a list of all sites in the Site Versions table of the Cypad SIMS Management Portal where the Report Received column is NULL.

Authenticated Proxy Compatibility

School Admin’s can use the SIMS connector app, this is available only when they have an authenticated proxy server.

mceclip0.png