iSPCChart Reference

The SPC chart object can process and display data sets of thousands of observations per tag in a variety of standard Statistical Process Control (SPC) charts.  The supported chart types are listed below in the iSPCChart Types table.

Each SPC chart also includes the following information:

• A full set of summary statistics, appropriate for the analysis type;

• Both raw data views and full statistical calculation result views;

• SPC Rule Violations, with drill down capability on a point by point basis;

• Additional attribute information for each point

• Collaborative point documentation capabilities

A series of modeless windows may be opened to examine different views of the data while the user is working with the chart.  Modeless windows allow the user to keep the windows open while still interacting with the other views available within the application.  As the user clicks on different points within the chart, the windows update to reveal information specific to that point.

User entered comments may be associated with points within a chart and stored in a central database for future analysis/reference.  In the SPC chart template, the criteria for uniquely identifying a data point must be provided in order to store comments.  The comments are stored against both the chart type and the unique data point identifier.  When viewing a chart, additional characteristics may also be displayed for each point, if they are returned in the data query, to add further context to the view.

Points may also be suppressed, or excluded from the calculations.  In order to suppress points, the chart must be given a name.  The suppressed points are persisted against both the chart name and the  unique data point identifier.  

The unique point identifiers must be present in the query template being used to populate the chart dataset.  The data mapping tab of the iSPCChart template editor allows the user to define the data value to be evaluated as well as other data attributes.  Refer to the iSPCChart Editor Reference for more details.

A full set of data accessors are provided within the applet to allow additional application development around the statistical data sets as required.

iSPCChart Types

Variable Chart Types

Attribute Chart Types

iSPCChart Events

In addition to the generally supported applet events, the iChart supports the UpperChartSelectionEvent, UpperChartDoubleClickEvent, LowerChartSelectionEvent, and LowerChartDoubleClickEvent.

These methods may be used in conjunction with the chart component methods to get information about individual chart points or subgroups.  For example, you could use the UpperChartDoubleClickEvent to fire a script function that used the getUpperSelectedPoint() method to find the currently selected point, which you could then use to retrieve specific attribute information about that point.  

To do this, you would create a function reference in the UpperChartDoubleClickEvent, so that the function would be called each time you double-click on the chart.  The getUpperSelectedPoint() method returns the point index for the currently selected point.  Once you have that index, you can ask the chart for data related to the point with the returned index.  This way, you can create simple drill-down data retrieval functions based on individual point selection.

For more information on how to use selection events to make an HTML page more interactive, see the Applet General Reference.  Specific iSPCChart methods and data accessors are referenced below.

iSPCChart Symbology

The actual data points on a chart have several visual indications with different meanings, as outlined in the table below:

General SPC Chart Features

There are a number of common features shared by each type of SPC Chart.  They are described in the following section.  For information on how to configure the SPC display template to enable these features, refer to the iSPCChart Editor Reference.  Most of the below features are available through the iSPCChart right-click menu.  These features are included within the iSPCChart, and require no application development.

Chart Manipulation

You may zoom in or out, scroll forward and backward through time, and print the chart just as you can with the SAP xMII iChart applet.  Simply use the right-click menu options.

Viewing Additional Point Attributes

There are a number of chart features that enable the user to see more data about the individual chart points.

Both the upper and lower chart have the same menu.  On a point by point basis, you can view information on alarms, attributes, and comments.  You can also remove or add a selected point from the calculations through the Toggle Point Suppression selection.  Each of these features is based on a single point.  First the user must select a specific point within the chart.  The point will be highlighted as shown above in the Symbology section.  

By selecting Toggle Point Suppression, the currently selected point will either be removed from the calculation, or added back in.  A point that is not included in the calculation has a X through it.

When you choose Alarms, Attributes, or Comments from the menu, a window appears.  There are no restrictions on the number of alarms, attributes or comments for an individual point.  Each window may be opened independently, or all at once.  The windows will stay on top of the browser instance, and you may still interact with the chart while the windows are open.  This allows the user to select different points while the windows are open and see any relevant data about that point.

In the upper left hand corner of the chart, point attributes are also shown for the selected point.  An attribute is any returning value in the query result set that you wish to view other than the value for the calculation.  See the iSPCChart Editor Reference for information on how to configure attributes.  

Documenting SPC Points

You can add comments to chart points through the chart right-click menu.  With the Comments window open, press the Add New button, and you may enter a new comment.  If you are using personalization, the user login name will automatically be recorded with the comment.  As you click on new points, any comments that have been added to relevant point will appear in the Comments window.  If a point has comments associated with it, a flag will appear next to the point.

Comments are stored in the QualityPortal database, and are associated with particular data points.  Since the comments are linked to the data points, they are available for other users to see for the same chart type.  This allows out of the box collaboration on quality analyses.  In order to use comments in this way, each point must be uniquely identified, so that if it appears again on the same chart type, the previously recorded comments are viewable.

To uniquely identify points, go to the Data Mapping tab of the iSPCChart Editor.

Rule Violations

Points that are in violation of rules configured for the chart are shown with a red bulls-eye.  Use the Alarms selection on the right-click menu to view rule violation details.  TO configure rule violations, see the Alarms tab of the iSPCChart Editor.

Data Views

Raw Data Detail shows the underlying query results, statistical calculations, control and specification limits, and chart alarms in HTML.  This may be printed for reference from the browser.  SPC Results Detail is similar to the Raw Data Detail except it shows the chart points (subgroup values, as opposed to individual query returning values) .  Summary Statistics brings up a modal window with the results of the result set's relevant statistical calculations.  Upper and Lower Chart Data Points bring back the chart subgroup point values along with the control limit values.  You may also save the query result set or the SPC calculated data set in comma separated value (CSV) format.

iSPCChart Methods

Below is a listing of iSPCChart specific methods.  Like all SAP xMII applets, the SPC chart supports the same set of Base Methods as the other objects.  The iSPCChartComponent methods are described further below in this section.  Refer to the SAP xMII Applet Object Model  reference for a general description of how to interact with the applets at runtime with Web script.

iSPCChartComponent getChartObject()

This method is used to obtain a reference to the underlying chart display object (the iSPCChartComponent class).  The methods for the iSPCChartComponent are described later in this document (see iSPCChartComponent Methods)

void updateChart(boolean bReloadData)

This method is used to update the chart contents.  The parameter indicates whether or not to re-read the underlying data.  This method differs from the refresh() method in the case where the underlying query is "time-based".  In the case of a time-based query, the refresh() method will update the start and end date based on the current time less the duration/duration units.  The updateChart method will not change the start and end dates.

void doPrint()

This method is used to pop up an HTML page containing a GIF representation of the current chart, suitable for printing.

void showUpperChartAlarms()

Same functionality as the right-click menu to open the alarm window for the upper chart.

void showUpperChartPoints()

Same functionality as the right-click menu to show the Upper Chart Data Points.

void showUpperChartComments()

Same functionality as the right-click menu to show the comments for the upper chart.

void showUpperChartAttributes()

Same functionality as the right-click menu to show the attribute window for the upper chart.

void showLowerChartAlarms()

Same functionality as the right-click menu to open the alarm window for the lower chart.

void showLowerChartPoints()

Same functionality as the right-click menu to show the Lower Chart Data Points.

void showLowerChartComments()

Same functionality as the right-click menu to show the comments for the lower chart.

void showLowerChartAttributes()

Same functionality as the right-click menu to show the attribute window for the lower chart.

void showSummaryStatistics()

Same functionality as the right-click menu to show the relevant statistical calculations for the chart type.

void saveSPCAsCSVFile()

Same functionality as the right-click menu to save the SPC calculation data set.

showSPCDetail()

This opens a new window with the full details of the SPC calculation data set, including raw data, in HTML.

showSPCXMLDetail()

Same as above, but in XML format.

setUpperSelectedPoint(int nPoint)

setLowerSelectedPoint(int nPoint)

setUpperSelectedPointByID(String sID)

setLowerSelectedPointByID(String sID)

int getUpperPointByID(String sID)

int getLowerPointByID(String sID)

iSPCChartComponent Parameters

iSPCChartComponent General Parameters

Control Limit Parameters

Specification Limit Parameters

Alarm Parameters

Legend Parameters

Axes Parameters

DataMapping Parameters

Upper Chart Parameters

Lower Chart Parameters

Behavior Parameters

Chart Specific Parameters

Refresh Parameters

Please refer to the Applet General Reference for details on the Refresh Parameters.

iSPCChartComponent  Object Methods

SPC Component Methods of Note

Toggling Suppression

void toggleUpperSuppressionFlag(int PointNumber)

This method will change the indicated point's suppression flag boolean state in the upper chart.

void toggleLowerSuppressionFlag(int PointNumber)

This method will change the indicated point's suppression flag boolean state in the lower chart.

Accessors for Summary Statistics

double getStatisticsItem(String StatsItemName)

Returns a floating point number representing the statistical value specified by the passed in string.

double getCalculatedUpperLCL()

Returns a floating point number representing the upper chart's calculated lower control limit.

double getCalculatedUpperCL()

Returns a floating point number representing the upper chart's calculated centerline.

double getCalculatedUpperUCL()

Returns a floating point number representing the upper chart's calculated upper control limit.

double getCalculatedLowerLCL()

Returns a floating point number representing the lower chart's calculated lower control limit.

double getCalculatedLowerCL()

Returns a floating point number representing the lower chart's calculated centerline.

double getCalculatedLowerUCL()

Returns a floating point number representing the lower chart's calculated upper control limit.

Accessors for Point Data Values, ID's, Attributes, and Alarms

int getUpperSelectedPoint()

This returns the index for the currently selected point on the upper chart.  Use this with other get statements to return point, attribute, or alarm values for points at a specific index.

int getLowerSelectedPoint()

This returns the index for the currently selected point on the lower chart.  Use this with other get statements to return point, attribute, or alarm values for points at a specific index.

double getUpperDataValueAt(int PointNumber)

Returns a floating point number representing the value of the point at the indicated index for the upper chart (or the only chart if there is a single chart).

String getUpperIDAt(int PointNumber)

Returns a string representing the concatenated value of the unique identifier values for the point at the indicated index for the upper chart (or the only chart if there is a single chart).

int getUpperAttributeCount()

Returns an integer for the number of Attribute columns for the upper chart (or the only chart if there is a single chart).

String getUpperAttributeValueAt(int PointNumber, int AttributeNumber)

Returns a string representing the attribute column value for the point at the indicated index and the indicated Attribute index (or the only chart if there is a single chart).

String getUpperAttributeNameAt(int AttributeNumber)

Returns a string representing the attribute column name for the indicated Attribute index for the upper chart (or the only chart if there is a single chart).

String getUpperAttributeAt(int PointNumber, String AttributeName)

Returns a string representing the attribute column value for the point at the indicated index and the indicated Attribute column name (or the only chart if there is only a single chart).

int getUpperAlarmCount(int PointNumber)

Returns an integer for the number of alarms for the point at the indicated index for the upper chart (or the only chart if there is only a single chart).

String getUpperAlarmAt(int PointNumber, int AlarmNumber)

Returns a string representing the rule violation message for the point at the indicated index and the indicated alarm number for the upper chart (or the only chart if there is only a single chart) - (there may be multiple alarms for a single point).

double getLowerDataValueAt(int PointNumber)

See getUpperDataValueAt

String getLowerIDAt(int PointNumber)

See getUpperIDAt

int getLowerAttributeCount()

See getUpperAttributeCount

String getLowerAttributeValueAt(int PointNumber, int AttributeNumber)

See getUpperAttributeValueAt

String getLowerAttributeNameAt(int AttributeNumber)

See getUpperAttributeNameAt

String getLowerAttributeAt(int PointNumber, String AttributeName)

See getUpperAttributeAt

int getLowerAlarmCount(int PointNumber)

See getUpperAlarmCount

String getLowerAlarmAt(int PointNumber, int AlarmNumber)

See getUpperAlarmAt

String getUpperChartType(String ChartType)

Returns a string representing the upper chart.  Example: for a XBAR-MR, this method returns XBAR.

String getLowerChartType(String ChartType)

Returns a string representing the lower chart.  Example: for an XBAR-MR chart , this method returns MR, and for single charts such as XBAR or EWMA, this method returns an empty string.

int getUpperNumberOfDataPoints()

Returns the number of points in the upper chart dataset (subgroups points, not the raw data).

int getLowerNumberOfDataPoints()

Returns the number of points in the lower chart dataset (subgroups points, not the raw data).

Comment Related Accessors

boolean isUpperHasComments(int PointNumber)

Returns a true or false depending on whether the indicated chart point has a comment associated with it.

boolean isLowerHasComments(int PointNumber)

Returns a true or false depending on whether the indicated chart point has a comment associated with it.

Control and Specification Limit Convenience Methods

The following methods have been added to allow easy retrieval of control and specification values for specific points, since these values can change over the x-axis of a chart:

getUpperLCLAt(index)
getUpperCLAt(index)
getUpperUCLAt(index)
getUpperLSLAt(index)
getUpperTargetAt(index)
getUpperUSLAt(index)
getLowerLCLAt(index)
getLowerCLAt(index)
getLowerUCLAt(index)
getLowerLSLAt(index)
getLowerTargetAt(index)
getLowerUSLAt(index)

All these methods return a floating point data type, for the specific point index that is passed in.  You can get the index for the selected point(s) by using the getUpperSelectedPoint()  or getLowerSelectedPoint() methods described above.

Complete Method Reference

All chart properties are accessible via "get" and "set" methods.  To retrieve a specific chart attribute, use the get method.  Values may be set to a specific value via the set method.  All the chart properties are listed above.  Use the property name in the set or get method.  The only exception to this rule is for boolean data types.  To get a boolean return, you must use an "is" method followed by the attribute name.  Boolean attributes still use the "set" method.

For example, if you wish to change the subgroup size via JavaScript, lookup the subgroup size property in the above tables (see SubgroupSize in the iSPCChartComponent General Properties1 iSPCChartComponent General Properties table above).  Note that the datatype is an int (32 bit signed integer).  The method signature is as shown below:

void setSubgroupSize(int newval)

Note that the SubgroupSize property is a chart object property.  You would need to use the applet.getChartObject method to retrieve the chart component (see above).  Then, to set the SubgroupSize value to five (5), you use the set keyword in front of the property name, passing in the correct datatype as shown below:

<iSPCChartComponent>.setSubgroupSize(5)

To retrieve the current value, the same syntax applies, except you use the get keyword.  The method signature is as shown below:

int getSubgroupSize()

To retrieve the Subgroup size into a variable within a script function, you would enter a line similar to the following:

<varname> = <iSPCChartComponent>.getSubgroupSize()