TULIP DOCS (LTS9 REV2)
Overview
User Requirements
Product Specs
Test Cases
Release Notes
Bug Fixes
specs/models/M_ANALYSIS

Analysis

An Analysis is a visual display of data from the following data sources within Tulip

  • App (single or many)
  • Table (single)
  • Machine (single or many)

App: Data is organized around App Completions from the past

Table: Data is current values in Table Rows

Machine: Data is past events from OPC tags that are stored in attributes

It is defined via:

  1. A “Chart Template” that determines the type of display - bar chart, table etc.
  2. A set of configuration fields and their current values. The available configuration fields depend on the Chart Template.

This doc will review all the possible configuration fields for each chart template and data source combination.

Additionaly, Chart Layers allowing to create Insights are detailed at the end of this page.

Fields For All Chart Templates

Name Description
Name Name of the Analysis
Sharing Refresh Seconds- the frequency that the visual display will refresh with new data. Minimum 5 seconds.

Public Link - An optional public link that will allow anyone to view data in the analysis

Download Image- Download the current state of the analysis in a PNG image

Apps (Apps data source only) A list of apps that act as a data source for this analysis
Compare By A categorical value that will determine if the baars should be split up by different colors
Date Range (apps only) The date range for values that will be considered in this chart based on when the app completion with the data point occurred
Filters Any exclusion or inclusion rules for data in this chart
Table (table data source only) The table data source for the analysis
Date Range (tables only) The date range for values that will be considered in this chart.
The user can select one of two system generated fields as a reference:
  • Created At
  • Updated At
Machine (machine data source only) The machines under a specific machine type that will be considered in the analysis
Date range (machine data source only) The date range for values from OPC tags that should be considered based on when the OPC tag outputted a value
Display A series of options to change the display of data on the chart, including:

Switch X Axis and Colors: Switch the “Compare By” and “X Axis” values

Hide Legend: Hide the legend on top of the chart

Hide X Axis Label

Hide X Axis Tick Labels

Hide Y Axis Tick Labels

Customize Change the way that names of different variables, table data, machine data, and summary operations appear on the chart

One Operation

This displays one variable or table field on the X axis and a numerical value on the Y axis.

Name Description
X Axis The data point whose values will determine the categorization of data on the graph
Y Axis The numerical data point that will be organized based on the X Axis values

For datetime values:
GROUP VALUE - Grouping of data by minute, hour, day, week, month, quarter or year.
Display

Chart Types

  • Bar Chart
  • Donut Chart
  • Line Chart
  • Pareto Chart
  • Dot Plot
  • Histogram (App and Table analyses only)

