Dropbox Sync Settings

Settings

JavaScript API Documentation

Other Resources


Overview

Our integration with Dropbox API allows you to sync content from your Dropbox account to the Kiosk Pro Documents folder on your device. This means you can store files locally on the iPad and have the ability to remotely update them via your Dropbox account. This integration makes remote updates easier, especially for those who need to update both settings and local content remotely.

Default: Off

Important: Content will only sync between Dropbox and Kiosk Pro when the kiosk presentation is running (and not while the app settings screen is shown). If you would like a visual indication that sync is occurring, you can turn on Show Update Indicator under Remote Update of Local Files.

Content Location on Dropbox

Once you've linked Kiosk Pro with your Dropbox account, Kiosk Pro will create a folder structure in Dropbox: Apps > Kiosk Pro.

Inside the Kiosk Pro folder will be two folders:

  • A Shared Content folder, named 'SharedContent' by default, but can be renamed in Kiosk Pro settings. Files placed into the Shared Content folder will sync to all of your kiosks that have a Shared Content folder of the same name. This is helpful if you have multiple kiosks that use the same content.
  • A Unique Content folder, named after the Unique iPad ID you set in Kiosk Pro settings. A unique ID must be set in order to sync unique content to a kiosk. Files placed into the Unique Content folder will only sync to your kiosk with the Unique iPad ID that matches this folder's name.

If you update or delete a file on Dropbox, the same will happen to the file in Kiosk Pro. You can use the Dropbox Synchronization for any file type, including your remote settings .xml file.

Content Location on the Device

Shared Content folders on Dropbox sync directly into the main Kiosk Pro Documents folder on your device, while Unique Content folders on Dropbox sync into a folder called 'UniqueContent' inside the Kiosk Pro Documents folder. This means the file paths for each folder are different.

For example, if your homepage is in the Kiosk Pro Documents folder and is linking to a PDF in the Shared Content folder, the path from your homepage would just be 'example.pdf'. If the PDF is in the Unique Content folder, the path from your homepage would be 'UniqueContent/example.pdf'.

Example

You have three kiosks. Each of the three kiosks uses a different video for the screensaver, but display the same HTML file as the homepage.

You can set up all three devices to point to the same Shared Content folder and put the HTML file into that Shared Content folder to sync it to every kiosk. You can then use the Unique Content folder for each kiosk to sync the different versions of the video file used for the screensaver to each one.


Account Information

How to Login to Dropbox:

  1. In Kiosk Pro settings, under Dropbox Synchronization select Account Information.
  2. Choose Link and log into your Dropbox account.
  3. Go back to the main settings screen. Your account name should now be on the right of Account Information where it previously said Link.
  4. Toggle Enable to On.

Once you hit Run Kiosk Presentation, Dropbox will automatically create a folder structure for you and begin to sync. From the main Dropbox folder, it will create Apps > Kiosk Pro. The Kiosk Pro folder is where your Unique Content and Shared Content folders will go.

If the 'Apps' or 'Kiosk Pro' folder is deleted from Dropbox, the linked account will be logged out of Dropbox in Kiosk Pro. If the Unique Content Folder is deleted from Dropbox or Kiosk Pro, and if Kiosk Pro is running, the Unique Content Folder will be created again.

How to Unlink Your Dropbox Account:

  1. In Kiosk Pro settings, under 'Dropbox Synchronization' select 'Account Information'.
  2. Choose 'Unlink'.
  3. A notification confirming that your account had been unlinked will appear. Press 'OK'.

Shared Content Folder

On Dropbox, the folder will be created inside the 'Kiosk Pro' folder. This folder is named 'SharedContent' by default, but you can change the name in the Kiosk Pro app settings under 'Dropbox Synchronization > Shared Content Folder'.

Any kiosks synced to this folder will receive its content, which will go directly into the Kiosk Pro Documents folder.

Uploading and deleting files in the Shared Content Folder on Dropbox will be uploaded and deleted in Kiosk Pro's Documents folder. However, uploading and deleting files in Kiosk Pro's Documents folder will not affect the Shared Content Folder on Dropbox.


Restricted Sync List

This settings allows you to restrict certain files and folders in the Shared Content folder from syncing to your kiosk. This setting only applies to the Shared Content folder and can not restrict things from syncing from the Unique Content folder.

