Value of actual for the characteristic specified in the query.

~act,cause~

Returns the label of the assigned cause, if a cause has been assigned.

~act,cause,comment~

Returns the comment of the assigned cause, if a cause has been assigned. See also ~cause,comment~.

~act,cause,desc~

Returns the label and the description of the assigned cause, if a cause has been assigned.

~act,status~

Can return one of the following strings:

• Active - Loaded from database, displayed and used in statistical calculations.

• Masked - Loaded from database and displayed, but not used in statistical calculations.

• Missing - No data exists.

• Hidden - Data exists, but is not loaded from database.

• Archived - Not loaded from database and will be archived.

~act,[char]~

~acttype,[char]~

Type of results data for the specified characteristic (Actual or Deviation).

~actvalue,[char]~

Raw value of results data for the specified characteristic.

Alias label of a feature.

~alias,label~

If the feature does not have an alias, the feature label is displayed.

Returns the Alias 1 label of a feature, if one exists.

Returns the Alias 2 label of a feature, if one exists

Returns the Alias 3 label of a feature, if one exists

Returns the Alias 4 label of a feature, if one exists

Returns one of the following strings:

• Aligned - Alignment was successful.

• Failed Align - Alignment failed.

• Not Aligned - Alignment has not been turned on or has not been requested.

• No Subroutine - Alignment can't be applied because alignment requires a subroutine.

~align,rout~

Returns the label of the subroutine being aligned.

~align,routine~

Same as ~align,rout~.

~align,routhand~

Returns the handedness of the routine being aligned.

~align,routkey~

Returns the routine label plus the routine key filters. This variable can be used as a unique identifier for subroutines.

~align,state~

The state of the alignment mode for a Subroutine. Will return one of the following: Aligned, NOT Aligned, or FAILED Align. Using the state parameter with the align variable allows users to replace the strings Aligned, Failed Align, Not Aligned and No Subroutine with text that they choose.

• If the variable ~align,state,Yes,No,N/A, Error~ was used, the values Yes, No, N/A and Error would be used in place of the standard value strings.

~align,sampstate~

The state of the alignment mode for a Sample. Will return one of the following: Aligned, NOT Aligned, or FAILED Align.

~align,a1~

Returns the label of the Feature designated for the A1 characteristic.

~align,a2~

Returns the label of the Feature designated for the A2 characteristic.

~align,a3~

Returns the label of the Feature designated for the A3 characteristic.

~align,b1~

Returns the label of the Feature designated for the B1 characteristic.

~align,b2~

Returns the label of the Feature designated for the B2 characteristic.

~align,c1~

Returns the label of the Feature designated for the C1 characteristic.

~align,a1,featchr~

Returns the axis specified (characteristic) for the A Datum.

~align,a2, featchr~

Returns the characteristic (X, Y or Z) of the a2 datum.

~align,a3,featchr~

Returns the characteristic (X, Y or Z) of the a3 datum.

~align,b1,featchr~

Returns the axis specified (characteristic) for the B Datum.

~align,b2,featchr~

Returns the characteristic (X, Y or Z) of the b2 datum.

~align,c1,featchr~

Returns the axis specified (characteristic) for the C Datum.

~align,a1,featoff~

Returns the offset specified for the A1 characteristic.

~align,a2,featoff~

Returns the offset specified for the A2 characteristic.

~align,a3,featoff~

Returns the offset specified for the A3 characteristic.

~align,b1,featoff~

Returns the offset specified for the B1 characteristic.

~align,b2,featoff~

Returns the offset specified for the B2 characteristic.

~align,c1,featoff~

Returns the offset specified for the C1 characteristic.

~align,a1,routhand~

Returns the handedness of the Feature designated for the A1 characteristic.

~align,a2,routhand~

Returns the handedness of the Feature designated for the A1 characteristic.

~align,a3,routhand~

Returns the handedness of the Feature designated for the A1 characteristic.

~align,b1,routhand~

Returns the handedness of the Feature designated for the A1 characteristic.

~align,b2,routhand~

Returns the handedness of the Feature designated for the A1 characteristic.

~align,c1,routhand~

Returns the handedness of the Feature designated for the A1 characteristic.

~align,a1,srchand~

Returns the handedness of the DataSource designated for the A1 characteristic.

~align,a2,srchand~

Returns the handedness of the DataSource designated for the A1 characteristic.

~align,a3,srchand~

Returns the handedness of the DataSource designated for the A1 characteristic.

~align,b1,srchand~

Returns the handedness of the DataSource designated for the A1 characteristic.

~align,b2,srchand~

Returns the handedness of the DataSource designated for the A1 characteristic.

~align,c1,srchand~

Returns the handedness of the DataSource designated for the A1 characteristic.

~align,isoffset~

If the characteristic is used in an Alignment, then will return the offset specified for the characteristic: A1, A2, A3, B1, B2, C1. If the characteristic is not part of an alignment, nothing will be returned.

~align,isdatum~

