Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Simple File Networking Mechanics

The steps below describe the mechanics of activating a BrightAuthor/BrightAuthor:connected presentation using Simple File Networking (SFN):

  1. Authoring (in BrightAuthor or BA:connected) generates a set of files/folders that the player will need in order to play the published presentation schedule.
  2. The set of files/folders includes a sync spec (current-sync.xml or current-sync.json), which is a manifest of the files and their download URLs on the SFN server.  These URLs are based on the URL for web folder (aka Base URL) set in the SFN parameters.
  3. The user is expected to make the generated file/folder set available on the web server so the player can download them. If transferring via FTP, binary transfer is required because the assets in the pool folder have no file extension so some FTP clients will assume that they are 7-bit text and corrupt the files on upload.
  4. The player periodically downloads the sync spec from the SFN server at the URL for web folder (that is, Base URL) with /current-sync.xml or /current-sync.json appended:
    • The downloaded spec does not immediately replace the sync spec currently in use. The sync spec download interval and URL for web folder (aka Base URL) are initially set on the player when it is configured for SFN usage, then is (re)set by the retrieved sync spec upon application of a new schedule.
    • If the sync spec retrieved from the SFN server does not match the sync spec currently in use, the current presentation continues to play while the player goes through the sync spec, downloading files that do not already exist on the player's storage. Currently, up to four files are downloaded at a time.
  5. Once all files from the new sync spec are downloaded successfully and the file size matches what's specified in the sync spec, the player will activate the new presentation schedule and reboot. If the Delay Schedule Change Until Current Media Completes Playback option is enabled in BrightAuthor or BrightAuthor:connected for the currently-running presentation, the schedule change and reboot will not occur until currently-playing video ends.

The SFN server will be impacted as follows:

  • One sync spec download request per player at the configured update interval.
  • One sync spec download request when a player (re)boots.
  • Up to four simultaneous download requests per player.
  • Storage is needed for published presentation content. Note that BrightSign tools do not manage the server's storage, so old/unused content is not removed automatically. The SFN folder(s) should should be periodically cleared just before a new published file/folder set is copied in.


Simple File Networking Server Requirements

  • Configured MIME types (in addition to default HTML/Javascript types)
  • . (no file extension): application/octet-stream
  • .bsfw: application/octet-stream
  • .rok: application/octet-stream
  • .brs: text/plain
  • .json: application/json
  • .xml: text/xml

Note that directory browsing on the server is not required because the player will directly download all files via the download URLs in the sync spec.