Xporter: Connect to WCBS PASS
Summary
Pre-requisites the school must complete ahead of your appointment to set up Xporter on Demand for WCBS PASS.
Answer
Scope
- Steps to ensure a successful session with our team to install Xporter on Demand for WCBS PASS.
- You will need to book an appointment with our onboarding team via the invitation you received for the education application that has asked you to setup XoD.
Instructions
1. Before you can set up access for Groupcall Xporter, your WCBS Pass will need to be set up for API access. Guidance on this can be found in your WCBS Customer Centre, or you can contact WCBS directly for further assistance.
- Note: When you grant access for Groupcall, this is access to the underlying Wcbs.Api and the Wcbs.Api swagger sub-site. This does not give Groupcall access to the WCBS API Licence Management website. Read our guide for further information: Best Practice: Xporter and MIS Permissions.
2. Once you have setup API access, go to the Third Party Licences tab within WCBS Pass.
3. Click Add new third party.
4. Enter the required details and click Save.
5. When Save is clicked, the View Third Party Licence page is displayed which includes the Credentials for the new Licence.
6. Use the icon next to the Client ID and Client Secret fields to copy this information.
7. To connect to the WCBS API, Groupcall Xporter needs to be supplied with the: Client ID, Client Secret and the WCBS.API URL.
- Note: For security reasons, do not send all these credentials in the same email. Use separate emails for each or contact our onboarding team by phone.
8. Click Close and you will be returned to the Third Party Licences tab where the new third party should be listed.
9. Clicking the icon will allow you to view the credentials for the API again.
10. Clicking the icon will allow you to edit the record and regenerate the credentials for the API.
11. At the time of your chosen appointment, our onboarding team will give you a call to let you know your school is being setup for XoD. They will ask you to provide the required API credentials if you have not sent them already, including your PASS School ID.
12. Once our team have finished installing Xporter on Demand, you will see a healthy green tick status in your School Portalaccount. Read our guide if you are unsure of your login details: How To: Reset your XoD Password.
- Note: Your authorised education application can now begin extracting data (this usually happens overnight).
Connecting Xporter to Pass Using SQL
- Using the API connection is preferable because it is more reliable and offers much greater compatibility with 3rd party applications.
- If, however, you are not able to set up the API connection, it is still possible to connect Xporter directly to the SQL database.
- To connect in this way, Xporter will need to be installed locally and preferably on the SQL server itself.
- Groupcall Xporter requires an SQL account setting up which has the db_reader permission.
- During your installation appointment, our team will need to know:
- PASS SQL Server Name
- PASS SQL Database Name
- PASS SQL Account credentials for Groupcall Xporter
- PASS SchoolID (e.g. ZZ)
