Xporter: Enable Access in Bromcom

Summary

Xporter on Demand (XoD) is the service that collects data from Bromcom via a Third Party User before delivering it to authorised education applications.

Scope

  • A guide to enabling the Groupcall Xporter connection in Bromcom. This enables Xporter on Demand to be supplied with data from Bromcom.

Instructions
1. Log into Bromcom with a user account that has access to the e-Setup module.

2. Go to Modules > Setup > System Security > System Users.


3. Click New to create a new account.

4. Under Personal Details, enter the following details:

  • First Name - Groupcall
  • Last Name -  Xporter

5. Under User Login Details, enter the Username (we recommend using Groupcall) and a enter a Password.

  • Note: These details will be needed by XoD so that it can connect to Bromcom.

6. Ensure that The user can log into system is ticked, and User must change password at next logon is not ticked.

7. Further down the page, tick Third Party.
8. Click Save changes.


9. The new account must also be granted specific permissions so that it can access the necessary areas of data in Bromcom.

10. Go to Third Party Access Permissions & Logs.


11. Choose the Groupcall User that you just made from the Third Party Account dropdown menu.  Then click Manage Permissions.


12. Select all the permissions listed below.

AddressesPeople
AdministrationDoctorTelephonesPersonAddresses
AssessmentAssociationAssessmentTypesPersonCommunications
AssessmentAssociationSubjectsPersonMedicalConditions
AssessmentAssociationTermsPersonMedicalEvents
AssessmentAssociationYearGroupsPersonParamedicalSupportTypes
AssessmentGradeSetGradesPersonPhotos
AssessmentGradeSetsPersonTelephones
AssessmentGradeSetVersionsPreAdmissionGroups
AssociationAssessmentMarksetsPupilPremiums
AssociationAssessmentMarksetVersionsRoomCovers
AssociationAssessmentMarksheetsSchools*
AssociationAssessmentResultsSeries
AssociationAssessmentTemplateColumnsSeasons
AssociationAssessmentTemplatesSENStudentNeeds
AttendancesSENStudents
BehaviourEventAdjustmentsStaff
BehaviourEventCategoriesStaffContracts
BehaviourEventLinksStaffCovers
BehaviourEventRecordsStaffFlatView
BehaviourEventsStaffQualifications
BehaviourStudentActionsStudentAdditionalInformation
CalendarModelsStudentContacts
CalendarsStudentDetentions
CandidatesStudentEnrolments
ClassesStudentExclusions
CollectionAssociatesStudentImportedCTFAssessments
CollectionExecutivesStudentInformation
CollectionExecutivesRoleTypesStudentLearning
CollectionHierarchyStudentMealPatterns
CollectionsStudentMeals
DisabilitiesStudentMiscellaneousInformation
EmailsStudentParentalConsent
EmployeeContactsStudentPastoral
EmployeeRolesStudentProtectionRegister
EthnicitiesStudents*
GypsyTravellerStudentsStudentSchoolTransportInformation
HouseClassesStudentSiblings
LanguagesStudentsInCare
LocationClosuresStudentSurgeries
LocationsStudentSurgeryDoctors
MealTypeSubjectClasses
MedicalConditionsTimeTable
YearGroupClasses
  • These API permissions are designed for maximum capability with any potential application you can connect to via XoD. Without all these permissions, we cannot guarantee that XoD will be able to access the data areas it requires, and in some cases the service may not work at all.
  • Although XoD requires the capacity to access a wide range of data, it will only collect the data that you have authorised for any 3rd party applications. Read our guide for further information: Best Practices: Xporter and MIS Permissions.

* We use the Schools and Students permissions to check that the provided login details are correct.