If the characteristic is used in an Alignment, then will return the datum specified for the characteristic: A1, A2, A3, B1, B2, C1. If the characteristic is not part of an alignment, nothing will be returned.

~align,isdatum,a1~

The feature is used as a1 in the alignment.

~align,isdatum,a2~

The feature is used as a2 in the alignment.

~align,isdatum,a3~

The feature is used as a3 in the alignment.

~align,isdatum,b1~

The feature is used as b1 in the alignment.

~align,isdatum,b2~

The feature is used as b2 in the alignment.

~align,isdatum,c1~

The feature is used as c1 in the alignment.

~align,isdatum,is,isnt,[char]~

If the feature is used in the alignment for the specified [characteristic], the variable returns the string "is". If the feature is not used in the alignment for the specified [characteristic], the variable returns the string "isnt".

~align,isdatum,yes,no,[char]~

Using the [yes] and [no] parameters with the ~align,isdatum~ variable allows you to replace the strings "is" and "isnt" with text that you choose.

Returns the label of the annotation.

~annot,label~

Returns the label of the annotation.

~annot,type~

Returns the type of annotation.

~annot,error~

Returns the text from Resolve Errors.

Returns the axis direction, as defined by the primary direction label. Same as ~axdir,p~. The direction values may be customized in the Direction Labels section of the Document Defaults dialog.

~axdir,[char]~

Returns the axis direction of the specified characteristic.

Primary axis of SMI feature, or specified axis.

~axis,p~

Returns the primary axis label.

Highest value in DataSet row that is within the uif (Upper Inner Fence).

Lowest value in DataSet row that is within the lif (Lower Inner Fence).

This variable is obsolete. Although a value may be returned if ~car~ is used, it will be inaccurate and unreliable. Use the variable ~dev~ to return deviation and deviation type.

Returns any cause that is assigned to an actual.

~cause,comment~

Returns the cause comment. See also ~act,cause,comment~.

~cause,desc~

Returns the cause description.

~cause,feature~

Returns the label of the feature.

~cause,label~

Returns the cause label.

~cause,mask~

Returns whether the cause is masked or active sample.

~cause,sample~

Returns the label of the sample.

When ~cause,sample~ is used in a table (and there is more than one sample), the second sample label will be listed below the first sample label in the same cell:

See the topic Table Properties for more information on table expansion.

Returns the value of a cell in a DataSet. The ~cell~ variable requires a row to be specified in the DataSet, and must have an active sample.

Returns the sample which was resolved for the cell.

Will return the characteristic used in a DataSet row.

~chr,1~

Returns the first a letter of the characteristic type.

Returns the Compare Precision number set on the Document Properties Defaults Tab.

Returns number of conforming values in a DataSet row.

Returns the number of valid values within a DataSet row. Same as ~validcount~.

Capability or potential of the process. A ratio of the specification width to the width of the normal distribution. Cp is normally calculated using an estimated standard deviation formula that uses either the mean of subgroup ranges or the mean of subgroup standard deviations with constant table values relative to the subgroup size.

Capability of process index relative to dispersion and centeredness. From the true process center (), Cpk indicates the closest specification limit (in terms of estimated standard deviation units/3).

Capability ratio. The reciprocal of Cp.

Capability of process index influenced by the difference between the sample mean and the nominal target value.

Returns the target value used to calculate the Correlation Coefficient. A ~cc~ value below the target is considered an indication that the data is NOT normally distributed.

The ~cctarget~ is based on Sample size shown below:

Sample Size

<= 20

<= 25

<= 30

<= 40

<= 50

<= 60

> 60

Returns n/a, normal, or abnormal. This returns the result of the D'Agostino Pearson Omnibus test for Normality.

Returns the label of the DataSet.

~dataset,boxhi~

Returns the box highest value for the entire DataSet.

~dataset,boxlo~

Returns the box lowest value for the entire DataSet.

~dataset,conformcount~

Returns the number of conforming values in a DataSet.

~dataset,cp~

Returns the Cp, Cpk, or Cr value of the data in the DataSet. There are two limitations to calculating Cpk on a DataSet:

1. All cells in the DataSet must have a Tolerance, and the Tolerance must be the same for all cells in the DataSet.

2. Subgroups will not be applied when using the Cpk parameter.

3. Without Subgroups, Cp, Cpk, and Cr will be the same as Pp, Ppk, and Pr, respectively.

~dataset,cpk

~dataset,cr~

~dataset,hi~

Returns the high value for the entire DataSet.

~dataset,invalidcount~

Returns the number of invalid values in an entire DataSet.

~dataset,iqr~

Returns the inter quartile range for the entire DataSet.

~dataset,lif~

Returns the lower inner fence value for the entire DataSet.

~dataset,lof~

Returns the lower outer fence value for an entire DataSet.

~dataset,mean~

Returns the mean value for the entire DataSet.

~dataset,median~

Returns the median value for the entire DataSet.

~dataset,nonconformcount~

Returns number of nonconforming values in a DataSet

~dataset,nospeccount~

Returns the number of valid values in an entire DataSet that do not have a spec limit.

~dataset,nospeccount2~

