TULIP DOCS (LTS4)
Overview
User Requirements
Product Specs
Test Cases
specs/overview/S_PLAYER

Tulip Player

The Tulip Player is an Electron-based application built by Tulip for operators to run Tulip apps. These apps are created on the "App Editor" Page.

Once installed on a device and configured by a user with "create" permissions for Stations, it can run the set of apps and versions that are determined by the "Shop Floor" Page.

Initialization Process

  1. Download the Tulip Player from download.tulip.co.
  2. Launch the Tulip Player Application on your tablet, laptop or phone.
  3. Type your Tulip account name into the open window (Ex: 'my_instance'.tulip.co is the account name)
  4. A user with "create" permissions for stations must enter their email and password to authenticate the device.
  5. Name the device (e.g 'Station 1 Touchscreen')
  6. Choose an existing Station or create a new one.
  7. If you would like to run the "Development Version" of the app in the Player, you must open up the "Shop Floor" page in Tulip and change the Station settings to run the "Development Version" of all permitted apps.

Running Applications on the Tulip Player

The Tulip Player collects data from applications that were originally created by Tulip users. App data is stored in the Tulip database when the app is "completed". An app is "completed" when a Trigger with the "Complete App" transition is executed.

Once data is stored from an application, it cannot be modified or deleted. The main components of the Tulip Player:

  1. The menu screen - Individual apps are shown according to their location in the nested hierarchy of app groups. From this screen an operator can:
    • Change their preferred language
    • Sign out - When a user logs out the display will show the login screen. To login an operator must again input their username and password.
    • Search for an app by name (note, only apps assigned from the stations UI show up in this menu)
    • Mute Sounds - Mute all default sounds that are created by navigation buttons while running apps in the Player
  2. Timed Logout - If there are no user UI actions (button presses), or device inputs (barcode scanners), for a predetermined amount of time, the display will log the user out and show the login screen. The amount of time is determined on the Account Settings Page.
  3. Saving Data - Any time an application is run to completion a core data set is captured and stored in the database, along with any other variables that the User has configured to store into the application. For more information see the Application Audit Trail doc.

Model Connections

Here's how apps run in the Player can manipulate different Models in the Tulip system.

User

View

  • Within apps, a user can view all the values within User Fields associated with users that are inlcuded in an Embedded Table Widget.
  • Within apps, a user can view the name of the logged-in user via the Variable Text Widget.

Edit

  • Within apps, a user can edit the values of each individual User Field for a given user if they fire a Trigger with relevant actions.

Table

View

  • Within apps, a user can view an entire table via the Embedded Table Widget.

Table Record

View

  • Within apps, a user can view a single Table Record via the Table Record Text Widget.
  • Within apps, a user can view many Table Records from a single Table via the Embedded Table Widget.

Edit

  • Within apps, a user can edit the values of a Table Record when they run a Trigger with relevant actions.

Create

  • Within apps, a user can create a Table Record when they run a Trigger with relevant actions.

Delete

  • Within apps, a user can delete a Table Record when they run a Trigger with relevant actions.

Station View

  • Within apps, a user can view the name of the station where the app is being run via the Variable Text Widget.

Variable View

  • Within apps, a user can view the name of the where the app is being run via the Variable Text Widget.

Step, Signature Step, Regular Step, Form Step View

  • Within apps, a user can view the steps that they are sent to via Trigger logic.

Widget, Form Input

View

  • Within apps, a user can view Widgets and Form Inputs that have been embedded on the Step that they are currently viewing.

App Version Completion Create

  • Within apps, a user can create an App Version Completion by firing a Trigger with a "Complete App" Transition.

View

  • Within apps, a user can view past App Version Completions via an embedded Table analysis.

Analysis

View

  • Within apps, a user can view analyses that are embedded on the current step via the Analysis Widget.