Gumband Web UI

Organizations and Sites

An Organization is the highest-level entity within Gumband. This is typically your company, business unit, or specific team name. Within your Organization, you can create any number of Sites to hold Exhibits and Hardware. A Site is generally the physical location where Exhibits are installed, such as different cities, building locations, or floors.

Log in to Gumband

Gumband is secured using Google Oauth and is extensible to support other third-party providers as necessary. Navigate to

in a browser and click the appropriate button to log in. If you have not been added to Gumband, you will see an unauthorized page.

Open

Open

User Permissions

Users can be added as managers or viewers within Sites and Organizations. Only Organization and Site managers can view, add, and remove users and change their permissions.

Permissions are more granular at the Exhibit level. Users can be given read and write permissions for each status, control, and setting. This is especially useful when wanting to share Exhibit information (such as health or metrics), but prevent users from accidentally modifying mission-critical settings.

Read more in https://deeplocal.atlassian.net/wiki/spaces/GS/pages/3538945.

Exhibit UI

Create a New Exhibit

1. Navigate to the Site under which this Exhibit will exist

2. Click “Create Exhibit”

3. Give your Exhibit a name

4. Optionally enter the MQTT path (usually the computer’s local IP address and MQTT port ie “192.168.1.128:1883”)

5. Click “Create”

6. Note the Exhibit ID and token for initializing the SDK

Operating Mode

Each exhibit has an operating mode (on or off). This is useful for day-to-day operation, maintenance, and support in turning off screens and disabling interactivity for exhibits. The operating mode status is displayed by the switch on the left of the Exhibit name and connection status:

• Exhibit on: if the toggle is to the right and orange

• Exhibit off: if the toggle is to the left and gray

There is also a quick indicator in the left sidebar that contains the exhibit list.

• Exhibit on: the indicator is a green lightning bolt

• Exhibit off: the indicator is a red crossed-out lighting bolt

Gumband also allows specific Controls and Settings to be available depending on the current operating mode; this is defined by the exhibit developer in the Exhibit Manifest. By default, Settings and Controls are only editable when operating mode is disabled — notice in the screenshots below how the “Reload” button is only available when the operating mode is set to off.

View Statuses

Statuses are displayed on the “Overview” tab. The list of Statuses is restricted by User Permissions. The “Overview” tab also shows a summary of the Exhibit, including read-only Settings and Hardware information.

Statuses Showing Hyperlinks

Statuses can be used to display links to helpful resources, file servers, and email addresses, even a website hosted by the exhibit. Make sure the URL to be shown has the appropriate protocol prefix, such as http:// or https://, ftp://, mailto:, etc.

Statuses can also display multi-line content by using \n, which converts to line-breaks.

Trigger Controls

Controls can be triggered in real-time from the “Controls” tab. The list of Controls is restricted by User Permissions. Controls can be disabled/enabled based on the Exhibit Operating Mode.

Update Settings

Settings are shown as read-only on the “Overview” tab and editable on the “Settings” tab. The list of Settings is restricted by User Permissions. Settings have types such as string, integer, dropdown, etc.

Manage File Content

Users can upload files to the Exhibit through the “Content” tab. Files uploaded can be accessed through the SDK, which allows users to easily swap static asset files used by the Exhibit.

Manage Hardware

To view Hardware connected to an Exhibit, visit the “Hardware” tab. Users can also update the Exhibit’s MQTT path (IP address and port) and connect new Hardware. Note that only Hardware under the current Site that is not connected to another Exhibit will be available.

View Developer Logs

Exhibit logs can be viewed under the “Logs” tab. Logs are updated in real-time as they are emitted by the SDK. Users can also filter logs based on a timeframe as well as the event type (debug, info, warn, or error). This allows Exhibit managers to debug any problems that may have occurred throughout the lifespan of the Exhibit. Exhibit logs are stored for 3 months.

View a Report

Reports can be viewed under the “Reports” tab. These are reports of a combination of Gumband and user-defined events that can be triggered by the SDK. These reports can consist of number of user interactions, number of Hardware failures, and more. The daily distribution also helps to do a more granular analysis of Exhibit events. Raw Report data can also be exported as a CSV.

Schedule Events

Events can be scheduled under the “Schedule” tab. Events are a combination of controls, settings, and operating mode changes that occur at a predefined time. Scheduling provides an easy way to make sure certain controls and settings are activated or modified in time. Events can also be set to recur. This is especially useful for Exhibits that have a standard start-of-day and end-of-day procedure.

Configure Notifications

Notifications can be activated through the “Notifications” tab.
Users added to the Exhibit can configure email alerts for relevant critical changes to the Exhibit including:

• Custom Exhibit Notifications (from the SDK)

• Hardware Add/Remove

• Schedule Changes

• Exhibit Deletion

• Exhibit Connection

• Operating Mode Change

Manage Auth Tokens

Auth tokens are automatically generated when the Exhibit is first created. These tokens are used by the SDK to authenticate and connect to the Exhibit. Once created, token values are not visible through the UI for security reasons, so it is important to store these values somewhere safe. A user can generate additional tokens through the UI under the “Auth” tab. Tokens can also be deleted if they have been compromised or lost.