Synchronization Monitor

The File Synchronization Monitor provides a mechanism for periodically updating local files from a remote source.

The File Synchronization Monitor can be applied to a Broadsign Player using configuration profiles within the Administrator.

It can also be defined in the URLs tab of a particular ad copy. In the latter case, the synchronization will occur automatically on any player to which you targeted the associated ad copy.

Step One: Create a Configuration Profile

It is within a configuration profile that we enable the synchronization monitor.

  1. Create a configuration, and call it “Monitor Sync”. See Add a Configuration.
  2. Create a configuration profile for a player, and call it “monitor_sync”. See Add a Configuration Profile – Player.
  3. Open the configuration profile properties, and go to the Monitor Sync section. See The Monitor Sync Section.
  4. Enter the details of your setup in both the URLs tab and the Core tab.

Step Two: Associate the Configuration to a Player

Every player receiving the Monitor Sync update must have a configuration profile assigned to it.

  1. Open a player’s properties. See Edit Player Properties.
  2. Go to Settings > Configuration.
  3. Click Select, and then choose the configuration created above, e.g., “Monitor Sync”.

Note: The player will receive this configuration profile during the next poll to the server. See The Settings Section – The Network Tab.

Another way to enable external synchronization is to use the URLs tab of an ad copy.

If the synchronization of external data is associated to a particualar ad copy, you can avoid defining the sync globally across your domain.

The Synchronization Monitor has many different settings to configure.

Remote Url

This is the URL of the remote server from which to fetch the information. It must start with either http://, https://, or ftp://.

Destination Path

This is the location on the local player system where the synchronized content will be stored. If the path specified is absolute (i.e. c:\something), please make sure that the permissions on this folder are such that the bsp user can read and write to it.

When the path specified is relative, the files will be saved in one of the following locations:

    • Windows XP dedicated player: C:\Documents and Settings\All Users\Application Data\Broadsign\bsp\share\bsp\sync
    • Windows XP non-dedicated: C:\Documents and Settings\[USER_NAME]\Application Data\Broadsign\bsp\share\bsp\sync
    • Windows Vista and 7 dedicated player: C:\ProgramData\Broadsign\bsp\share\bsp\sync
    • Windows Vista and 7 non-dedicated: C:\Users\[USER_NAME]\AppData\Roaming\Broadsign\bsp\share\bsp\sync
    • Linux: /opt/broadsign/suite/bsp/share/bsp/sync
FTP Options

These options only apply when the URL scheme in the remote URL is set to ftp://. Sync Folder will copy the entire contents of the remote folder to the local machine, but will not recurse into sub-directories. Sync Sub-Folders will recurse into subdirectories, as well. Please exercise caution when using this option.

When using the Sync Folder option, the source URL must actually contain a real folder. For example, ftp://user:pass@ftp.example.com/folder/ would work, whereas ftp://user:pass@ftp.example.com/ will not.

Options

“Add Player Id to remote path” will dynamically change the remote URL based on the player’s ID. For example, if the remote URL is ftp://test.com/files, with this option enabled, the actual URL fetched might be ftp://test.com/files/12345 where 12345 is the ID of the player fetching the URL.

Refresh Period

Controls how often the remote URL is synchronized locally. Expressed in hh:mm:ss.

Timeout Period

Controls how long the player will wait for a server timeout. Default 30 seconds.

Remove Ad Copy from loop if unchanged in:

When a synchronization URL is attached to an ad copy, the ad copy can be removed from the loop when the associated data feed becomes stale. Typically, this is enabled when the choice is made that it is preferable to display no content instead of stale content. The specified time period can elapse because either the remote server is unavailable or the remote feed contents have not changed.