Returns the number of valid values in an entire DataSet that do not have a spec limit 2.

~dataset,outofspeccount~

Returns the number of valid values in a DataSet that are out of spec.

~dataset,outofspeccount2~

Returns the number of valid values in a DataSet that are out of spec2.

~dataset,percentconform~

Returns percent of conforming values in a DataSet.

~dataset,percentnonconform~

Returns percent of nonconforming values in a DataSet.

~dataset,percentinvalid~

Returns the percent of invalid values in an entire DataSet.

~dataset,percentvalid~

Returns the percent of valid values in an entire DataSet.

~dataset,pp~

Returns the Pp value of the DataSet.

~dataset,ppk~

Returns the Ppk value of the DataSet.

~dataset,pr~

Returns the Pr value of the DataSet.

~dataset,q1~

Returns the quartile one value for an entire DataSet.

~dataset,q3~

Returns the quartile one value for an entire DataSet.

~dataset,range~

Returns the range value for the entire DataSet.

~dataset,rovcenter~

~dataset,rovspread~

~dataset,rovtarget~

~dataset,rowcount~

Returns the number of rows in the DataSet. See also, ~rows~.

~dataset,stddev~

~dataset,sum~

Returns the value of the sum of an entire DataSet.

~dataset,totalcount~

Returns the number of values in an entire DataSet.

~dataset,uif~

Returns the upper inner fence value for the entire DataSet.

~dataset,uof~

Returns the upper outer fence value for an entire DataSet.

~dataset,upperlimit~

Returns Collecting Data or Not Collecting Data. The ~datastate~ variable returns "Collecting Data" if a DataSet is in Collecting Data mode, or "Not Collecting Data" if the DataSet is in any mode other than collecting data.

Returns the current date using the current regional format. Formatting options below are case sensitive, may be combined, and may be applied also to the variable ~samp,date~.

• If the date was March 14, 2002, ~date,%d-%b-%Y~ would resolve to "14-MAR-2002".
  If the time were 08:12:59, ~date,%M past %H~ would resolve to "12 past 08".

~date,[param]~

See the [Parameters] above for a complete list of available date parameters.

Returns the deviation value based on the query setting.

~dev,[char]~

Returns the deviation type, Vec or Car, based on the query setting.

Returns n/a, normal, or abnormal. This is based on the Normal Distribution Correlation Coefficient (~cc~). If the value of ~cc~ is less than the target (~cctarget~), then ~distribution~ will return abnormal. If the value of ~cc~ is greater than or equal to ~cctarget~, then ~distribution~ will return normal. If ~cc~ does not resolve, then ~distribution~ will return n/a.

Returns information related to the CM4D document.

~doc,label~

Returns the saved name of the document, excluding the file extension.

~doc,title~

Returns the saved name of the document, including the file extension.

~doc,path~

Returns the entire folder path of document, excluding the filename.

Returns the value of the error (the amount out of  tolerance). Always an absolute value.

Returns the amount of error of a value compared to tolerance 2.

Returns the amount of error of a value compared to reasonable limits.

Returns the label of the feature.

~feat,alias~

Returns the value of the alias of the feature.

~feat,alias1~

Returns the value of the alias 1 of the feature.

~feat,alias2~

Returns the value of the alias 2 of the feature.

~feat,alias3~

Returns the value of the alias 3 of the feature.

~feat,alias4~

Returns the value of the alias 4 of the feature.

~feat,desc~

Returns the description of the feature.

~feat,filter~

Returns the filter label (A-Z, or label of filters if defined in database).

• For example, ~filter,a~ would return the value of feature filter A.

~feat,label~

Returns the label of the feature.

~feat,refcount~

Resolves the number of reference features associated to the feature.

~feat,seq~

Returns the sequence of the feature.

~feat,sourcerout~

Returns the source routine of the feature.

~feat,sourceroutkey~

Returns the source routine key of the feature.

~feat,type~

Returns the implied SMI Type, which is used by the Sift Rules.

Returns the label of the first reference feature.

~featref1,alias~

Returns the value of the alias of the first reference feature.

~featref1,alias1~

Returns the value of the alias 1 of the first reference feature.

~featref1,alias2~

Returns the value of the alias 2 of the first reference feature.

~featref1,alias3~

Returns the value of the alias 3 of the first reference feature.

~featref1,alias4~

Returns the value of the alias 4 of the first reference feature.

~featref1,desc~

Returns the description of the first reference feature.

~featref1,filter~

Returns the filter label (A-Z, or label of filters if defined in database) of the first reference feature.

~featref1,label~

Returns the label of the first reference feature.

~featref1,seq~

Returns the sequence of the first reference feature.

~featref1,sourcerout~

Returns the source routine of the first reference feature.

~featref1,sourceroutkey~

Returns the source routine key of the first reference feature.

~featref1,type~

Returns the type of the reference first feature.

Returns the label of the second reference feature.

~featref2,alias~

Returns the value of the alias of the second reference feature.

~featref2,alias1~

Returns the value of the alias 1 of the second reference feature.

~featref2,alias2~

Returns the value of the alias 2 of the second reference feature.

~featref2,alias3~

Returns the value of the alias 3 of the second reference feature.

~featref2,alias4~

Returns the value of the alias 4 of the second reference feature.

~featref2,desc~

Returns the description of the second reference feature.

~featref2,filter~

Returns the filter label (A-Z, or label of filters if defined in database) of the second reference feature.

~featref2,label~

Returns the label of the second reference feature.

~featref2,seq~

Returns the sequence of the second reference feature.

~featref2,sourcerout~

Returns the source routine of the second reference feature.

~featref2,sourceroutkey~

Returns the source routine key of the second reference feature.

~featref2,type~

Returns the type of the reference second feature.

Same as ~feat~.

Requires a DataStack as the DataSource. Grade looks at every cell of the entire DataStack and checks to see if the values are within Spec Limits. The ~grade~ variables are very similar to the ~tally~ variables.

~grade,count~

Returns the number of valid values in tolerance. This variable must use a DataStack as its DataSource, and the DataStack must have limits.

~grade,total~

Returns the total number of valid values. This variable must use a DataStack as its DataSource, and the DataStack must have limits.

~grade,percent~

Returns the percent of valid values in tolerance (count divided by total). Percent is rounded to nearest integer (no % sign).

Returns the type of a graph. The graph types are Trend, XBar-R, XBar-S, X-MR, MA-MR, Box_Whisker, Six Sigma, Pareto, Normality, Benchmark, Target, and Six Sigma Projection.

Returns LEFT or RIGHT. The handedness is based on the value of the Y char. If Y is less than zero (negative), the handedness will be LEFT; if Y is more than zero (positive), the handedness will be RIGHT.

~hand,1~

Returns just L or R.

Highest of valid values within a DataSet row

Inter Quartile Range (q3-q1)

Number of invalid values in DataSet row. Invalid data is not nonconforming data and so will not be included in the ~validcount~ results.

Returns the measure of flatness of a distribution

Returns the label of feature.

Lower Inner Fence (q1 - 1.5 * iqr)

Lower Outer Fence (q1 – 3.0 * iqr)

~load,label~

Returns the label of the query.

~load,routine~

Returns the routine label of any routine in the query. If more than one routine exists in the query, the variable returns the routine labels of all the routines, separated by a space.

~load,features~

Returns the number of features loaded in a query.

~load,features,filters~

Returns the filters that were selected and used by the loaded features.

~load,samples~

Returns the number of synchronized samples.

~load,query~

Returns the settings for the samples in the query.

~load,order~

Returns the setting of the order of the samples in the query.

~load,loadtime~

Returns the total time it took to load the features, samples, and images.

~load,feattime~

Returns the total time it took to load the features.

~load,routtime~

~load,samptime~

Returns the total time it took to load the samples.

~load,imagetime~

Returns the total time it took to load the image.

Lower tolerance.

Lower tolerance 2.

Lower specification limit. The lower engineering limit specified for a measurement.

Lower specification limit 2. The lower engineering limit 2 specified for a measurement.

Lower reasonable limit.

• For more information about reasonable limits see the topic Reasonable Limits.

Lower reasonable tolerance.

Lower control limit. The lower control limit for control charts. Control limits are used with the distribution of averages not the distribution of individuals. Control limits are used in conjunction with process control charts to identify when assignable causes of variation are present. Control limits should not be confused with specification limits which are established for engineering specifications and are used with individual measurements to indicate process performance.

~lcl,[char],[param]~

Lowever Control Limit 2. The variable ~lcl2~ will return the value of the lcl 2 if one has been created. See ~lcl~.

~lcl2,[char],[param]~

Lower control limit for Xbar with Range

~lclxbr,[char],[param]~

Lower control limit for  X with Moving Range

~lclxmr,[char],[param]~

Lower control limit for Xbar with Standard Deviation

~lclxbs,[char],[param]~

Lower control limit for Range

~lclr,[char],[param]~

Lower control limit for Standard Deviation

~lcls,[char],[param]~

Lower control limit for Moving Range

~lclmr,[char],[param]~

Lower control limit for Moving Average

~lclma,[char],[param]~

Lowest of valid values within a DataSet row

The ~limittype~ variable determines whether a control chart is using Trial Control Limits or Process Control Limits (e.g. "Trial XBar-R" or "Control XBar-R").

Mean of valid values within a DataSet row

~mean,r~

Mean range of subgroup ranges within a DataSet row

~mean,s~

Mean standard deviation of subgroup standard deviations within a DataSet row

~mean,mr~

Mean moving range of subgroup moving ranges within a DataSet row

~mean,ma~

Mean moving average of subgroup moving averages within a DataSet row

~mean,ga~

Grand average of subgroup averages within a DataSet row

This is the same as ~mean~, unless some subgroups were found to be invalid because they had invalid or missing sample values. Subgroups with invalid values are removed from statistical calculations since their subgroup size is affected.

Median value of DataSet row.

