Sleuth Importer Installation Notes

Overview

Once we have created your school’s Sleuth database, it can be populated with your staff and students using the Sleuth Importer tool which is included as part of a Sleuth Project.  The Sleuth Importer takes data from your Management Information System (MIS) system and loads it into Sleuth.  It does an initial load when first installed and then updates Sleuth automatically from then on (by default, daily at 0100) via a scheduled service.

The Sleuth Importer uses Groupcall Xporter, a third-party product which is included with the Sleuth Importer.  If your school already uses the Groupcall Xporter then the process described below will update your current installation instead of installing again so you may not see all of the configuration steps listed below if they have already been filled in previously.

Preparing to Install

Please check with your MIS support service that any relevant setup or forms have been completed for your MIS system to allow access by Groupcall’s Xporter product. We attempt to inform you of all steps necessary but the process can be subject to change.

We recommend that you install the Sleuth Importer on your MIS server but if this is not possible then it must be installed on a machine with the correct access to your MIS and is switched on at the time you have configured the import to happen. The type of access varies with each MIS system, for example SIMS requires the SIMS client tools installed but for other MIS systems where a direct connection to the database is used you will just need a tcp connection to the relevant port on the MIS server. The machine you choose to install it on will also require internet access via port 80 and 443 to sleuth.schoolsoftwarecompany.com, schoolsoftwarecompany.com and groupcall.com domains. This can be via a proxy server if you know the proxy server address, port and any usernames or passwords that are required.

Capita – Sims.Net

If you are installing the Sleuth Importer for the first time and you use SIMS as your MIS you will need a SIMS user created with the following groups assigned to them: Third Party Reporting, Personnel Officer, Senior Management Team and School Administrator. We recommend that you create a new user called sleuth to keep it separate from members of staff.

Serco – Facility CMIS

You will need to specify the location of you CMIS .CDB file when you install Groupcall Xporter so please make sure you know where it is and we recommend you use the CMIS Sql Server user called STUD_ADMIN with the correct password. Note: It is possible to use a different Sql Server user but you will need to contact us for further setup information if you would like to do this.

RM Integris – G2

  1. You will need to authorise the Xporter software to be allowed to connect to G2. To do this please follow these instructions from Groupcall or these instructions from RM Integris and select the Xporter software.
  2. Once you have authorised the data sharing you need to let us know and we can complete the rest of the process with Groupcall.

Double First – Engage

The Xporter program connects to Engage via a TCP connection to the MS SQL server database directly. This only needs to be a readonly connection so you will need to make sure you have a MS SQL database user setup with the datareader permission for the Engage database.

Arbor

To connect the Xporter program to Arbor you will need to know the Web service URL and have an API username and password from Arbor.

ScholarPack

You will need your ScholarPack API URL, ScholarPack API username and ScholarPack API password information ready before you begin. Also ensure you have completed the API configuration in ScholarPack (Admin, Config, API Configuration) requesting Groupcall access.

Installing the Sleuth Importer Software

  1. Sleuth Importer requires Windows 7 or later, Server 2003 or later
    If you are going to install the Sleuth Importer remotely via remote desktop make sure you are logging on to the console session. For Server 2003 sp1 click start – run and type mstsc /console, otherwise type mstsc /admin
  2. Now download and run the installer: Sleuth_GroupcallXporter4_Setup.exe (548KB)
    This will start a wizard which will take you through the installation or upgrade process. (This may take 10-20 minutes if it has to update .Net Framework and MMC windows components.)
  3. If you are installing for the first time you will now see a screen where you can enter your LEA code, DFES number and school name.
  4. If you are installing for the first time you will next see a window pop-up asking for your MIS(SIMS, CMIS etc..) connection details username and password.
  5. Now the Sleuth import process will run and after a couple of minutes you should see a pop-up window asking for your Sleuth Online Importer username, password and details of any proxy that you use. If you don’t see the popup requesting the details then you can manually run the shortcut on your desktop called Sleuth Importer Settings. If you have not yet been provided with your Sleuth Importer username and password please contact us and we will provide them so you can complete the installation. Once you have entered your Sleuth Importer settings and clicked ok it will check the connection and hopefully report back a successful connection attempt.
  6. Once you have completed the installation wizard you can run the Xporter Management Console shortcut on your desktop to check the installation is running successfully. You should see a Jobs link on the left and if you click on that you should see the Sleuth job is installed and has run successfully. This should be all you need to do to get it working and once the process has completed your database should have been populated with your staff and student data. At this point, contact Sleuth Support to let us know the Importer has run. We will review the data and then contact your Sleuth project leader about the next steps.If you do encounter a problem, in the first instance check the Sleuth Importer Notes page.

Maintaining the Sleuth Importer

It is imperative that responsibility for the Sleuth Importer’s successful operation is recognised in school. A frequent check should be added to the school’s standard IT/Network procedures in order that any changes to server software (e.g. the MIS) or hardware (e.g. the MIS server) do not result in the Sleuth Importer failing to run for any length of time. To assist with this check, every Sleuth Admin User receives notification every time they login about the most recent run of the Sleuth Importer (and also the last successful run) in MyMessages on their Sleuth Home page. Any failure to run daily or any error messages should be reported to the IT team to be investigated.

The online help in Sleuth or the Sleuth Importer Notes describe how to resolve any issues arising with the Sleuth Importer.

 

Sleuth is a School Software Company Product
© 2024 School Software Company