Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

MES Stateless API

TABLE OF CONTENTS

GetChars Method

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
The GetChars() method retrieves the characteristic link records for all of the characteristics linked to the specified sample record.

Syntax

'Declaration
 
Public Shared Function GetChars( _
   ByVal sampleId As Integer _
) As DataSet
'Usage
 
Dim sampleId As Integer
Dim value As DataSet
 
value = Sample.GetChars(sampleId)
public static DataSet GetChars( 
   int sampleId
)

Parameters

sampleId
Required. Holds the ID of the sample for which characteristics are being retrieved.

Return Value

Returns a DataSet that contains a DataRow for each characteristic linked to the specified sample from the Sample_Char_Link table. The DataRow also contains lower and upper specification and reasonable value fields from the Qm_Spec_Char_Link table for any QM specification record that is linked to the characteristic, plus characteristic configuration information from the Characteristic and Uom tables.

The record order in the returned DataSet is determined in sequence by the QM specification's display_seq value, the specification-characteristic link's display_seq value, and then alphabetically by the characteristic name.

  • If two or more QM specifications in the returned characteristic record have the same order value (e.g., 2), then the specification-characteristic links are ordered by their display_seq value within that specification display_seq value subgroup.
  • If two or more specification-characteristic links in the returned characteristic link DataSet have the same order value (e.g., 1), then those links are ordered alphabetically by characteristic name within that order value's subgroup.

The columns of the returned DataSet are described below.

Column Name

Description

sample_Id

An integer value that is the sample ID.

char_id

An integer that is the characteristic ID.

char_name

A string that is the characteristic name.

type_h

An integer that is an enumeration that specifies the type of the characteristic:

0 = variable

1 = binary

2 = counted

severity_cd

An integer that is the severity code of the characteristic that is linked to the sample.

minimum_sample_size_h

An integer that is the minimum number of measurements in a sample.

maximum_sample_size_h

An integer that is the maximum number of measurements in a sample.

sample_size_source_h

An integer that is an enumeration that specifies the source of the sample size value. This is applicable to attribute type (binary or counted) attributes only.

0 = fixed

1 = entered

2 = entered but copied from the previous value

normal_sample_size_h

An integer that is the normal number of measurements in a sample.

automated_coll_h

A Boolean flag that specifies whether the characteristic is to be collected automatically.

act_sample_size.h

An integer that is the actual sample size.

qm_spec_id

An integer that is the ID of the QM specification that was used to generate the sample.

qm_spec_name

A string that is the name of the QM specification that was used to generate the sample.
qm_display_seq

An integer that is the value for the display sequence of the QM specification.

This value determines the order in which the specification record appears in the returned array. If two or more specifications in the returned array have the same order value (e.g., 2), then those specifications are ordered alphabetically within that order value's subgroup.

ver_id

A string that is the version of the QM specification from which the sample was generated.
qscl_display_seq An integer that is the display sequence value for the characteristic within the QM specification. This number determines the order of characteristics when they are listed for the QM specification in a drop-down list in the user interface.

target

A floating point that is the target value for the characteristic for the QM specification context.

lsv

A floating point that is the lower specification value of the specification for the characteristic.

usv

A floating point that is the upper specification value of the specification for the characteristic.

lrv

A floating point that is the lower reasonable value for the characteristic.

urv

A floating point that is the upper reasonable value for the characteristic.

equipment

A string that is the equipment used to make the measurements for this characteristic for this sample.

last_edit_comment

A string that contains comments about why the record was added or modified.

last_edit_by

A string that is the user who created or last modified this record.

last_edit_at

A datetime value that is the date/time when the record was created or last modified.

char_desc

A string that is the description of the characteristic.

num_decimals

An integer that is the number of decimals to display for values related to the characteristic.

uom_id

An integer that is the ID of the unit of measure for the characteristic.

description

A string that is the description of the unit of measure for the characteristic.

See Also

Reference

Sample Class
Sample Members

In This Topic
TitleResults for “How to create a CRG?”Also Available in