Skip to end of metadata
Go to start of metadata

Description

The analysis controller is an invisible component that makes analysis data available for reports and other components. The term invisible component means that the control appears during design time, but is not visible during runtime.

 

 

Component Palette


 

Add columns into the dataset of the analysis controller from a custom property dataset

Code Snippet
#Get the table data from the Analysis Controller
ds1 = event.source.parent.getComponent('Analysis Controller').tableData
colCount = ds1.getColumnCount()
#Get the custom property 'Area'
columnName = event.source.parent.getComponent('Analysis Controller').Area #Area is the column to be added
columnData = [] 
for i in range(ds1.getRowCount()):
 	columnData.append(i* 10)
#Adds 'Area' to the Analysis Controller's dataset
ds2 = system.dataset.addColumn(ds1, colCount, columnData, columnName, int)
event.source.parent.getComponent('Analysis Controller').tableData = ds2

 

Component Properties

Properties are provided that can be set to affect the operation and look of the component. They can be set through the Property Editor in the Designer or through scripting.

Example
event.source.parent.getComponent('Analysis Controller').refreshOnPropertyChange = True

 Data
NameScriptingProperty TypeDescription
Table DatatableDataDatasetAnalysis results in table format.
Chart DatachartDataDatasetAnalysis results in chart format.
Analysis UUIDanalysisUUIDStringUnique identifier representing the analysis results.
Line Chart DatalineChartDataDatasetAnalysis results in line chart format.
Refresh on Property ChangerefreshOnPropertyChangebooleanIf true, automatically refresh when property values change.
Refresh on Results ChangerefreshOnResultsChangebooleanIf true, automatically refresh when the cached data on the gateway associated with this analysis controller is invalidated.
Drill Down OptionsdrillDownOptionsDatasetDataset containing drill down options.
Previous Drill Down EnabledpreviousDrillDownEnabledbooleanIf true, then prevDrillDown() can be called.
Key Column NameskeyColumnNamesStringKey column names used to combine data.
Child 1 DatachildDataDatasetChild 1 analysis source data.
Child 1 Column NamechildColumnNameStringColumn name to create for child 1 data.
Child 2 DatachildData2DatasetChild 2 analysis source data.
Child 2 Column NamechildColumnName2StringColumn name to create for child 2 data.
Day CountdayCountintThe day count.
Provider NameproviderNameStringName of the provider. Options are Downtime, Run, TEEP, Comments.
FilterfilterStringThe filter section allows you to limit the data that is included in the analysis. See Filter By section below to view the list.
Compare BycompareByStringCompare Bys are the factors used to compare the analysis data. See Compare By section below to view the list.
Data PointsdataPointsString

Data points are the individual pieces of information that will be present in the analysis. See Data points section below to view the list.

Start DatestartDateDateTimeStart Date to filter results.
End DateendDateDateTimeEnd Date to filter results.
Error MessageerrorMessageStringThe error message.
Warning MessagewarningMessageStringThe warning message.
Verbose processing outputverboseintWhen set to 1, logs verbose processing data. Do not use for production.

Filter By

 Click here to see the list
Analysis Provider: Comment
Area
Enterprise
Line
Package Count
Product Code
Production Units
Run
Shift
Site
Analysis Provider: Downtime
Active Runs
Area
Automatic Cell Name
Automatic Cell Group Name
Automatic Reason
Cell Name
Cell Group Name
Downtime For
Enterprise
Line
Note
Operator Reason
Package Count
Planned Downtime
Product Code
Production Units
Reason
Recordable Downtime
Run
Run Identifier
Schedule Type
Shift
Shift Sync
Site
Stop Type
Top
Work Order

Note

One can select multiple Work Orders writing directly to the custom property using the pipe character "|"

as a separator (example: <WO-X>|<WO-Y )


Analysis Provider: OEE
Area
Cell Name
Enterprise
Hour Of Run
Line
Package Count
Product Code
Production Units
Run
Shift
Site
Analysis Provider: Schedule
Area
Enterprise
Line
Package Count
Product Code
Production Units
Run
Shift
Site
Analysis Provider: TEEP
Area
Enterprise
Line
Package Count
Product Code
Production Units
Run
Site

Compare By

 Click here to see the list.
Analysis Provider: Comment
Area
Day
Enterprise
Line
Month
Package Count
Product Code
Production Units
Run
Shift
Site
Week
Analysis Provider: Downtime
Area
Automatic Reason
Cell Name
Enterprise
Line
Operator Reason
Package Count
Product Code
Production Units
Run
Shift
Site
Analysis Provider: OEE
Area
Cell Name
Day
Enterprise
Hour Of Run
Line
Month
Package Count
Product Code
Production Units
Run
Shift
Site
Week
Analysis Provider: Schedule
Area
Enterprise
Line
Package Count
Product Code
Production Units
Site
Analysis Provider: TEEP
Area
Enterprise
Line
Package Count
Product Code
Production Units
Run
Site

