Tulip Docs

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:

A “Chart Template” that determines the type of display - bar chart, table etc.
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.

Properties 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
Table (table data source only)	The table data source for the analysis
Machine (machine data source only)	The machines under a specific machine type that will be considered in the analysis
Date Range	Apps data The date range for values that will be considered in this chart based on when the app completion with the data point occurred Machine data 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 data The date range for the "Start Time" of machine activity entries that will be considered.
Filters	Any exclusion or inclusion rules for data in this chart.
Compare By	A category to split out the data into multiple series.

Formatting Options

The formatting options are configured in the formatting tab of the Visualization panel on the right side of the analytics editor. They are grouped into different sections whose availability is dependent on the chart type.

Title & Subtitle

Applies to all charts.

Name	Description
Title	Default: Shows the title of the analysis at the top left of the chart None: Hides the title Note: The title can be edited in the top left corner of the analytics editor by clicking on it.
Subtitle	Default: Shows a subtitle at the top left of the chart. If selected, an additional input field allows to enter a title. None: Hides the subtitle

X Axis

Applies only to charts with a X axis.

Name	Description
Label	Defines if and what axis label is shown. The options are: Default: Shows the label define by the data selected for the X axis. Custom: Allows to enter a custom label. None: No label is shown.
Axis Scaling Only available when a datetime value is selected for the x axis	Defines what scale is used for the X axis. The options are: Time Scale: The X axis distance between any two data points are proportional to their time stamp difference. Ordinal Scale: The X axis distance between neighboring points is always the same, independent of their time stamp difference.
Show X Axis Tick Labels	Defines if axis tick labels for the X axis are shown.
Tick Label Rotation	Defines the degree rotation of tick labels. Available options are 0°(default), 45° and 90°.

Y Axis

Applies only to charts with a Y axis.

Name	Description
Label	Defines if and what axis label is shown. The options are: Custom: Allows to enter a custom label None: No label is shown
Show Y Axis Tick Labels	Defines if axis tick labels for the Y axis are shown.
Bounds	Allows to set fixed bounds for the maximum and minimum of the Y axis.

Series & Legend

Applies to all charts but single number, table and slideshow.

Name	Description
Show Legend	Legend is shown on the chart when toggled on.
Customize Series	Allows to set the name and color for each series shown in the chart

Data Labels

Applies only to the donut chart.

Name	Description
Show Labels	Defines if the data labels for the different donut segments are shown.

Line

Applies only to line and multiline charts.

Name	Description
Interpolation	Allows to select if the line interpolation is smooth or straight. The default setting for new analyses is straight

Individual Templates

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 Options	Bar Chart Donut Chart Line Chart Pareto Chart Dot Plot Histogram (App and Table analyses only)

Compare Variables

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	The variables (App analysis), Table fields (Table analysis) or machine fields (machine analysis) that will be shown for comparison on the X axis of the chart
Y Axis	The numerical value values for each selected variable or field.
Display Options	Stacked Bar Chart Grouped Bar Chart Multiseries Line Chart Grouped Dot Plot Overlaid Histogram (App and Table analyses only)t

Multiple Operations

This displays multiple numerical or boolean variables or table fields on the Y axis across the same X axis. Available for

Name	Description
X Axis	The value for the common X Axis
Y Axis	The values to be compared across the common X Axis For datetime values: GROUP VALUE - Grouping of data by minute, hour, day, week, month, quarter or year.
Display Options	Stacked Bar Chart Grouped Bar Chart Multiseries Line Chart Grouped Dot Plot Overlaid Histogram (App and Table analyses only)t

Results on X Axis

This shows individual app completions on the X axis and a numerical or boolean value on the Y Axis. Available only for App analyses.

Name	Description
Y Axis	The list of numerical variables or table fields to compare for each individual app completion
Display Options	Bar Chart Donut Chart Line Chart Pareto Chart Dot Plot Histogram (App and Table analyses only)

Scatter Plot

This shows one numerical table field or variable on the x axis and a numerical value on the Y axis. Available only for App analyses.

Name	Description
X Axis	The variable to be shown on the X Axis.
Y Axis	The variable to be shown on the Y Axis.
Sorting	Allows to select a field and direction for sorting.
Limit	Limit the number of data points shown on the graph.

Single Number

This shows a single value based on a variable, field or expression.

Name	Description
Number	The variable, field or expression to be shown.

Slideshow

This shows images of a single image variable and additional variable values next to it. Available only for App analyses.

Name	Description
Image	The image variable shown in the slideshow.
Columns	Additional app data that should be shown alongside the image in the slideshow.

Table

This shows a tabular overview of the selected data.

Name	Description
Groupings	The variables (App analysis), Table fields (Table analysis) or machine fields (machine analysis) used for grouping the source data. This drives which rows are shown in the table.
Operations	Additional fields or aggregations whose value should be shown for each grouping. For datetime values: GROUP VALUE - Grouping of data by minute, hour, day, week, month, quarter or year. Note: If an operation does not include an aggregation (like average, count, ...), the result will show an individual row for each value of the operaiton.
Sorting	Allows to select columns which the table should be sorted by.
Limit	Limits the nubmer of data points shown on the graph.

Limits

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.

Series Limit

All analyses are limited to a maximum of 50 visualized series. If the analysis configuration would return more than 50 series, the first 50 are shown. If this is the case, a warning icon is shown on the chart to surface it to the user.

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.

Layers can be configured in the Layers tab of the Visualization panel on the right side of the analytics editor.

Control Chart Layer

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

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

The Control Chart layer offers two different limit settings with different configuration options.

