Knowledgebase: 2) Frog 3
Frog3 - SIMS Extractor Configuration
Posted by Sam Brown, Last modified by Tom Keegan on 10 May 2019 11:36 AM

Opening the Configuration Page

In order to configure the SIMS Extractor click on (Start-->Programs-->Frog-->SIMS Extractor-->Configuration).



This will open up the configuration page, not before running a check of your SIMS.net version in a small popup window.




Once the check has been completed the main configuration page for the SIMS Extractor will open. As you can see, the current Extractor version you are running is displayed at the top left of this window.





Information Required

  • SIMS Server --> The names of your SIMS server then the share name (e.g. SIMSSERVER\SHARE)
  • SIMS DB --> The name of your SIMS Database
  • SIMS Location --> The location of SIMS on this machine that the extractor is installed upon
  • SIMS Username --> The username of the account created and placed within specific groups in order for the Extractor to have access to the SIMS data (See Configuring SIMS for further information on this)
  • SIMS Password --> The password of the account created and placed within specific groups in order for the Extractor to have access to the SIMS data
  • Frog Server --> The hostname or internal IP of your frog server (this not include any http:// prefix -- typically for schools this will be "frogserver")


Validate Frog Server

Once you are happy your server settings are correct, click on "Validate Server" in order to ensure that the Extractor can connect to your Frog Server. If this is unsuccessful the box will turn red if it cannot connect to your Frog server but if successful, will turn green. An example can be seen below.




If your school has purchased the Frog Parental Engagement Platform (PEP), additional data options are available to extract information used by PEP when clicking validate Frog Server. If these options are not available after clicking the Validate Frog Server link then please contact Frog Support immediately who can ensure that these options become available for you.


SIMS Export Data

There is a variety of data available to export from SIMS into Frog, each with a check box labelled retrieve beside it. Below is a list of this data, some of which is required. Any required data is greyed out so you cannot deselect it.

Basic Data

Note that this is required information and cannot be excluded from import.

  • SIMS Information
  • Version Information
  • Classes
  • Class Members
  • Pupils
  • Rooms
  • Subjects
  • Teaching Staff
  • Lesson Codes

Timetable Data

Note that this is required information and cannot be excluded from import.

  • Class Periods
  • Timetable Days
  • Period Events
  • Period Instances

Attendance

  • Attendance Summary
  • Attendance Lessons*
  • Attendance Registration*

Assessment Data

  • Grades*
  • Gradeset History*
  • Gradesets*

(the 3 below appear after a succesful validate of the server which checks if you have PEP enabled)

  • Aspects*
  • Results*
  • Templates*

SEN

  • SEN (Special Educational Needs) (this appears after a succesful validate of the server which checks if you have PEP enabled)

Behaviour

  • Negative Behaviour
  • Positive behaviour* (this appears after a succesful validate of the server which checks if you have PEP enabled)

Misc Data

  • Registration Groups
  • Non-Teaching Staff
  • Parents
(the below options are required information and cannot be excluded from import ONLY if the main parents check box is ticked)
  • ID
  • Child ID
  • Child Relationship
  • Parental Responsibility
  • Court Order
  • Title
  • Forename
  • Surname
  • Addressee
(the below options are optional information and can be excluded from import ONLY if the main parents check box is ticked)
  • Home Email
  • Work Email
  • Home Telephone
  • Work Telephone
  • Mobile Number
  • Pre Admin Parents
  • Addresses
  • Guest Pupils
  • Pre Admin Pupils


There are three options available on the bottom right hand section of the Extractor:

  • Un Check All --> When clicked this option simply deselects all available checkboxes for the different data types.
  • Check All --> When clicked this option simply selects all available checkboxes for the different data types.
  • Save & Exit --> When clicked the extractor configuration page will close and save any changes you have made.




Running Test Connection
This is where you can test the connection to your SIMS.Net system that you set in the previous section. When you click Run Test the application will attempt to connect to SIMS.Net using the username and password supplied. A dialog will be shown to indicate the test is running.




You will also see test results showing alongside the data options to indicate the success of the test run and the amount of data that is available for extract.





This test may take several minutes as it checks all the selected data options as well as the connection to SIMS.Net. This test does not check if the location of the Frog Server has been entered correctly. If there are any difficulties connecting to your SIMS Server from the Extractor, it will notify you in the bottom left corner of the Configuration screen. This test will check the username and password as well as installing any required reports into SIMS. If the test fails at any point, this will be reported in the dialog box.





You can view the specific issue by clicking "View Test Report" to open up a small report of the Test Log. This will display the report from the test, where you can investigate the settings used and the error reported.







Additional Settings & Options

These options give access to a variety of sub-menu options. The three main options are:

  • File - Access to sub-menu options that allow you to save the settings and exit

the configuration utility.

  • Tools - A variety of tools to further help with extracting the SIMS.Net data
  • Help - Information about the Frog SIMS Extractor and a documentation link.





File

The File menu option has three sub-menu options:

  • Save - Saves the current settings.
  • Save and Exit - Saves the current settings and exits the configuration utility.
  • Exit - Exits the configuration utility without saving any changes you have made.

Tools

The Tools menu option has four sub-menu options:

  • Photos - Opens a dialog that allows photos to be extracted from SIMS.Net.
  • Documents - Opens the document import area
  • Settings - Opens a settings dialog where you can change some basic configuration options
  • OAuth - Connects your SIMS extractor to your frog server and sets up the trust relationship between the two. This is used for importing SIMS linked documents.
(0 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please complete the below captcha challenge (we use this to prevent automated submissions).