The Dashboard is your control panel for testing and feedback in HITS.
How do I get to the Dashboard?
The Dashboard is customised for every user. Hence, you access it via a unique URL, which was sent you in your account creation email; it looks something like this (not a working example):
Click on the Information link in the left hand menu on the dashboard to see important information about your environment, in particular your access and authorisation tokens to be used when you interact with the HITS API.
You can access the HITS Simple Client from this page to do basic testing (this is also accessible from the Client link described below).
This area provides you with the means to make additional environments for specific testing purposes.
- Provide a name for your environment (must be lowercase alphanumerics only with no spaces)
- Select the number of schools, students and staff you want
Note: very large numbers of schools, students and staff may take a while to process, so don't do it unless you actually need it!
- You can also select for the scenarios (use cases) which you want to test against, for example timetabling or financials.
Once you have selected the desired combination, click Submit. After processing, which may take many minutes, the page will return something like the following:
Use the URL returned to access your new environment.
This area contains client access functionality:
- Click on the Client link on the left hand menu on the dashboard.
- Then select your SIF Provider object from the list (eg SchoolInfo in the example below)
- Specify a method (eg GetMany)
- Accept the default parameters
- Then press Execute
. You should get an output like the following.
- Click on the Dashboard link in the LH navigation pane.
- Click the Refresh button in the top right corner.
You should see something like this:
The Dashboard results display the REST actions you have just taken, along with their status codes. You can click the unique ID to see full details of the entry, including the details and ID of the request, the request headers and body, and the response headers and body.
The list of requests in the Dashboard is persistent - you can still see the results of previous operations in your unique instance.
Click the View link to display links to the SQL database for every object supported in HITS.
Each of those links will take you to the relevant table of data for the given object for your instance - for example, StaffPersonal:
Click on the Reports link in the left hand side of the Dashboard, and select a test to report on from the pulldown box. You should see something like this:
This is a test report of the outcome of a variety of tests and validations that you can use to invigilate your test setup for a given usecase.