This extension allows a SilverStripe instance communicate with Tribals EBS4 Student Management System via a web service. You can customise your own read only web service queries, giving you full access to the student database.
Use composer to install the module:
$composer require otago/ebs
Then create an EBS user:
If you do not have permission to do this, you may need to seek your SMS administrator.
After create a app/_config/ebs.yml file with your EBS web service user details in it:
---
Name: EBSWebservice
---
OP\EBSCheckInstance:
prod: https://ebs-live.organisation.domain/Rest/
testingurl:
test: https://ebs-test.organisation.domain/Rest/
dev: https://ebs-dev.organisation.domain/Rest/
checkendpoint: Modules/15866/Screens/u_webservicescreen/Data/datalink
.env
EBSUSERNAME="myebsusername"
EBSPASSWORD="mypassword"
EBSLOCATION="https://ebsOneWebServices-dev.myorganisation.org/Rest/"
Use a VPN or Firewall rules to secure data can only move between EBS and your web server.
You can do this with agent designer in client allows SMS users to create SQL queries that feed into JSON web services. There are plenty of out of the box SQL queries which you can use such as searching (see example 3).
See docs/ folder
- Reading a service
- Creating a learner
- Creating an application - with a dynamic search
you can view the living document here: