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

GetAvailableAttrs Method (ItemAttr)

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
The GetAvailableAttrs() method retrieves all item attributes that are not yet assigned to the specified item and are editable by the specified user.

Syntax

'Declaration
 
Public Shared Function GetAvailableAttrs( _
   ByVal itemId As String, _
   ByVal userId As String _
) As DataSet
'Usage
 
Dim itemId As String
Dim userId As String
Dim value As DataSet
 
value = ItemAttr.GetAvailableAttrs(itemId, userId)
public static DataSet GetAvailableAttrs( 
   string itemId,
   string userId
)

Parameters

itemId
Required. Holds the ID of the item for which a list of available attributes is being requested.
userId
Required. Holds the ID of the user requesting the list of available attributes.

Return Value

Returns a DataSet that contains all the records in the Attr table that satisfy the specified filters. If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name

Description

attr_id

An integer that is the attribute ID.

predefined

A Boolean that is a flag that specifies whether the attribute has a defined set of values in the Attr_Set table.

data_type

An integer that is an enumeration that indicates the data type of the attribute, from the data_type column of the Attr table linked by the attr_id.

0 = string (<= 80 characters; the default data type)

1 = drop-down list of values defined in the Attr_Set table

2 = integer

3 = currency

4 = color

5 = datetime

6 = floating point number

7 = percent

8 = check box

9 = non-editable

10 = time of day

11 = item reason (only if attr_grp = 3)

12 = long string (> 80 characters)

attr_desc

A string that is the description of the attribute, from the attr_desc column of the Attr table linked by the attr_id.

attr_grp

An integer that is an enumeration that indicates the group to which the attribute belongs, from the Attr table.

1 = Items

2 = Entities

3 = Lots

4 = Item Classes

5 = Jobs

6 = WO

7 = Operations

8 = Processes

9 = Sublot

10 = Samples

11 = Results

12 = Lines

13 = Shifts

filter

A string that is the situation to which this attribute applies.

entry_type

An enumeration that indicates the type of entry to allow for this attribute, from the entry_type column in the Attr table linked by the attr_id.

0 = value only (the default)

1 = notes only

2 = value and notes

last_edit_comment

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

last_edit_by

A string that is the ID of the user who added or last updated this record.

last_edit_at

 A datetime that indicates when the record was added or last updated.

Remarks

This method returns a DataSet of available attributes from the Attr table whose attribute group belongs to item (=1). The available list of item attributes are retrieved based on the following criteria:

  • The attribute must belong to item group (attr_grp = 1).
  • If the attribute has a certification attached to it, the supplied user must have this certification, at a level that is equal to or greater than the required certification level, or no users may have this certification.
  • All attributes that are currently assigned to the supplied item are excluded from the DataSet.

See Also

Reference

ItemAttr Class
ItemAttr Members

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