General Reference
Analysis Template Browser Columns
The table in the Analysis Browser page displays details about the analysis templates available. This topic provides a list and description of the Analysis Browser table columns.
Column | Description |
---|---|
ANALYSIS NAME | The analysis template associated with an asset or classification. |
CLASSIFICATION/ASSET NAME | The asset classification or the asset instance that is associated with the analysis template. |
CREATED DATE | The date on which the Analysis template was created. |
CREATED USER | The name of the individual who created the analysis template. |
KIND | The kind of view that is applied to the analysis template. |
TEMPLATE TYPE | The template type, Classification or Instance, based on the assets or asset instance to which the analysis tempalte is associated. |
UPDATED DATE | The date on which the analysis template was last updated. |
UPDATED USER | The name of the individual who last updated the analysis template. |
VISIBILTY | The type of visibility, Public or Private, based on the users to whom the analysis template is visible. |
Chart Options
The following table describes the Chart Options that can be used to configure how multiple charts on a card appear:
Chart Option | Description |
---|---|
One-Up | Displays one chart per row that utilizes the full horizontal space on the card. The following variations apply:
|
Two-Up | Displays two charts side-by-side on the card. The following variations apply:
|
Three-Up | Displays three charts side-by-side on the card. The following variations apply:
|
Four-Up | Displays four charts side-by-side on the card. The following variations apply:
|
Preview | Displays a panel to the right that contains an accordion view of all the charts on the card. You can expand a thumbnail for a chart in the panel by selecting the relevant accordion. Double-tapping the chart, appears to the left of the panel. The following variations apply:
|
Chart Types
The following table describes the requirements of each chart type available in Predix Essentials:
Chart Type | Requirement |
---|---|
Time-Series (Line) | At least one tag must be present on the chart for data to appear. |
Time-Series (Scatter) | At least one tag must be present on the chart for the data to appear. |
Timing Diagram | At least one tag must be present on the chart for the data to appear. |
Parallel Axis | At least three tags must be present on the chart for data to appear. |
X-Y (Line or Scatter) | Two tags must be present on the chart for data to appear. |
Spiderweb | At least three tags must be present on the chart for data to appear. |
Polar | An amplitude and phase tag must be present on the chart for data to appear. |
Data Table | At least one tag must be plotted on to the table for the data to appear. |
Bar | At least one tag must be present on the chart for data to appear. This chart type is only available for Event Based Query analysis. |
Chart Line Colors
The following table describes what the colors of the lines used in a chart indicate:
Line Color | Indication |
---|---|
Black | Tags with top 5 records. |
Blue | Tags with the most recent data. |
Green | Tags with data in between recent and oldest. |
Yellow | Tags with the oldest data. |
Statistical Functions
The following table describes the statistical functions that can be added to tag expressions:
Function | Example | Description |
---|---|---|
AVG | AVG(x1,x2,x3,...) | Average of the comma separated list of values. |
MAVG | MAVG(t,n) | Moving average on the data set returned by evaluation Tag t, over n number of data points to calculate averages (The argument to MAVG can only be a tag and not an expression). |
MAX | MAX(x1,x2,x3,...) | Average of the comma separated list of values. |
MEDIAN | MEDIAN(x1,x2,x3,...) | Median of a comma separated list of values (middle value from a corresponding sorted list). |
MIN | MIN(x1,x2,x3,...) | Minimum value from a comma separated list of values. |
SUM | SUM(x1,x2,x3,..) | Addition of a comma separated list of values. |
Math and Trigonometric Functions
The following table describes the math and trigonometric functions that can be added to tag expressions:
Function | Example | Description |
---|---|---|
ABS | ABS(x) | Absolute of value x. |
ACOS | ACOS(x) | The arccosine (in radians) of the given number if it is between -1 and 1; otherwise, NaN. |
ASIN | ASIN(x) | The arcsine (in radians) of the given number if it is between -1 and 1; otherwise, NaN. |
ATAN | ATAN(x) | The arctangent (in radians) of the given number. |
ATAN2 | ATAN2(x) | The arctangent of the quotient of the given arguments. |
CEIL | CEIL(x) | The smallest integer greater than or equal to the given number. |
COS | COS(x) | The cosine of the given number (x is a number given in unit of radians). |
COT | COT(x) | The cotangent of a value. Defined as 1 / TAN(x). |
CSC | CSC(x) | The cosecant of a value, defined as 1/SIN(x). |
EXP | EXP(x) | A number representing e^x, where e is Euler's number and x is the argument. |
FLOOR | FLOOR(x) | A number representing the largest integer less than or equal to the specified number. |
LOG | LOG(x) | The natural logarithm (base e) of the given number. If the number is negative, NaN is returned. |
MOD | MOD(x,y) | Remainder of x divided by y. |
POW | POW(x,y) | A number representing the given base taken to the power of the given exponent (x= the base number, y= the exponent used to raise the base). |
RANDOM | RANDOM() | A floating-point, pseudo-random number between 0 (inclusive) and 1 (exclusive). |
ROUND | ROUND(x) | The value of the given number rounded to the nearest integer. |
SEC | SEC(x) | The secant of a value, defined as 1/COS(x). |
SIN | SIN(x) | The sine of the given number (x is a number given in radians). |
SQRT | SQRT(x) | The square root of the given number. If the number is negative, NaN is returned. |
TAN | TAN(x) | The tangent of the given number (x is a number representing an angle in radians). |
Search Modifiers
The following table lists the search modifiers that can be used to narrow the search results to specific tags and the results of the modifiers:
Search Modifier | Result |
---|---|
name: tag or asset instance name | Tags or assets matching the characters entered within the enterprise. |
sourceKey: unique identifier | A single tag or asset that uses the unique identifier entered. |
inContext: asset context | Selected assets and their associated tags within the enterprise. |
ofClass: classification name | Assets or tags that are associated with a specific class within the enterprise. |
<attributeName>: attribute value | Assets or tags within the enterprise that use the selected attribute value. |
Template Information Categories
The following table describes the categories of information that appears in the Template Information bar:
Category | Description |
---|---|
Owner | The owner of an alert when accessed from an alert. |
Make | The asset model. |
Asset Type | The class for the selected asset. |
Analysis Type | Ad Hoc Analysis or Template, depending on if the analysis view was saved as a template. Templates are analysis views selected in the View Selector. |
Applied To | A selection made during template creation for the applicability between the instance and the class. |
Published To | A selection made during template creation for the analysis view between My Templates and Public Templates. |
SmartSignal Marker Visibility Configurations
The following table describes the configurations that determine the visibility of the SmartSignal markers:
Configuration | Description |
---|---|
Type | Available rules that trigger SmartSignal markers. |
Marker Symbol | Distinct colored symbols that appear on a SmartSignal chart when a marker rule is triggered. |
Position | Markers can be positioned above or below SmartSignal charts. Marker position is shown as Top 1, Middle 2, and Bottom 3. More than one type of marker can be placed in a lane. |
Order | Order controls how each marker overlaps. Each lane has five levels, 5 being the top, and 1 being the bottom. This means that some markers may be superimposed over another marker in SmartSignal charts. |
Visibility | Visibility displays if the selected rule is enabled. |