Product Specs
This page provides a description as to how the Tulip product functional works and is designed. It is organized into the sections as described below.
System Overview - These describe how Tulip can be configured at the account level, and provide necessary domain information for understanding Tulip concepts.
Routes - Describe the specific views that present a user interface that is served by the admin console that let users CRUD (create, read, update and delete) specific types of data models, and relationships between models, given the appropriate access rights. The documentation of the routes effectively describes how one can use Tulip to created, edit and deploy Tulip solutions.
Models - Describe the digital objects that make up a Tulip solution. Models and attributes that are wholly contained within another model, or are only important in the context of that model, are documented in a nested format with respect to that model.
Components - Describe the complex and custom UI components that are used in multiple places throughout the Tulip platform. Simple components such as buttons, dropdowns, confirmation modals do not require documentation.
System Overview
| ID | Name | Description | # Reqs |
|---|---|---|---|
| S_PLAYER | Tulip Player | The downloadable application used to run Tulip apps | 13 |
| S_GTWY | IoT Gateway | A description of Tulip's IoT Gateway product | 0 |
| S_DESCR | The Tulip Platform | High level description of Tulip | 2 |
| S_DATA | Data Management | Overview of the systems & technologies Tulip uses | 7 |
| S_AUTH | Enterprise Authentication | Specification of enterprise authentication configurations using SAML or LDAP | 3 |
| S_AUDIT | Application Audit Trail | A description of how Tulip creates an audit trail. | 3 |
Routes
| ID | Name | Description | # Reqs |
|---|---|---|---|
| R_USRM | My Account | An interface for managing one's own user profile | 1 |
| R_USPR | User Profile | An interface for editing a user's profile and access rights | 3 |
| R_TBLS | Tables | An interface for managing Tulip Tables | 0 |
| R_TBLQ | Table Query Editor | An interface for editing all parts of a Table Query | 0 |
| R_TBLE | Table Editor | An interface for editing the schema and content of a single Tulip Table. | 1 |
| R_SWRK | Settings - Working Days | A configuration that determines the active working days for the account | 0 |
| R_SUSR | Account Settings- Users | An interface for managing users | 9 |
| R_STAT | Station | An interface for managing a station | 0 |
| R_SWRK | Settings - Working Days | A configuration that determines the active working days for the account | 0 |
| R_SPLS | Settings - Player Settings | An interface for managing all player settings in the account | 1 |
| R_SDEV | Settings - Developer Mode | An interface for managing Developer Mode settings | 0 |
| R_SDAT | Settings - Date and Time | An interface for managing the date and time settings | 0 |
| R_SCOL | Settings - Color Palette | An interface for managing the color palette for the account | 0 |
| R_SAPT | Settings - Approval Types | An interface for managing the account types available in the account | 1 |
| R_SAML | Settings - SAML Setup | An interface for managing the integration between the Tulip account and the user's SAML directory | 0 |
| R_SACC | Settings - Account | An interface for managing account settings | 0 |
| R_PLAYER_MENU | Tulip Player Menu | An interface for viewing and editing app permissions | 0 |
| R_NTWK | Settings - Network Access | An interface for managing the IP addresses and CIDR blocks that are allowed to use this account | 0 |
| R_MTYPS | Machine Types | View a list of all machine types | 0 |
| R_MTYP_DET | Machine Type Details | View and configure a machine type | 0 |
| R_MSTS | Machine States | The page for viewing a list of machine states | 0 |
| R_MLIB | Machine Library | View a list of all machines | 0 |
| R_MFLD | Machine Activity Fields | The page for viewing a list of machine activity fields | 0 |
| R_MDTS | Machine Data Sources | An interface for managing machine data sources. | 0 |
| R_MDTR | Machine Downtime Reasons | View a list of all downtime reasons | 0 |
| R_MDET | Machine Details | View and configure a machine | 0 |
| R_MATT | Machine Attributes | The page for viewing a list of machine attributes | 0 |
| R_HIST | Activity History | The page for viewing a timeline of activity records | 1 |
| R_GTWY | Gateway Manager | An interface for managing and logging into IoT Gateways | 0 |
| R_DEVM | Developer Mode | The testing experience for using the Developer Version of any app | 1 |
| R_DASH | Dashboard | An interface for viewing and editing the Dashboard model | 1 |
| R_CONNS | Connectors | The page for managing connectors | 0 |
| R_CONN | Connector | The page for managing a single connector | 1 |
| R_CONN_FUNC | Connector Function Editor | The page for editing a connector function | 1 |
| R_BOTS | Settings - Bots | An interface for managing the credentials that are allowed to access the Tulip API on this account | 0 |
| R_APPV | App Versions | An interface for viewing and managing the versions for an app | 0 |
| R_APPP | App Permissions | An interface for viewing and editing app permissions | 2 |
| R_APPO | App Overview | A view of app structure and metadata app | 1 |
| R_APPG | App Group | An interface for managing an app group | 1 |
| R_APPE | App Editor | An interface for editing the layout and logic of an app | 11 |
| R_APPD | Application Dashboard | A page for seeing the dashboard of all analyses for an app | 0 |
| R_APPC | App Completions | An interface for viewing and exporing the completion data for anapp | 9 |
| R_APPA | App Approvals | An interface for managing approval assignment for an app | 3 |
| R_ANYS | Analysis | A full page view of an analysis | 6 |
| R_ANYE | Analytics Editor | An interface for creating and editing analyses | 1 |
Models
| ID | Name | Description | # Reqs |
|---|---|---|---|
| M_USER | User | A digital record for a person granted some level of access to the Tulip System | 5 |
| M_USER_STATUS | User Status | The current state of a user with respect to the system | 0 |
| M_USER_ROLE | User Role | A named collection of specific access rights that can be assigned to a user | 6 |
| M_USER_FIELD | User Field | A custom attribute applied to the user model | 0 |
| M_TRIG | Triggers | User defined actions performed in response to events in the Tulip system. | 74 |
| M_TABLE | Table | A user defined database that easily integrates with Tulip apps. | 55 |
| M_TABLE_RECORD | Table Record | A row in a Tulip Table | 22 |
| M_TABLE_RECORD_FIELD | Table Record Field | A property for each object in the table. Sometimes called a column. | 23 |
| M_TABLE_QUERY | Table Query | A collection of Table Records that can be changed based on values in an app | 5 |
| M_TABLE_AGGREGATION | Table Aggregation | A summary value that can exist on top of a single field in a Tulip Table | 0 |
| M_STAT | Station | A configuration that connects a specific Tulip player to machines and devices | 6 |
| M_STAG | Station Group | A group of stations | 0 |
| M_PLAYER_DEVICE_MAP | Player Device Mapping | The technical details of a device that can be used in the Tulip Player | 0 |
| M_MTYP | Machine Type | A ruleset used to define the behavior of a Machine | 7 |
| M_MTRIG | Machine Triggers | If/Then logic for defining the state of a machine and other machine fields. | 5 |
| M_MSTS | Machine State | A category for the current status of a Machine | 11 |
| M_MFLD | Machine Activity Field | A field or column in a machine activity table. | 2 |
| M_MDTS | Machine Data Source | A connection to data generated by a physical machine | 2 |
| M_MDTR | Machine Downtime Reason | A data type used to classify downtime events for Machines | 1 |
| M_MATT | Machine Attribute | A unit of data for mapping between raw data and a Machine | 2 |
| M_MACH | Machine | A digital twin of equipment that generates data. | 5 |
| M_MACH_MACT | Machine Activity | A running history of state details for a machine | 2 |
| M_EXPRESSION | Expressions | A configured code snippet that returns a calculated value based on certain inputs | 2 |
| M_DASH | Dashboard | A column based layout for seeing a collection of analyses | 3 |
| M_CONN | Connector | A configuration that specifies how Tulip connects to an external data source | 21 |
| M_CONN_FUNC | Connector Function | A configured code snippet that allows apps to make requests to a connector data source | 22 |
| M_CONN_ENV | Connector Environment | A configuration for how a connector accesses a data source given the app status. | 2 |
| M_CLRS | Color Palette | Allows for defining a universal color palette that can be accessed in all apps. | 0 |
| M_BOTS | Bot | A set of credentials for using the Tulip API | 0 |
| M_APPROVALTYPE | Approval Type | A specific approval that must be accepted for an app to be published | 2 |
| M_APPGROUP | App Group | Named groupings of Apps, similar to folders in a file system. | 1 |
| M_APP | App (Application) | The set of all versions of an a app. | 9 |
| M_APP_VER | App Versions | A specific version of an app | 11 |
| M_APP_VER_VAR | Variable | Dynamic value used in apps for real time control logic | 22 |
| M_APP_VER_STEPGROUP | Step Group | A collection of steps and step groups app | 2 |
| M_APP_VER_STEP | Step | A named view in an app that can be routed to based on trigger logic and human actions | 21 |
| M_APP_VER_STEP_SIGN | Signature Step | A form step that includes an e-sig widget | 16 |
| M_APP_VER_STEP_REG | Regular Step | A step that renders a custom arrangement of widgets | 10 |
| M_APP_VER_STEP_REG_WIDGET | Widget | A UI component that can be custom configured to be on an a step | 20 |
| M_APP_VER_STEP_HIST_WIDGET | Record History Widget | A UI component that can be used to view the history of a table record | 6 |
| M_APP_VER_STEP_FORM | Form Step | A step that renders input widgets in a form | 3 |
| M_APP_VER_STEP_FORM_INPUT | Form Input | An input element for user data entry on a form step | 17 |
| M_APP_VER_RECD | Record Placeholder | A dynamic reference in an app to a table record | 0 |
| M_APP_VER_QRY | Table Query Placeholder | An instance of a Table Query that is bound to an app | 0 |
| M_APP_VER_COMP | App Version Completion | A persistent log of App execution metrics and state. | 27 |
| M_APP_VER_AGG | Table Aggregation Instance | An instance of a Table Aggregation that is bound to an app | 0 |
| M_APP_PERM | App Permission | A named role for assigning a user certain access rights to an app | 3 |
| M_APP_APPR | App Approval | An approval type assigned to an app, and the eligible approvers, required for a new version of an app to be published. | 7 |
| M_ANALYSIS | Analysis | A configuration specifying a way to retrive and represent data on a dashboard or in an app | 21 |
| M_ALLOWLIST | IP Allowlist | A set of permitted IP addresses and CIDR blocks for accessing Tulip. | 0 |
| M_ACTIVITY | Activity Record | An immutable record containing information about a change to master data | 0 |
Components
| ID | Name | Description | # Reqs |
|---|---|---|---|
| C_MENU | Menu Bar | A universal navigation bar across all routes in Tulip | 0 |
| C_ACTR | Activity Record | A card for displaying an activity record | 0 |