Skip to content
English
  • There are no suggestions because the search field is empty.

How To Bulk Import Screen Sync Groups Via CSV.

Screen Sync groups can be created in bulk using a CSV import, making it quick to set up synchronised playback across a large screen estate.

Overview

Screen Sync groups can be created individually within the CMS, but where an estate is large, creating groups one at a time can be time-consuming.

The Import via CSV option in the Screen Sync app allows multiple sync groups to be created in a single upload.

This guide covers the requirements for the import, the exact CSV format required, and how to resolve common import errors.


Before You Start

⚠️ There are three requirements that must be met before the import will succeed.

Please confirm all three before building your file.

1. You will need the PIN of every screen you want to include in a sync group

The import matches screens by PIN, not by screen name, so this list is needed before you begin. PINs can be obtained by exporting your screen data from the CMS β€” see How to Export Screen Data to a CSV File.

2. You will need the IP address and port of the WebSocket sync server device. This is a required field on the import and cannot be added later. If you are unsure of this, please check with whoever manages your network.

3. Every sync group needs a minimum of two screens β€” one parent screen and at least one child screen. A row containing a parent screen with no child screen will fail to import.

πŸ’‘ Tip: The screens themselves must already exist in the CMS before you import. The CSV import creates sync groups from existing screens β€” it does not create new screens.


Step 1 β€” Export Your Screen Data to Get the PINs

You will need the PIN of every screen that will act as a parent or a child in a sync group.



Export your screen list to CSV by following How to Export Screen Data to a CSV File. This gives you all the PINs in a format you can copy directly into the import template.

Step 2 β€” Download the Import Template

  1. Open the Screen Sync app
  2. Click Add Sync group
  3. Click Import via CSV
  4. On the import screen, click to download the blank CSV template
  5. Open the template in Excel or Google Sheets

Screenshot 2026-08-27 at 15.48.14



The File Format

One sync group per row. All screens belonging to a group sit side by side across a single row. Group names run vertically down column A, one group per row.


Column

Header

Contents

A

Sync Group Name

The name you want to give the sync group

B

Parent WebSocket Server Address

IP address of the sync server, followed by the port: 8081

C

Parent Screen

PIN of the parent screen

D onwards

Child Screen 1, 2, 3...

PIN of each child screen, one per column


Column A β€” Sync Group Name

Enter your group names vertically, one per row. Each row becomes one sync group.


Column B β€” Parent WebSocket Server Address

This is the IP address of the device running the sync server, followed by the port number, in the format IP:portβ€”for example: 192.168.1.225:8081

⚠️ NOTE: 


πŸ’‘ Tip: The port varies by platform. Check the Screen Sync setup guide for your hardware to confirm the correct port before filling this in.


Column C β€” Parent Screen

Must be the PIN of the parent screen β€” not the screen name.


Column D onwards β€” Child Screens

Each child screen goes in its own column, using its PIN. Fill these left to right: Child Screen 1 in column D, Child Screen 2 in column E, and so on.

  • To add more child screens than the template provides, add further columns to the right and continue the naming pattern (Child Screen 14, Child Screen 15...). There is no limit to how many screens can be added to a single group.
  • At least one child screen is required. Every group must contain a minimum of two screens, so Child Screen 1 in column D cannot be left blank for any row.
  • Groups can have different numbers of children. If one group has 2 screens and another has 12, leave the unused child columns blank on the shorter rows β€” this will not cause the import to fail.

⚠️ Common mistake to avoid: Do not list a group's screens vertically down the sheet, one screen per row. This will create a separate sync group for every screen. All screens belonging to a group must sit across a single row.


Step 3 β€” Save and Upload

  1. Save the file as CSV (not .xlsx)
  2. Return to the import screen in the Screen Sync app
  3. Upload the file

Import via CSV


 

Step 4 β€” Check the Results

The import processes each row independently, so a single invalid row will not block the rest of the file from importing.

Any rows that fail will be listed with a specific error message, and the full list of errors can be downloaded as a CSV for review.


Most common causes of a row failing:

  • Missing Sync Group Name in column A
  • A PIN that does not exist in the CMS β€” usually a typo, or a screen that has not yet been created
  • Missing or malformed server address in column B, for example a missing port
  • Missing parent PIN in column C
  • Fewer than 2 screens on the row, i.e. a parent screen with no child screen

Error Report



Summary

The Screen Sync CSV import allows multiple sync groups to be created in one upload, rather than building each group individually. Before starting, confirm you have the PIN of every screen involved, the IP address and port of the relevant WebSocket sync server, and that each group will contain at least two screens.

Each sync group must be entered across a single row, with the group name in column A, the server address in column B, the parent screen PIN in column C, and each child screen PIN in its own column from column D onwards. The import will process valid rows even if others fail, and any errors can be downloaded as a CSV for review.



 

πŸ“– Further Reading: How to Export Screen Data to a CSV File