Returns 1 or 0, indicating whether or not the Miniball is valid. The variable ~miniball,valid~ may also be used to return the same result.

Returns the number of masked data points.

Returns the diameter of the Miniball.

Returns number of points that are Out of Miniball Limit.

Returns the percentage of out of limit points for Miniball {m-out#/pnt#}.

Returns the radius of the Miniball.

Returns the tolerance of the Miniball.

Returns the diametrical tolerance of the Miniball.

Returns the number of points included in the Miniball calculation.

Returns the Reference Feature used in the Constructed Feature.

Returns the Description (if available) of the Reference Feature.

Returns the Polar value of the Reference Feature used in the Constructed Feature.

Returns the Nominal X value of the Reference Feature.

Returns the Nominal Y value of the Reference Feature.

Returns the Nominal Z value of the Reference Feature.

Returns the number of features referenced by the constructed Polar feature.

Returns one of the five states of the Miniball calculation for a single feature.

• Masked - the feature is masked

• Conform - the feature is within the Miniball tolerance

• Zero! - the feature is out of Miniball tolerance

• Mini! - this status does not yet apply

• Both! - this status does not yet apply

Returns the horizontal offset of the Miniball. The variable ~miniball,x-off~ may also be used to return the same result.

Returns the vertical offset of the Miniball. The variable ~miniball,y-off~ may also be used to return the same result.

Returns the diameter of the Zeroball.

Returns the number of points that are Out of Zeroball Limit.

Returns the percentage of out of limit points for Zeroball {z-out#/pnt#}.

Returns the radius of the Zeroball, from center zero.

Returns the tolerance of the Zeroball.

Returns the diametrical tolerance of the Zeroball.

Returns the measurement system analysis of a DataSet row. Same as ~msa,mvpt~ for legacy support.

~msa,tol~

Study Tolerance

~msa,pf~

Program Factor = 5.15 or 6.0

~msa,operators~

Number of Operators used in study

~msa,trials~

Number of Trials per operator used in study

~msa,parts~

Number of Parts used in study

~msa,ev~

Equipment Variation

~msa,ov~

Operator Variation

~msa,rr~

Repeatability & Reproducibility

~msa,pv~

Part Variation

~msa,tv~

Total Variation

~msa,mv~

Measurement Variation = PF * ~stddev~ (with setup) or ~stddev,e~ (without setup)  

~msa,mvpt~

Measurement Variation as a percent of Tolerance

~msa,evptv~

Equipment Variation as a percent of Total Variation

~msa,evpt~

Equipment Variation as a percent of Tolerance

~msa,ovptv~

Operator Variation as a percent of Total Variation

~msa,ovpt~

Operator Variation as a percent of Tolerance

~msa,rrptv~

Repeatability/Reproducibility as a percent of Total Variation

~msa,rrpt~

Repeatability/Reproducibility as a percent of Tolerance

~msa,pvptv~

Part Variation as a percent of Total Variation

~msa,pvpt~

Part Variation as a percent of Tolerance

~msa,updatedate~

Update Date

~msa,studydate~

Study Date

~msa,targetmin~

Target Minimum

~msa,targetmax~

Target Maximum

~msa,studytype~

Study Type (With Setup, Without Setup, User Defined)

~msa,effdate~

Effective Date

~msa,status~

Status (Passed-Green [< = MSA TargetMin], May be acceptable-Yellow [between TargetMin and TargetMax], Failed-Red [> = TargetMax], Not-Done)

Returns the nominal value.

~nom,[char]~

Value of nominal for specified characteristic.

~nom,filter,[A-Z]~

Returns the value of the nominal filter. There are 26 filters available in the database, A-Z. Filters can also have labels, in addition to their alphabetical designations. If no label was assigned to the filter when it was created, a default filter label would have been created, using the word 'Filter', a space, then the letter designation of the filter.

• If ~nom,filter,F~ were used, it would return the nominal value of the F filter.

~nom,filter,[filterlabel]~

Returns the value of the nominal filter. Filters can also have alphabetical designations, in addition to their labels. There are 26 filters available in the database, A-Z. All of these filters can also have filter labels.

• If ~nom,filter,operator~ were used it would return the value of the filter labelled "Operator'".

~nom,[char],eff~

Returns the effective date of the nominal characteristic.

~nom,[char],eff,[param]~

Returns the effective date of the nominal characteristic, according to the parameters set. See the [Parameters] above for a complete list of available date parameters.

~nom,[char],label~

Returns the label of the nominal characteristic.

~nom,[char],signif~

Returns the significance of a characteristic. The possible values which can be returned are: Unknown, Insignificant, Significant, Data Not Allowed or Alarmed.

Returns the number of values in a DataSet row that trigger the Event set on the DataSet.

Number of valid values in a DataSet row that do not have a spec limit

Number of valid values in a DataSet row that do not have a spec limit 2.

Returns n/a, normal, or abnormal. If either ~distribution~ or ~dagostino~ returns normal, then ~normality~ will return normal. If neither ~distribution~ or ~dagostino~ returns normal, then ~normality~ will return either n/a or abnormal.

This variable is obsolete. Although a value may be returned when ~off~ is used, it will be inaccurate and unreliable. Use the variable ~dev~ to return deviation and deviation type.

This variable is obsolete. Although a value may be returned when ~ord~ is used, it will be inaccurate and unreliable. Use the variable ~dev~ to return deviation and deviation type.

Returns the number of values in a DataSet row that are out of spec, or out of tolerance, regardless of the Event Trigger setting.

Returns the number of values in a DataSet row that are out of spec 2, or out of tolerance 2, regardless of the Event Trigger setting.

Returns the page number of the current sheet (within a SheetSet). Same as ~sheets~.

~page,count~

Returns the number of sheets in the SheetSet, not including the title sheet.

~page,label~

Returns the sheet label. (This variable will not return a value when used on the title sheet.)

Returns the number pages in the SheetSet. Same as ~sheets~.

Percentage of valid values in DataSet row

Percentage of invalid values in DataSet row

Returns percent of conforming values in a DataSet row.

Returns percent of nonconforming values in a DataSet row.

Process performance index relative to dispersion. A ratio of the specification width to the width of the normal distribution. Pp is calculated using calculated or sample population standard deviation.

Process performance index relative to dispersion and centeredness. Ppk is calculated using calculated or sample population standard deviation.

Process performance ratio. The reciprocal of pp.

All process variables report values based on process control statistics for the most recent process baseline. A process variable will return values from the most recent process in the DataSet. If you wish your process variables to display data from a process other than the most recent process in the DataSet, you should create a new DataSet in which the process you want to display is the most recent process.

~process,cp~

Capability or potential of the process baseline. The ratio of the specification width to the width of the normal distribution. Cp is normally calculated using an estimated standard deviation formula that uses either the mean of subgroup ranges or the mean of subgroup standard deviations with constant table values relative to the subgroup size.

~process,cpk~

Capability of the process baseline index relative to dispersion and centeredness. From the true process center (), Cpk indicates the closest specification limit (in terms of estimated standard deviation units/3).

~process,cr~

Capability ratio using the process baseline. The reciprocal of Cp.

~process,cpm~

Capability of the process baseline index influenced by the difference between the sample mean and the nominal target value.

~process,pp~

The process baseline performance index relative to dispersion. A ratio of the specification width to the width of the normal distribution. Pp is calculated using calculated or sample population standard deviation.

~process,ppk~

The process baseline performance index relative to dispersion and centeredness. Ppk is calculated using calculated or sample population standard deviation.

~process,nom,[char]~

Returns the value of the nominal within the process baseline for a specified characteristic.

~process,nom,[char],rel~

Returns the value of the relative nominal within the process baseline for a specified characteristic.

~process,nom,[char],abs~

Returns the value of the absolute nominal within the process baseline for a specified characteristic.

~process,mean~

Mean (average) of valid values within a data set row for the process baseline.

~process,stddev~

Calculated standard deviation of a row, for the process baseline.

~process,stddevest~

Estimated standard deviation of a row, for the process baseline.

~process,stddevtarget~

A measure of the spread of the data used in the denominator of the CPM calculation for the process baseline.

~process,xbarbar~

Returns the X Double Bar value.

~process,rbar~

Returns the R Bar value.

~process,sbar~

Returns the S Bar value.

~process,mabar~

Returns the MA Bar value.

~process,mrbar~

Returns the MR Bar value.

~process,lsl~

Lower specification limit for the process baseline. The lower engineering limit specified for a measurement.

~process,usl~

Upper specification limit for the process baseline. The upper engineering limit specified for a measurement.

~process,subsize~

Returns the subgroup size for the process baseline.

~process,effdates~

Returns the effective dates for the process baseline.

~process,effdate~

Returns the effective date of the process.

Quartile 1 value, i.e., Lower Quartile

Quartile 2 value, i.e., Median

Quartile 3 value, i.e., Upper Quartile

Range (highest - lowest) of valid values within a DataSet row

Returns the label of the routine. Same as ~routine~.

~rout,alias~

Returns the alias of the routine.

~rout,desc~

Returns the routine description.

~rout,code~

Returns the routine code.

~rout,key~

Returns the routine key.

~rout,hand~

Returns the handedness of the routine as:

• RH

• LH

• BH

• ?H

~rout,subgroup~

Returns the subgroup size of the routine.

~rout,sublabel~

Returns the subroutine label if the subroutine is active. If there is no active subroutine, the variable will be blank.

~rout,node~

Returns the label of the routine node.

~rout,nodecode~

Returns the routine node's routine code.

~rout,imagetype~

Returns type of image which is associated with the routine:

• Wire

• 2D

• 3D

~rout,imagesrc~

Returns name of the image file associated with the routine.

~rout,maxsamps~

Returns the maximum samples setting for the routine.

~rout,filter~

Returns the filter associated with the routine.

Returns the label of the routine. Same as ~rout~.

Returns number of the DataSet row.

~row,actual~

Returns the active row number in a DataSet.

~row,actualcount~

Returns a count of the number of active rows in a DataSet.

~row,virtual~

Returns the active row number from the map column in a DataSet when Multiple Sift Rules are being used.

~row,virtualcount~

Returns the total number of active rows from the map column in a DataSet when Multiple Sift Rules are being used.

Returns the number of rows in the DataSet.

Returns the label of the DataSet row.

Returns Relational Probability. This is the same as Correlation Coefficient.

Returns the default ROV Center value.

Returns the default ROV Spread value.

Returns the default ROV Target value.

Returns the default ROV Center value.

Returns the default ROV Spread value.

Returns the default ROV Target value.

The "rstat" variables calculate various statistics on the reference features of a Range feature. Range statistics are calculated per sample for all reference features.

~rstat,count~

Returns the number of Range features that are in the DataSet.

~rstat,hi~

Returns the highest value in the range of deviations.

~rstat,lo~

Returns the lowest value in the range of deviations.

~rstat,mean~

Returns the mean value of the range of deviations.

~rstat,stddev~

Returns the standard deviation within the range of deviations.

~rstat,ppk~

Returns the Ppk value of the range of deviations.

Returns the amount of unique dates in a row.

If the samples are ordered by date, this variable returns the value 'Yes'. If the samples are not ordered by date, this variable returns the value 'No'.

Returns the label of the current sample. This is the same as ~samp,label~. When a Sample [Parameter] is appended to any sample variables, the DataSet results will be overridden and the sample signified by the sample paramter will be returned.

~samp,archdate~

Returns the archive date of the sample.

~samp,archdays~

Returns the number of days after the creation date until the samples are archived.

~samp,archtype~

Returns the archive type of the sample: Date, Days, or Never.

~samp,date~

Returns the creation dates of the samples in a DataSet.

~samp,date,%__~

Returns the creation dates of the Sample in a format specified by the specified Date parameter(s).

• For example, if the date was March 14, 2002, ~samp,date,% d-%b-%Y~ would resolve to "14-MAR-2002". If the time were 08:12:59, ~samp,date,% M past % H~ would resolve to "12 past 08".

See here for a complete list of parameters.

~samp,desc~

Returns the description of the sample.

~samp,effdate~

Returns the effective date of the current sample.

~samp,filter,[filterlabel]~

Returns the value assigned to the sample filter associated with the sample. This variable replaced the obsolete variable, ~sample,filter,info~.

~samp,impdate~

Returns the import date of the sample.

~samp,index~

Returns the position of the sample as it exists in the Query.

~sample,label~

Returns the sample label. This is the same as ~samp~ and is the default sample parameter.

~samp,order~

Returns the number of the Sample’s position based on the order of Samples in the Query.

~samp,seq~

Returns the sequence number of the sample.

~samp,status~

Returns the status of the sample:

• Active - Loaded from database, displayed and used in statistical calculations.

• Masked - Loaded from database and displayed, but not used in statistical calculations.

• Missing - No data exists.

• Hidden - Data exists, but is not loaded from database.

• Archived - Not loaded from database and will be archived.

~samp,subgroup~

Returns the subgroup label.

~samp,subgroupseq~

Returns the sequence order within the subgroup.

~samp,type~

Returns the sample type: Var, HVD, or Mix.

Returns the serial number of the sample.

Number of samples in a DataSet.

Returns the page number of the current sheet (within a SheetSet). Same as ~page~.

~sheet,setlabel~

Returns the SheetSet label. The total number of sheets will not include the title sheet.

~sheet,setcontent~

Builds a table of contents for the SheetSet.

Returns the number sheets in the SheetSet. Same as ~pages~.

Returns various summary statistics on data in a DataSet that is associated with a particular Sift Rule.

When a Sift Rule variable is used with two parameters, the calculation is done only for the Sift Rule that is specified by the first parameter. The second parameter is the statistic that will be calculated on the data included in the Sift Rule specified by the first parameter.

The first parameter can be specified using one of the following options:

• Number of Sift Rule - the integer that indicates the position of Sift Rule in the list, as it appears in the Multiple Sift Rules dialog.
• Label of Sift Rule - label of Sift Rule.

When the variable is used with the Evaluation/SiftRule Variable DataStack type, the first parameter is not used.

~siftrule,boxhi~

Box high value

~siftrule,boxlo~

Box low value

~siftrule,conformcount~

Number of conforming values

~siftrule,cp~

~siftrule,cpk~

~siftrule,cr~

~siftrule,hi~

Highest value

~siftrule,invalidcount~

Number of invalid values

~siftrule,iqr~

Inter quartile range

~siftrule,lif~

Lower inner fence value

~siftrule,lo~

Lowest value

~siftrule,lof~

Lower outer fence value

~siftrule,mean~

Mean value

~siftrule,median~

Median value

~siftrule,nonconformcount~

Number of nonconforming values

~siftrule,nospeccount~

Number of valid values that do not have a specification limit

~siftrule,nospeccount2~

Number of valid values that do not have a specification limit 2.

~siftrule,outofspeccount~

Number of valid values that are out of specification.

~siftrule,outofspeccount2~

Number of valid values that are out of specification 2.

~siftrule,percentconform~

Percentage of conforming values

~siftrule,percentnonconform~

Percentage of nonconforming values

~siftrule,percentinvalid~

Percentage of invalid values

~siftrule,percentvalid~

Percentage of valid values

~siftrule,pp~

~siftrule,ppk~

~siftrule,pr~

~siftrule,q1~

Quartile one value

~siftrule,q3~

Quartile three

~siftrule,range~

Range value

~siftrule,rowcount~

Number of rows

~siftrule,stddev~

~siftrule,sum~

Sum value

~siftrule,totalcount~

Number of values

~siftrule,uif~

Upper inner fence value

~siftrule,uof~

Returns the name of the applied Statistics Rule:

• ATS (Default)

• Ford

• Saab

• Volvo Cars

Returns the calculated standard deviation of a DataSet row

~stddev,t~

Returns the standard deviation target

~stddev,e~

Returns the estimated standard deviation

~+3stddev~

Mean plus (the standard deviation time three).

~-3stddev~

Mean minus (the standard deviation time three).

~6stddev~

Standard deviation of a row times six.

Returns the subgroup size.

Sum (accumulation) of all valid values within a DataSet row

Requires a DataStack as the DataSource. Tally looks at every cell of every DataSet in a DataStack and checks to see if the values are within Spec Limits. The ~tally~ variables are very similar to the ~grade~ variables.

• The tally variables are limited in their functionality, as they cannot calculate certain limits (e.g. cannot be used with Spec Limit 2). Because of such limitations, the following equivalents are the preferred variables to use:
      In place of ~tally,total~, use ~dataset,validcount~.
      In place of ~tally,count~, use ~dataset,outofspeccount~.

~tally,count~

Returns the number of cells of the DataSets that are within Spec Limits.

~tally,total~

Returns the total number of valid cells in the DataSets.

~tally,percent~

Returns the percent of valid values in the DataSets (count divided by total). Percent is rounded to nearest integer (no % sign).

Returns the nominal value adjusted for value type (i.e. is 0 for deviation). This value is usually between spec limits, but may not be as in the case of unilateral or odd limits such as +1 to -2.

Used to perform calculations on a single cell.

• If used in a table {~this~*2} would multiply the value of a cell by two, and display that value in the cell.

• See the topic Expression Evaluator for more information on expressions.

Returns the transform type used in the statistics, No Transform, Square of X Transform, Square-root of X Transform, -1 / Square-root of X Transform, Cube of X Transform, Log of X Transform, -1 * X Transform, or -1 / X Transform.

Returns the current time. Additional Date/Time parameters may be added to this variable to specify specific information to display, or some particular format. See here for a complete list of parameters.

Number of values in DataSet row (i.e., the sum of conform, non-conform, and non valid)

Returns the true position value. Requires a point with a vector as the true position plane will be determined by the primary direction of vector.

~trupos,rad~

Returns the true position radius.

~trupos,ang~

Returns the true position angle.

Upper Inner Fence (q3 + 1.5 * iqr)

Upper Outer Fence (q3 + 3.0 * iqr)

Returns the value of the User One user-defined row variable.

Returns the value of the User Two user-defined row variable.

Returns the value of the User Three user-defined row variable.

Returns the value of the User Four user-defined row variable.

Returns the value of the User One user-defined row variable as a formatted string.

Returns the value of the User Two user-defined row variable as a formatted string.

Returns the value of the User Three user-defined row variable as a formatted string.

Returns the value of the User Four user-defined row variable as a formatted string.

Upper specification limit. The upper engineering limit specified for a measurement. The variable ~usl2~ will return the value of the usl 2 if one has been created.

Upper specification limit 2. See ~usl~.

Upper tolerance.

Upper tolerance 2.

Upper reasonable limit.

• For more information about reasonable limits see the topic Reasonable Limits.

Upper reasonable tolerance.

Upper control limit. The upper control limit for control charts. See the description of ~lcl~ for more details on control limits.

~ucl,[char],[param]~

Upper control limit 2. See ~ucl~.

~ucl2,[char],[param]~

Upper control limit for Xbar with Range

~uclxbr,[char],[param]~

Upper control limit for X with Moving Range

~uclxmr,[char],[param]~

Upper control limit for Xbar with Standard Deviation

~uclxbs,[char],[param]~

Upper control limit for Range

~uclr,[char],[param]~

Upper control limit for Standard Deviation

~ucls,[char],[param]~

Upper control limit for Moving Range

~uclmr,[char],[param]~

Upper control limit for Moving Average

~uclma,[char],[param]~

Returns the version of CM4D currently being run.

~version,doc~

Returns the version of CM4D the document has been last saved in.

Number of valid values in DataSet row (i.e., the sum of conform and non-conform)

Returns the variance value of a DataSet row. In a population of samples, the variance value is the mean of the squares of the difference between the respective samples and their mean. Basically, it is the measure of the spread of data, or the standard deviation, squared