Static Limits

Allows to manually define an upper and lower control limit and a center line to use single outlier and prominent shift rules.

Option	Description
Upper Control Limit (UCL) and Lower Control Limit (LCL) - mandatory	Number input defining the upper and lower control limit used for evaluating the control chart rules. The UCL must be larger than the LCL.
Center Line	Configuration 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 selected	Configuration of the rules to be evaluated by the Control Chart Layer to generate insights. See rule description below.

Calculated Limits

Automatically identifies appropriate boundaries for single outlier detection based on the currently visible data and an acceptance range (6 sigma equivalent). Upon initially selecting this option, the limits are automatically calculated.

Option	Description
Calculate Limits (button)	Recalculates the limits based on the currently visible data. Below the settings, the time since the last calculation and related timestamp are shown.
Rule Selection - not changeable	For the calculated limits, only the Single Outlier rule can be selected.

Rules

The following rules are available:

Rule Name / Insight	Logic	Visualization
Single Outlier	Any 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 Shift	9 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.

Alerting can be used with the Control Chart layer and will alert when new single outliers or prominent shifts are detected.

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 analyses with the following configuration:

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:

Option	Description
Forecast Strategy	There 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 Period	The number of days to be shown as a forecast.
Show estimated trend	Toggles showing a line depicting the trend that is estimated by the forecasting model.
Evaluate Forecast	Triggers a quality evaluation for the forecast, which shows: Mean Absolute Error Median Percentage Error To execute the evaluation the number of data points must be more than 2 weeks and greater than five times the prediction period.

Trend Line Layer

The Trend Line layer adds a linear trend line to charts in Tulip Analyitcs. It can be added to anlayses with the following configuration:

Template: One Operation
View: Line Chart, Bar Chart, Dot Plot
x-Axis: Any
y-Axis: Numeric value (Number, Integer, Interval)

Once a chart configuration is fulfilling these requirements, the Trend Line 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:

Option	Description
Type	Allows to change between a linear and moving average trend line. The default is linear.
Period	The period option becomes available when the moving average type is selected. It defines how many data points should be considered for the moving average caluclation. This value has to be between 2 and 50.

Reference Line Layer

The reference line layer adds a horizontal line to charts in Tulip Analytics. It can be added to analyses with the following configuration:

Template: One Operation
View: Line Chart, Bar Chart, Dot Plot
x-Axis: Any
y-Axis: Numeric value (Number, Integer, Interval)

Once a chart configuration is fulfilling these requirements, the Trendline 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:

Option	Description
Value	The y-axis value at which the line will be shown
Highlight Data	Defines if data elements (bars, line points or dots) in the chart which relate to the reference line values in a specific way should be highlighted. The options are: Above Equal or above Equal or below Below None
Color	Defines the color of the highlighting
Label	Defines if a label should be shown on the reference line. If "Custom" is selected, an additional input field appears, allowing to specify the label.

Alerting can be used with the Reference Line layer and will alert when new data elements become highlighted.

Alerting

Alerting is available for the Control Chart layer and the Reference Line layer.

When alerting is turned on, Tulip will automatically check for new insights in the background every hour and send an email the the users specified in the "Recipients" list in the Alerts panel.

For the Control Chart, insights are outliers or prominent shifts. For the Reference Line, insights are highlighted data elements.

The email contains:

The name of the analysis
The timestamp of evaluation
The type and count of new insights
A link to the analysis

Tests

ID	Name
QA-T101	Analytics - Table Analytics
QA-T134	Record Placeholders : 08 - Delete Record Placeholder
QA-T208	Analytics - Analytics Widget
QA-T259	Analytics - Machine Analytics
QA-T280	Analytics - Analytics Widget Filtering
QA-T281	Analytics - Analytics Widget Filtering (Machine-based)
QA-T353	Analytics Template - Single Number
QA-T354	Analytics Template - One Operation
QA-T355	Analytics Template - Compare Variables
QA-T356	Analytics Template - Multiple Axes
QA-T357	Analytics Template - Table
QA-T358	Analytics Template - Slideshow
QA-T359	Analytics - Analytics Sharing
QA-T360	Analytics - Analytics Copying
QA-T361	Analytics - Analytics Refresh Rates
QA-T473	Schedules and Shifts : 03 - Applying shifts in analytics
QA-T717	Analytics - Table analytics CSV export
QA-T803	Advanced Analytics : 01 - Control Chart Layer
QA-T819	Advanced Analytics : 06 / Format Chart for Different Templates
QA-T820	Advanced Analytics : 01 / Control Chart Layer
QA-T826	Advanced Analytics : 07 / Red Tabs
QA-T927	Table Analytics - Filtering by 'Date Range' settings
QA-T974	Analytics Template - Table
QA-T985	Advanced Analytics : 02 - Forecast
QA-T987	Advanced Analytics : 02 / Forecast
QA-T988	Advanced Analytics : 03 - Trend Line
QA-T989	Advanced Analytics : 03 / Trend Line
QA-T1116	Advanced Analytics : 04 / Trend Line - Moving Average
QA-T1117	Advanced Analytics : 04 - Trend Line - Moving Average
QA-T1177	Advanced Analytics : 05 - Reference Line
QA-T1181	Advanced Analytics : 05 / Reference Line
QA-T1211	Analytics - Analytics Widget Font customization
QA-T1280	Universal Template - Data types : 01 - Table-based analysis
QA-T1281	Single Value visualization shows label instead of value
QA-T1283	Advanced Analytics : 08 - Analytics Dashboard Performance

Requirements

No requirements