Skip to main content

Invite Code Flow

Connecting a school to your organisation portal is done through a secure invite code handshake. This process ensures both the organisation and the school explicitly agree to the connection.

Step-by-Step Guide​

Step 1: Generate an Invite Code (Organisation Portal)​

  1. Log into your organisation portal.
  2. Navigate to Connected Schools.
  3. Click Add School or Generate Invite Code.
  4. The system generates a unique invite code in the format ORG-XXXX-XXXX.
  5. Copy the code or note it down.

The code is valid for a limited time (typically 24 hours). If it expires before the school enters it, you can generate a new one.

Step 2: Share the Code with the School​

Send the invite code to the school administrator through a secure channel (e.g., email, phone, or in-person). The school administrator will need this code to initiate the connection from their end.

Step 3: Enter the Code (School Instance)​

The school administrator performs these steps in their Junipa school instance:

  1. Navigate to Administration > Organisation Connection.
  2. Click Connect to Organisation.
  3. Enter the invite code provided by the organisation (ORG-XXXX-XXXX).
  4. Click Validate.

Step 4: Validation and Handshake​

When the school validates the code:

  1. The school instance contacts the organisation portal to verify the code.
  2. If valid, the school generates a school code (format: SCH-XXXX-XXXX) and sends it back.
  3. The organisation portal receives the school code and completes the handshake.
  4. Both sides confirm the connection.

This entire process happens automatically once the school clicks Validate. No further manual steps are required.

Step 5: Confirm the Connection​

After the handshake completes:

  • In the organisation portal, the school will appear in the Connected Schools list with a "Healthy" status indicator.
  • In the school instance, the organisation connection will show as "Connected" with the organisation name displayed.

Troubleshooting​

IssueCauseSolution
"Invalid code" errorThe code has expired or was entered incorrectly.Generate a new invite code in the organisation portal and try again.
"Code already used" errorThe code has already been redeemed by another school.Generate a fresh invite code.
Connection shows "Pending"The handshake did not complete. This may be due to a network timeout.Wait a few minutes and refresh. If the issue persists, disconnect and try the process again with a new code.
School not appearing in portalThe handshake completed on the school side but the portal has not refreshed.Refresh the Connected Schools page. If the school still does not appear, check that the school's Junipa instance is online.

Disconnecting a School​

If you need to disconnect a school from the organisation:

  1. Navigate to Connected Schools in the organisation portal.
  2. Find the school you wish to disconnect.
  3. Click Disconnect.
  4. Confirm the action.

The school will be removed from the organisation portal. The school's own data and operations are not affected.