The path is relative to the Shared Content folder, so the input should start with the file or folder name you want to restrict. For example, if the path is 'video.mov', this file will not sync from Dropbox to the kiosk. If there are multiple files that need restricted, you can separate them with semicolons. For example, 'video.mov;demo.pdf' will restrict both the .mov file and the PDF.

You can also use wildcards (*) to stand in for certain parts of a path. For example, '*.pdf' would restrict any PDF file from syncing.


Unique Content Folder

The Unique Content Folder allows users to sync content to and from a specific kiosk.

If you have a Unique iPad ID set in your Kiosk Pro settings, an additional folder will be created inside the "Kiosk Pro" folder on Dropbox named with the Unique iPad ID. Kiosk Pro will also automatically create a folder in the main Kiosk Pro Documents titled "UniqueContent". For example, if your Unique iPad ID is set to "hallway", the folder on Dropbox will be called "hallway". If you do not have a Unique iPad ID set, these folders will not be made.

Files that are changed in the Unique Content Folder on Dropbox will be changed in Kiosk Pro's "UniqueContent" folder. The only time files in Kiosk Pro's Unique Content folder will sync back to Dropbox is when one of our JavaScript API calls are triggered to make changes to a file. For example, when using the Capture API to save form data to a CSV file, when the API is called to save the data to the CSV file, this file will sync back to Dropbox.

If a file from the Unique Content folder is used as the kiosk Homepage, the path would need to include the "UniqueContent" folder. For example, if you are trying to access a file called "index.html", the path for the Homepage should be set as "UniqueContent/index.html".


Log Sync Sessions

The 'Log Sync Sessions' feature allows you to automatically create a record of sync sessions that shows which files have been synced with your individual kiosks.

If 'Log Sync Sessions' is enabled (as by default), Kiosk Pro will log any changes made to files on the device by Dropbox, including timestamps of file creation, modification, and deletion. These logs are stored in .csv format in the UniqueContent folder for each kiosk.

As these are records for individual kiosks, you must have a Unique iPad ID configured in Kiosk Pro settings to enable a UniqueContent folder for that kiosk, otherwise logging will not occur.

For a kiosk named 'Hallway', the sync log would be named '__Hallway_syncLog__.csv' and would be located at:

  • Dropbox/Apps/Kiosk Pro/Hallway/__Hallway_syncLog__.csv
  • Kiosk Pro's Documents/UniqueContent/__Hallway_syncLog__.csv

Please note during testing that you make sure the .csv document is not left open during a sync session as this could possibly cause a scenario where the sync log is overwritten and does not accurately reflect the state of the kiosk. Changes to the sync log itself are not logged (as this would create a feedback loop).


Using Remote Settings Control with Dropbox

You can sync your Remote Settings XML template to your kiosk using Dropbox, allowing you to store it locally while still having access to it remotely.

To do this, you will need to have both Dropbox Synchronization and Remote Settings Control turned on and configured. For Remote Settings Control, the file path to your .xml file is set in relation to where it is located in the Kiosk Pro Documents folder. For example, if your file is "settings.xml" and it is in the Shared Content folder (which means it syncs directly into the main Kiosk Pro Documents folder), your XML location path would just be "settings.xml". If it is stored in the Unique Content folder, your location path would be "UniqueContent/settings.xml".

Dropbox folder settings can also be controlled via Remote Settings Control. If you are using Remote Settings Control, make sure you edit the template to correspond with the Dropbox settings you've changed on the device. Note: Your Dropbox account can only be linked by a user in Kiosk Pro settings as this requires direct authentication; it is not possible to link a device to Dropbox using the Remote Settings Control.


Clearing Sync History

If you are having issues with Dropbox not syncing, it is now possible to clear all previous sync history and requests to start with a fresh sync process. In Kiosk Pro settings, go to the 'Account Information' setting and 'Clear Sync History'. Once the sync history is marked to be cleared, the next time the kiosk presentation is run, a new sync cycle will be triggered to sync all files.


Limitations

The only limitation that we've run up against to date in using Dropbox is the number of files to be transferred.

We don't have a hard number here since this limitation appears to be a function of how the API communicates, but we've only seen issues with syncing projects with a very large number of files (>1,000). A vast majority of projects do not come up against this limit, but if you are architecting a new project where you plan to use Dropbox sync, we recommend doing so in a way that keeps the total number of files required to a minimum.

Still stuck? How can we help? How can we help?