Set Up SOCS Connector

Before You Start

Are you sure you want to remove this component?

Before setting up the SOCS Connector, make sure you have administrator access to Schoolbox and the connection details supplied for your school.

  • The General Feed Host for calendar events, music lessons, and co-curricular activities.
  • The Sports Fixture Feed Host for sports fixtures, teams, and results.
  • Your SOCS Endpoint ID.
  • Your SOCS Endpoint Token.

General feeds and sports fixture feeds can use different hosts.

Configure SOCS Connection Details

Are you sure you want to remove this component?

Configure the shared SOCS credentials once, then enable the import types your school wants to use.

  1. Go to Administration > Modules > SOCS Connector.
  2. Turn on Enable SOCS Integration.
  3. Enter the following details:
    • General Feed Host: the SOCS host used for calendar events, music lessons, and co-curricular activities.
    • Sports Fixture Feed Host: the SOCS host used for sports fixtures, teams, and results.
    • SOCS Endpoint ID: your school's SOCS endpoint ID.
    • SOCS Endpoint Token: your school's SOCS endpoint token.
  4. Select Save.

Schoolbox uses these values to build the required SOCS feed URLs internally.

Import Calendar Events

Are you sure you want to remove this component?

Enable calendar events if you want SOCS calendar items to appear as Schoolbox calendar events.

  1. Turn on Import Calendar Events.
  2. Enter a Calendar Event Feed Name.
  3. Select a Default Calendar Category.
  4. Select Save.

Calendar events are automatically assigned to campuses using the Schools field provided by SOCS.

If the Schools field contains multiple comma-separated school names, Schoolbox checks each value against the campus names in Schoolbox.

Note: School names in SOCS must exactly match the corresponding campus names in Schoolbox. If no matching campus is found, the event will not be imported.

Import Sports Fixtures

Are you sure you want to remove this component?

Enable sports fixtures if you want SOCS fixture data to appear in the Schoolbox Fixtures module.

  1. Turn on Import Sports Fixtures.
  2. Select Save.

Sports fixture, team, and result feeds use the Sports Fixture Feed Host with the shared SOCS endpoint ID and token.

Import Co-Curricular Activities

Are you sure you want to remove this component?

Enable co-curricular imports if you want SOCS clubs, events, and registrations to appear in the Schoolbox Fixtures module.

  1. Turn on Import Co-Curricular.
  2. Select Save.

Co-curricular feeds use the General Feed Host with the shared SOCS endpoint ID and token.

Import Music Lessons

Are you sure you want to remove this component?

Enable music lessons if you want SOCS music lessons to appear in staff and student calendars.

  1. Turn on Import Music Lessons.
  2. Enter a Music Lesson Feed Name.
  3. Select a Default Music Lesson Category.
  4. Select Save.

Music lesson feeds use the General Feed Host with the shared SOCS endpoint ID and token. Lessons are linked to staff and students using external IDs from SOCS.

Validate and Troubleshoot the Setup

Are you sure you want to remove this component?

After saving the SOCS Connector settings, confirm that each enabled import appears in Schoolbox.

  • Calendar events appear in the Schoolbox Calendar.
  • Sports fixtures appear in the Fixtures module.
  • Music lessons appear in matched staff and student calendars.
  • Co-curricular clubs and events appear in the Fixtures module for matched pupils and staff.

The SOCS Connector page displays warnings when Schoolbox cannot map calendar events, when calendar or music feeds repeatedly fail, or when individual co-curricular records fail.

If enabled data does not appear:

  1. Confirm that Enable SOCS Integration and the relevant import setting are turned on.
  2. Check the appropriate feed host, SOCS endpoint ID, and SOCS endpoint token.
  3. For calendar events, confirm that SOCS school names exactly match Schoolbox campus names.
  4. For music lessons, sports fixtures, and co-curricular participants, confirm that SOCS staff and pupil IDs match Schoolbox user external IDs.
  5. Confirm that the corresponding SOCS feed is available.

If a warning remains after correcting the settings or source data, contact Schoolbox Support and include the warning text.

SOCS Integration Help Navigation

Are you sure you want to remove this component?

SOCS Connector Settings Reference

Are you sure you want to remove this component?

Setting

Purpose

Enable SOCS IntegrationStarts or stops the configured SOCS imports.
General Feed HostThe SOCS host used for calendar events, music lessons, and co-curricular activities.
Sports Fixture Feed HostThe SOCS host used for sports fixtures, teams, and results.
SOCS Endpoint IDThe shared SOCS endpoint ID for the school.
SOCS Endpoint TokenThe shared SOCS endpoint token for the school.
Import Calendar EventsImports SOCS calendar events into the Schoolbox Calendar.
Calendar Event Feed NameSets the source name shown for imported SOCS calendar events.
Default Calendar CategorySets the Schoolbox calendar category for imported SOCS calendar events.
Import Music LessonsImports SOCS music lessons into matched staff and student calendars.
Music Lessons Feed NameSets the source name shown for imported SOCS music lessons.
Default Music Lesson CategorySets the Schoolbox calendar category for imported SOCS music lessons.
Import Sports FixturesImports SOCS sports fixtures, teams, and results into the Fixtures module.
Import Co-CurricularImports SOCS co-curricular clubs, events, and registrations into the Fixtures module.

Important Behaviour

Are you sure you want to remove this component?

The SOCS Connector uses one SOCS endpoint ID and endpoint token for all import types. General feeds and sports fixture feeds can use different hosts.

  • Enable SOCS Integration controls whether the configured integration is active.
  • Each import type can be enabled independently.
  • The General Feed Host is used for calendar events, music lessons, and co-curricular activities.
  • The Sports Fixture Feed Host is used for sports fixtures, teams, and results.
  • Schoolbox builds the required SOCS feed URLs internally.
  • Calendar events use the configured Default Calendar Category. The SOCS Category field does not select the Schoolbox calendar category.
  • Music lessons use the configured Default Music Lesson Category.
  • Calendar-event campuses are matched from the SOCS Schools field. SOCS school names must exactly match Schoolbox campus names.
  • Staff and pupils are matched using SOCS identifiers and Schoolbox user external IDs.