X Axis Scaling
Available when X Axis datatype is "datetime".

  • Use ordinal scale (Data points equidistant)
  • Use time scale (Data points' distance proportinal to time difference)

Compare Variables (bar chart)

This displays multiple numerical or boolean variables or table fields on the X axis and a numerical value on the Y axis.

Name Description
X Axis (apps data only) Choose the variables with numerical or boolean values that you would like to compare on the chart
Y Axis The numerical values that you would like to compare on the chart
Display

Chart Types

  • Stacked Bar Chart
  • Grouped Bar Chart
  • Multiseries Line Chart
  • Grouped Dot Plot
  • Overlaid Histogram (App and Table analyses only)
X Axis (table data only) Choose the table fields with numerical or boolean values that you would like to compare on the chart
X Axis (machine data only) Choose the machine fields with numerical or boolean values that you would like to compare on the chart

Multiple Operations (bar chart)

This displays multiple numerical or boolean variables or table fields on the X axis and up to 2 numerical Y axes. Only the Y axis related to the first defined operation will be shown.

Name Description
X Axis (apps data only) Choose the variables that you would like to compare on the chart
Compare Choose the 2 different Y axes that you would like to show on the chart
Display Chart Types

Stacked Bar Chart

Grouped Bar Chart

Multiseries Line Chart

X Axis (machine fields only) Choose the machine fields that you would like to compare on the chart

Results on X Axis (bar chart)

This shows individual app completions on the X axis and a numerical or boolean value on the Y Axis.

Name Description
Y Axis The list of numerical variables or table fields to compare for each individual app completion
Display Chart Types

Bar Chart, Donut Chart, Line Chart, Pareto Chart, Dot Plot

Scatter Plot

This shows one numerical table field or variable on the x axis and a numerical value on the Y axis.

Name Description
X Axis Choose the variables with numerical values that you would like to compare on the chart X axis
Y Axis Choose the variables with numerical values that you would like to compare on the chart Y axis
Sorting The direction of the X axis- either values are either increasing or decreasing

Also includes a “limit” input to limit the number of data points on graph

Display Chart Type

Table

Single Number

This shows a single numerical value. Can be whole number or percentage.

Name Description
Number (app data only) Specify the numerical value that should be displayed
Number (table data only) The numerical value that should be shown based on a single value from a Table Row or a rollup value from multiple Table Rows
Number (machine data only) The numerical value derived from a rollup of many Machine State Changes

Slideshow

This shows a single Image variable or table field with any user-defined text variables or table fields alongside it. There is one “slide” in the “slideshow” per app completion.

Name Description
Image Determines which image variable should be used in each step of the slideshow
Columns Additional data points from the app completion that should be shown alongside the image in the slideshow

Tables

Tables show single rows of data per app completion OR rows for each value of a user-defined variable in the “Groupings” section. For example, one row per user.

Name Description
Groupings Determines what should make up a row in the table- either individual values from app completions or common values across many app completions
Operations The columns that should be shown for each grouping- can be numerical or categorical
Sorting The order of rows- can be based on a numerical value in any column

Also includes a “limit” input to limit the number of data points on graph

Record Limit

All analyses are limited to a maximum of 1000 visualized records. If the analysis configuration would return more than 1000 records, last 1000 records are shown. "Last" is defined by a descending order of the X Axis values.

Example: If the X Axis is configured to be a datetime field, the most recent 1000 records will be shown.

Layers

Layers can be added to certain chart types in Tulip to generate Insights. Insights are pieces of information that are extracted from or created using the data visualized in the analysis.

Control Chart Layer

This layer can be added to Tulip Table analyses with the following configuration:

  • Template: One Operation
  • Display type: Line Chart
  • X Axis: any
  • Y Axis: Numeric value (Number, Integer, Interval)

The Layer can be turned on in the "Chart Layers" side panel which can be accessed using the "Chart Layers" button in the top right corner of the analytics editor. The following configuration options are available:

OptionDescription
Upper Control Limit (UCL) and Lower Control Limit (LCL) - mandatoryNumber input defining the upper and lower control limit used for evaluating the control chart rules. The UCL must be larger than the LCL.
Center LineConfiguration of the center line used for evaluating the control chart rules. If "Middle Center Line" is selected, the average of the UCL and LCL will be used. If "Custom Center Line" is selected, the user can specify any value between the UCL and LCL.
Rule Selection - at least one must be selectedConfiguration of the rules to be evaluated by the Control Chart Layer to generate insights. See rule description below.

The following rules are available:

Rule Name / InsightLogicVisualization
Single OutlierAny single data point above the Upper Control Limit (UCL) or below the Lower Control Limit (LCL).Outliers are visualized with a red outline in the chart.
Prominent Shift9 or more consecutive data points either entirely above or entirely below the center line.Prominent Shifts are visualized by a red background highlight in the chart.

Forecast Layer

The Forecast layer in Tulip’s Analytics Builder provides out-of-the-box forecasting for time-series data. The layer uses machine learning to evaluate the existing data in you analysis to predict and visualize a likely future development of that data as a 95% confidence interval.

This layer can be added to Tulip Table analyses with the following configuration:

  • Data Source: Tulip Table
  • Template: One Operation
  • View: Line Chart
  • x-Axis: Time-series, grouped by day
  • y-Axis: Numeric value (Number, Integer, Interval)

Once a chart configuration is fulfilling these requirements, the Forecast Layer will be available in the Chart Layers panel. This can be opened by clicking on the Chart Layers button in the top right corner of the analytics editor.

The following configuration options are available:

OptionDescription
Forecast StrategyThere are three forecast strategies available. Selecting the right one for your use case can improve your forecast quality.

  • Unlimited: Use this strategy if the numeric data you are visualizing can theoretically attain any value.
  • Positive: Use this forecast strategy for numeric data that cannot be negative, such as part count or defect count.
  • Interval: Use this forecast strategy when the numeric value is constrained in a specific way, such as a measurement of minutes per hour, where data must be between 0 and 60.
  • Selecting the ‘Interval’ strategy prompts you to input the upper and lower limits before the forecast is displayed.
    • Prediction PeriodThe number of days to be shown as a forecast.

    Tests

    IDName
    QA-T101Analytics - Table Analytics
    QA-T134Record Placeholders : 08 - Delete Record Placeholder
    QA-T208Analytics - Analytics Widget
    QA-T259Analytics - Machine Analytics
    QA-T280Analytics - Analytics Widget Filtering
    QA-T281Analytics - Analytics Widget Filtering (Machine-based)
    QA-T353Analytics Template - Single Number
    QA-T354Analytics Template - One Operation
    QA-T355Analytics Template - Compare Variables
    QA-T356Analytics Template - Multiple Axes
    QA-T357Analytics Template - Table
    QA-T358Analytics Template - Slideshow
    QA-T359Analytics - Analytics Sharing
    QA-T360Analytics - Analytics Copying
    QA-T361Analytics - Analytics Refresh Rates
    QA-T473Schedules and Shifts : 03 - Applying shifts in analytics
    QA-T803Advanced Analytics : 01 - Control Chart Layer
    QA-T820Advanced Analytics : 01 / Control Chart Layer
    QA-T927Table Analytics - Filtering by 'Date Range' settings
    QA-T962Analytics - Analytics Widget (cloned)
    QA-T963Analytics - Analytics Widget Filtering (Machine-based) (cloned)
    QA-T964Analytics Template - Single Number (cloned)
    QA-T965Analytics Template - One Operation (cloned)
    QA-T966Analytics Template - Compare Variables (cloned)
    QA-T967Analytics Template - Multiple Axes (cloned)
    QA-T968Analytics Template - Slideshow (cloned)
    QA-T969Analytics - Analytics Copying (cloned)
    QA-T970Analytics - Analytics Refresh Rates (cloned)
    QA-T971Analytics - Analytics Widget Filtering (cloned)
    QA-T972Analytics - Analytics Sharing (cloned)
    QA-T974Analytics Template - Table
    QA-T975Advanced Analytics : 01 - Control Chart Layer
    QA-T977Advanced Analytics : 03 / Red Tabs (cloned)
    QA-T978Advanced Analytics : 01 / Control Chart Layer (cloned)
    QA-T980Analytics - Machine Analytics (cloned)
    QA-T981Analytics - Table Analytics (cloned)
    QA-T985Advanced Analytics : 02 - Forecast
    QA-T987Advanced Analytics : 02 / Forecast
    QA-T988Advanced Analytics : 03 - Trend Line

    Requirements

    IDRequirement
    PLAT-8728 (249)Provide the ability to print the material history record
    PLAT-8733 (246)All tracked information must be available for reporting
    PLAT-8739 (463)Ability to browse (view and display) forward and backwards batch/lot and material genealogy at all level of the material tracking hierarchy.
    PLAT-8742 (247)All tracked information must be available for visualization
    PLAT-8746 (104)All tracked information must be accessible and viewable for users in a workflow.
    PLAT-8749 (61)Data from connected end-points can be visualized in graphical format such as gauges, indicator, dial, scales, etc.
    PLAT-8751 (60)Data from connected end-points can be visualized as simple metrics
    PLAT-8790 (245)All tracked information must be available for analysis
    PLAT-8795 (833)Abillty to view and perform analysis on all captured data, including audit trail and annotations
    PLAT-8796 (832)Ability to view and perform analysis on audit trail data
    PLAT-8800 (464)Ability to perform analysis on batch/lot and material history records. Ie query history records based on any attribute of the material
    PLAT-8832 (242)Ability to retrieve all historized information for a specific equipment with date-time filters
    PLAT-8844 (372)Track the real-time status of all equipment instances
    PLAT-8860 (97)Visibility to equipment allocation during work order and batch/lot execution to determine future equipment availability during dispatching activities
    PLAT-8875 (831)Ability to manage an authorized change of Digital History Record with full audit trail
    PLAT-8876 (427)Ability to track material attributes during production operations with associated capabilities to browse their history and their trending e.g. temperature, assays, etc.
    PLAT-8884 (95)Ability to view material information for a batch/lot in an App. Information includes all material as part of a material hierarchy, ie. cohort, plate, well, etc.)
    PLAT-8919 (407)Ability to track of material waste and scrap as part of the production process execution.
    PLAT-8967 (76)Ability for content to display relevant process and production data in either graphical format. Ie. pareto, bar graphs, pie graph
    PLAT-8973 (352)All tracking history information must be retained for historical review and analysis for a configurable retention period