Data Points

 Click here to see the list
Analysis Provider: Comment
Area
Comment
Date
Entered By
Enterprise
Line
Package Count
Product Code
Product Code Description
Production Units
Run
Shift
Site
Analysis Provider: Downtime
Area
Automatic Reason
Cell Name
Enterprise
Line
Occurrences
Operator Reason
Package Count
Product Code
Production Units
Run
Shift
Site
Analysis Provider: OEE
Area
Cell Downtime
Cell Infeed Count
Cell Name
Cell Package Count
Cell Production Count
Cell Production Units
Cell Run Time
Cell Standard Count
Cell Target Count
Cell Waste Count
Date
Enterprise
Hour Of Run
Line
Line Infeed Count
Line Production Count
Line Standard Count
Line Standard Rate
Line Standard Rate Period
Line Target Count
Line Waste Count
OEE
OEE Availability
OEE Performance
OEE Quality
Package Count
Product Code
Production Units
Run
Run Downtime
Run Elapsed Time
Run Planned Downtime
Run Time
Shift
Site
Analysis Provider: Schedule
Actual Finish Time
Actual Run Start Time
Actual Start Time
Area
Enterprise
Line
Package Count
Product Code
Product Code Description
Production Units
Run
Scheduled Finish Time
Scheduled Quantity
Scheduled Run Start Time
Scheduled Start Time
Site
Analysis Provider: TEEP
Area
Enterprise
Line
Loading (Actual)
Loading (Scheduled)
OEE
OEE Availability
OEE Performance
OEE Quality
Package Count
Product Code
Production Units
Run
Shift
Site
TEEP (Actual)
TEEP (Scheduled)

 

Event Handlers

Event handlers provide the ability to add custom script when a user interacts with a component.

 analysisUpdate

This event gets fired whenever the analysis data is populated either in the table data or in the chart data.

 progressStart

Is fired when this component begins to process property changes. Useful for displaying an "in progress" message during processing.

PropertyDescription
.sourceThe component that fired this event.
 beforeUpdate

Is fired before any update of the analysis data.

PropertyDescription
.sourceThe component that fired this event.
 afterUpdate

Is fired after every updates of the analysis data.

PropertyDescription
.sourceThe component that fired this event.
 progressEnd

Is fired when this component completes property changes. Useful for displaying an "in progress" message during processing.

PropertyDescription
.sourceThe component that fired this event.

 


 

Extension Functions

This component does not have extension functions associated with it. 

 


 

Custom Methods

Custom methods allow you to add your own component functions to a component that can be called through scripting. This is a useful and clean method of re-using script that is specific to the component (say you want to update a visual aspect of the component in the same way whether a user clicks on the component or a window property value changes). See Component Custom Methods in the Ignition Help Manual for more information.

 


 

Customizers

This component does not have any custom properties.


 

Component Functions

This component provide the following functions that can be called on it. If this component has been dropped onto the windows root container, the path and an example call would be event.source.parent.getComponent('Analysis Controller').prevDrillDown().

 drillDown(drillDownName, item)
  • Description

Sets all the analysis selections to new state dictated by the drill down definition.

  • Parameters

String drillDownName - A drill down definition name. This is typically supplied by the drill down event of one of the display components.

String item - A drill down category. This is typically supplied by the drill down event of one of the display components.

  • Return

Nothing

  • Scope

Client

 prevDrillDown()
  • Description

Sets all the analysis selections to the previous state before the last drill down.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

 addDatasetColumn(dataset, columnName, keyColumns)
  • Description

This method is used for reporting. Because the Ignition Report module does not support master slave table relationships, this method is used to add new columns containing a Dataset with child rows. For each row in the analysis controller results, a child Dataset will be created and placed into the new column named specified by the columnName parameter. The rows in the child Dataset are determined from the Dataset specified in the dataset parameter and match the column value specified by the keyColumns parameter.

  • Parameters

Dataset dataset - Dataset containing child rows.

String columnName - Name of column to add that will contain the child dataset.

String keyColumns - Name of columns to break the child row up by. Multiple key columns can be specified by separating then with a comma.

  • Return

Nothing

  • Scope

Client

 update()
  • Description

Causes the results to be updated.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

 deleteRun(runUUID)
  • Description

Marks the run as deleted for analysis purposes. This run and associated data will not appear in any analysis datasets.

Must use "Run, Run Identifier" as the "Compare By" for this method to work.

  • Parameters

String runUUID - The unique Run Identifier for the run to delete.

  • Return

Nothing

  • Scope

Client

 restoreDeletedRun(runUUID)
  • Description 

Restores a previously deleted run. Must use "Run, Run Identifier" as the "Compare By" for this method to work. Use "Deleted Runs=Show" as the filter to show runs that have been deleted.

  • Parameters

String runUUID - The unique Run Identifier for the run to restore.

  • Return

Nothing

  • Scope

Client

  • No labels