mt material server api
TRANSCRIPT
-
7/24/2019 Mt Material Server API
1/70
-
7/24/2019 Mt Material Server API
2/70
Modified: 4/16/2010 2:26:16 PM
Contact Rockwell Customer Support Telephone 1.440.646.3434Online Support http://www.rockwellautomation.com/support/
Copyright Notice 2010 Rockwell Automation, Inc. All rights reserved. Printed in USA.This document and any accompanying Rockwell Software products are copyrighted by Rockwell
Automation, Inc. Any reproduction and/or distribution without prior written consent from Rockwell
Automation, Inc. is strictly prohibited. Please refer to the license agreement for details.
Trademark Notices FactoryTalk, Rockwell Automation, Rockwell Software, RSBizWare, and RSBizWare MaterialTrack aretrademarks of Rockwell Automation, Inc.
Any Rockwell Automation software or hardware not mentioned here is also a trademark, registered or
otherwise, of Rockwell Automation, Inc.
Other Trademarks ActiveX, Microsoft, Microsoft Access, SQL Server, Visual Basic, Visual C++, Visual SourceSafe,Windows, Windows Server-, Windows XP, and Vista are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
Adobe, Acrobat, and Reader are either registered trademarks or trademarks of Adobe Systems
Incorporated in the United States and/or other countries.
All other trademarks are the property of their respective holders and are hereby acknowledged.
Warranty This product is warranted in accordance with the product license. The products performance may beaffected by system configuration, the application being performed, operator control, maintenance, and
other related factors. Rockwell Automation is not responsible for these intervening factors. The
instructions in this document do not cover all the details or variations in the equipment, procedure, or
process described, nor do they provide directions for meeting every possible contingency during
installation, operation, or maintenance. This products implementation may vary among users.
This document is current as of the time of release of the product; however, the accompanying software
may have changed since the release. Rockwell Automation, Inc. reserves the right to change any
information contained in this document or the software at anytime without prior notice. It is yourresponsibility to obtain the most current information available from Rockwell when installing or using
this product.
http://www.rockwellautomation.com/support/http://www.rockwellautomation.com/support/http://www.rockwellautomation.com/support/http://www.rockwellautomation.com/support/ -
7/24/2019 Mt Material Server API
3/70
iii
Chapter 1 Introducing Material Server API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Document Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Material Server API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Material Object Model Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Available Interface Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Chapter 2 Material Interface Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
CreateTestResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
DeleteContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
DeleteContainerMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12DeleteContainerProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
DeleteContainerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
DeleteErrorCorrection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
DeleteLimit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14DeleteLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
DeleteLotProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
DeleteLotState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
DeleteMaterial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
DeleteMaterialClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16DeleteMaterialClassProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
DeleteMaterialProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
DeleteMaterialType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18DeleteStorageLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
DeleteSubLot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
DeleteTestResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19DeleteTestSpecification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
DistributeSubLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
GetContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22GetContainerByControllerID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
GetContainerByID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23GetContainerList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24GetContainerOrStorageLocationMaterials . . . . . . . . . . . . . . . . . . . . . . . . 25
GetContainerPriortyListByContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
GetContainerPriorityListByMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26GetContainers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
GetContainersHavingMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
GetContainerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27GetContainerStateList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
GetContainerStates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Contents
-
7/24/2019 Mt Material Server API
4/70
Material Server API Technical Reference
iv
Interface Definitions (continued)
GetErrorCorrection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29GetErrorCorrections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
GetLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
GetLotList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31GetLots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32GetLotState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
GetLotStateList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
GetLotStates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33GetMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
GetMaterialByControllerID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
GetMaterialByID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35GetMaterialClass. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
GetMaterialClassByID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
GetMaterialClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
GetMaterialClassList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37GetMaterialList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
GetMaterials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
GetMaterialType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39GetMaterialTypeByID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
GetMaterialTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
GetMaterialTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41GetStorageLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
GetStorageLocationByID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
GetStorageLocationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42GetStorageLocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
InsertContainer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
InsertContainerMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
InsertContainerProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44InsertContainerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
InsertErrorCorrection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
InsertErrorCorrectionResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
InsertLimit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46InsertLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
InsertLotState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
InsertMaterial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
InsertMaterialClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47InsertMaterialClassProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
InsertMaterialProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48InsertMaterialType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49InsertStorageLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
InsertSubLot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
InsertTestSpecification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50IsLotAuthor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
IsMaterialAuthor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
IsMaterialServerAvailable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51IsMaterialViewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
MapMaterialClassProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
-
7/24/2019 Mt Material Server API
5/70
Contents
v
Interface Definitions (continued)
MaterialClassProperties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53UpdateContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
UpdateContainerPriority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
UpdateContainerProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54UpdateContainerState. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55UpdateErrorCorrection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
UpdateErrorCorrectionResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
UpdateLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56UpdateLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
UpdateLotProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
UpdateLotState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58UpdateMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
UpdateMaterialClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
UpdateMaterialClassProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
UpdateMaterialProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60UpdateMaterialType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
UpdateStorageLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
UpdateSubLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61UpdateTestResult. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
UpdateTestSpecification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
-
7/24/2019 Mt Material Server API
6/70
Material Server API Technical Reference
vi
-
7/24/2019 Mt Material Server API
7/70
-
7/24/2019 Mt Material Server API
8/70
Material Server API Technical Reference
2
The material object model provides the interface to the Material Server:
Material Object Model Descriptions
The following section describes the objects that comprise the material object model.
MaterialSvr
MaterialProperties
Lots
SubLots
Containers
ContainerProperties
StorageLocations
Materials
Legend
Object Only
Object and Collection
MaterialClasses
LotProperties
ContainerMaterials
SubLots
Lots
MaterialClassProperties
SubLots
MaterialTypes
LotStates
ContainerStates
QATestResults
QAErrorCorrections
QATestResults
SubLots
QATestSpecs
Object Description
Container Represents a single Container record from the material database. The
Container object also can be represented as a collection of Containers.
The Container object contains collections for ContainerMaterials,
ContainerProperties, and SubLots. Each Container object can contain 1
to N ContainerMaterial, ContainerProperty, and SubLot collections.
ContainerMaterial Represents a single ContainerMaterial record from the material
database. The ContainerMaterial object also can be represented as a
collection of ContainerMaterials.
ContainerProperty Represents a single ContainerProperty record from the material
database. The ContainerProperty object also can be represented as a
collection of ContainerProperties. No methods are associated with this
object.
ContainerState Represents a single ContainerState record from the material database.
The ContainerState object also can be represented as a collection of
ContainerStates.
-
7/24/2019 Mt Material Server API
9/70
1 Introducing Material Server API
3
Lot Represents a single Lot record from the material database. The Lot
object also can be represented as a collection of Lots. The Lot object
contains collections for LotProperties, and SubLots. Each Lot object
can contain 1 to N LotProperties, and SubLots collections.
LotProperty Represents a single LotProperty record from the material database. The
LotProperty object also can be represented as a collection of
LotProperties. No methods are associated with this object.
LotState Represents a single LotState record from the material database. The
LotState object also can be represented as a collection of LotStates.
Material Represents a single material record from the material database. The
material class also can be represented as a collection of Materials. The
Material object contains collections for MaterialProperties, Lots, and
SubLots. Each Material object can contain 1 to N MaterialProperties,
Lots, and SubLots collections.
MaterialType Represents a single MaterialType record from the material database.
The MaterialType object also can be represented as a collection of
MaterialTypes.
MaterialClass Represents a single MaterialClass record from the material database.
The MaterialClass object also can be represented as a collection of
MaterialClasses.
MaterialProperty Represents a single MaterialProperty record from the material
database. The MaterialProperties collection can contain from 1 to N
MaterialProperty objects. No methods are associated with this object.
MaterialSvr Provides methods that can be executed to perform some specific task
of the Material Server. There are no properties available from thisclass. Although this class acts as an independent entity, it is the base
class that is used to expose the lower level Material Manager classes.
StorageLocation Represents a single StorageLocation record from the material database.
The StorageLocation object also can be represented as a collection
of StorageLocations. The StorageLocation object contains collections
for StorageLocationMaterials. Each StorageLocation object can
contain 1 to
N StorageLocationMaterials collections.
SubLot Represents a single SubLot record from the material database. The
SubLot object also can be represented as a collection of SubLots.
Object Description
-
7/24/2019 Mt Material Server API
10/70
Material Server API Technical Reference
4
Three methods are assumed to be available for every collection class in the Material
Object Model.
Available Interface Definitions
The following is a list of all supported interface definitions in the material object model:
Method Description
Count Returns the number of items in the collection.
Item Returns a reference to an item in the collection via the index of the
item.
NewEnum Delegates an enumerator to the collection object. This allows for the
use of For...Each statements to iterate through the members of the
collection.
Item Description
CreateTestResult on
page 11
Inserts a QA test result record associated with a test specification into
the material database.
DeleteContainer on
page 11
Deletes a Container from the material database.
DeleteContainerMateri
al on page 12
Deletes a ContainerMaterial from the material database.
DeleteContainerProper
ty on page 12
Deletes a ContainerProperty from the material database.
DeleteContainerState
on page 13
Deletes a ContainerState from the material database.
DeleteErrorCorrection
on page 13
Deletes a QA error correction record associated with a test
specification in the material database.
DeleteLimit on
page 14
Deletes a QA test specification limit record associated with a base test
specification in the material database.
DeleteLot on page 14 Deletes a Lot record from the material database.
DeleteLotProperty on
page 15
Deletes a LotProperty from the material database.
DeleteLotState on
page 15
Deletes a LotState from the material database.
DeleteMaterial on
page 16
Deletes a Material record from the material database.
DeleteMaterialClass
on page 16
Deletes a MaterialClass record from the material database.
-
7/24/2019 Mt Material Server API
11/70
1 Introducing Material Server API
5
DeleteMaterialClassPr
operty on page 17
Deletes a MaterialClassProperty record from the material database.
DeleteMaterialPropert
y on page 17
Deletes a MaterialProperty record from the material database.
DeleteMaterialType
on page 18
Deletes a MaterialType record from the material database.
DeleteStorageLocation
on page 18
Deletes a StorageLocation record from the material database.
DeleteSubLot on
page 19
Deletes a SubLot record from the material database.
DeleteTestResult on
page 19
Deletes a QA test result record associated with a test specification in
the material database.
DeleteTestSpecificatio
n on page 20
Deletes a QA test specification record from the material database.
DistributeSubLot on
page 21
Distributes all or a portion of a Lots total quantity to a Container. Also
distributes or redistributes portions of existing SubLots to other
Containers.
GetContainer on
page 22
Returns a Container object with its properties populated with
corresponding data from the material database, based on the Container
Name.
GetContainerByContr
ollerID on page 23
Returns a Container object populated with the specified Container data
from the material database, based on the ControllerID.
GetContainerByID on
page 23
Returns a Container object with its properties populated with
corresponding data from the material database, based on the
ContainerID.
GetContainerList on
page 24
Returns a list of Containers in a multi-dimensioned array.
GetContainerOrStorag
eLocationMaterials on
page 25
Returns a collection of ContainerMaterial objects that are configured
for use with a specified Container or StorageLocation.
GetContainerPriortyLi
stByContainer on
page 25
Returns a collection of 1 to N ContainerPriority objects.
GetContainerPriorityL
istByMaterial on
page 26
Returns a collection of 1 to N ContainerPriority objects.
GetContainers on
page 26
Returns a collection of 1 to N Container objects.
Item Description
-
7/24/2019 Mt Material Server API
12/70
Material Server API Technical Reference
6
GetContainersHaving
Material on page 27
Returns a collection of 1 to N MaterialContainer objects.
GetContainerState on
page 27
Returns a ContainerState object with its properties populated with
corresponding data from the material database, based on the
ContainerState Name.
GetContainerStateList
on page 28
Returns a list of ContainerStates in a multi-dimensioned array.
GetContainerStates
on page 28
Returns a collection of 1 to N ContainerState objects.
GetErrorCorrection
on page 29
Gets an instance of an ErrorCorrection object based on the name of the
error correction passed to the interface.
GetErrorCorrectionson page 29
Gets a list of QA error corrections and presents it to the user as acollection of ErrorCorrection objects.
GetLot on page 30 Returns a Lot object populated with the specified Lot data from the
material database, based on the Lot name.
GetLotList on
page 31
Returns a list of Lot objects in a multi-dimensioned array.
GetLots on page 32 Returns a collection of 1 to N Lot objects.
GetLotState on
page 32
Returns a LotState object populated with the specified LotState data
from the material database, based on the LotState name.
GetLotStateList onpage 33
Returns a list of LotStates in a multi-dimensioned array.
GetLotStates on
page 33
Returns a collection of 1 to N LotState objects.
GetMaterial on
page 34
Returns a Material object populated with the specified Material data
from the material database, based on the Material name.
GetMaterialByControl
lerID on page 34
Returns a Material object populated with the specified Material data
from the material database, based on the ControllerID.
GetMaterialByID on
page 35
Returns a Material object with its properties populated with
corresponding data from the material database, based on the
MaterialID.
GetMaterialClass on
page 35
Returns a MaterialClass object that is populated with the specified
MaterialClass data from the material database, based on the
MaterialClass name.
GetMaterialClassByID
on page 36
Returns a MaterialClass object with its properties populated with
corresponding data from the material database, based on the
MaterialClassID.
Item Description
-
7/24/2019 Mt Material Server API
13/70
1 Introducing Material Server API
7
GetMaterialClasses
on page 36
Returns a collection of 1 to N MaterialClass objects.
GetMaterialClassList
on page 37
Returns a list of Material objects in a multi-dimensioned array.
GetMaterialList on
page 38
Returns a list of Material objects in a multi-dimensioned array.
GetMaterials on
page 39
Returns a collection of 1 to N Material objects.
GetMaterialType on
page 39
Returns a Type object populated with the specified MaterialType data
from the material database based on the MaterialType Name.
GetMaterialTypeByID
on page 40
Returns a MaterialType object with its properties populated with
corresponding data from the material database, based on theMaterialTypeID.
GetMaterialTypeList
on page 40
Returns a list of MaterialType objects in a multi-dimensioned array.
GetMaterialTypes on
page 41
Returns a collection of 1 to N MaterialType objects.
GetStorageLocation
on page 41
Returns a StorageLocation object populated with the specified
StorageLocation data from the material database, based on the Storage
Location name.
GetStorageLocationBy
ID on page 42
Returns a StorageLocation object with its properties populated with
corresponding data from the material database, based on theStorageLocationID.
GetStorageLocationLi
st on page 42
Returns a list of StorageLocations in a multi-dimensioned array.
GetStorageLocations
on page 43
Returns a collection of 1 to N StorageLocation objects.
InsertContainer on
page 43
Inserts a Container record into the material database.
InsertContainerMateri
al on page 43
Inserts a ContainerMaterial record into the material database.
InsertContainerPropert
y on page 44
Inserts a ContainerProperty record into the material database.
InsertContainerState
on page 44
Inserts a Container State record into the material database.
InsertErrorCorrection
on page 45
Inserts a QA error correction record associated with a test specification
in the material database.
Item Description
-
7/24/2019 Mt Material Server API
14/70
Material Server API Technical Reference
8
InsertErrorCorrection
Result on page 45
Inserts a QA error correction result record associated with a test result
in the material database.
InsertLimit on
page 46
Inserts a QA test specification limit record associated with a base test
specification in the material database.
InsertLot on page 46 Inserts a Lot record into the material database.
InsertLotState on
page 47
Inserts a Lot State record into the material database.
InsertMaterial on
page 47
Inserts a Material record into the material database.
InsertMaterialClass
on page 47
Inserts a MaterialClass record into the material database.
InsertMaterialClassPro
perty on page 48
Inserts a MaterialClassProperty record into the material database.
InsertMaterialProperty
on page 48
Inserts a MaterialProperty record into the material database.
InsertMaterialType
on page 49
Inserts a Material Type record into the material database.
InsertStorageLocation
on page 49
Inserts a StorageLocation record into the material database.
InsertSubLot on
page 49
Inserts a SubLot record into the material database.
InsertTestSpecification
on page 50
Inserts a QA test specification record into the material database.
IsLotAuthor on
page 50
Returns a Boolean value (TRUE or FALSE) indicating if the current
user has rights to the Lot Author security role.
IsMaterialAuthor on
page 51
Returns a Boolean value (TRUE or FALSE) indicating if the current
user has rights to the Material Author security role.
IsMaterialServerAvaila
ble on page 51
Returns a Boolean value (TRUE or FALSE) indicating if there is
communications to the Material Server.
IsMaterialViewer onpage 52
Returns a Boolean value (TRUE or FALSE) indicating if the currentuser has rights to the Material Viewer security role.
MapMaterialClassProp
erty on page 52
Maps a MaterialClassProperty record to the material definition in the
material database.
MaterialClassPropertie
s on page 53
Returns a collection of MaterialClassProperty objects that are derived
from the material class upon which they are based.
UpdateContainer on
page 53
Updates a Container record in the material database.
Item Description
-
7/24/2019 Mt Material Server API
15/70
1 Introducing Material Server API
9
UpdateContainerPriori
ty on page 54
Updates a ContainerPriority record in the material database.
UpdateContainerPrope
rty on page 54
Updates a ContainerProperty record in the material database.
UpdateContainerState
on page 55
Updates a ContainerState record in the material database.
UpdateErrorCorrection
on page 55
Updates a QA error correction record associated with a test
specification in the material database.
UpdateErrorCorrection
Result on page 56
Updates a QA error correction result record associated with a test
result in the material database.
UpdateLimit on
page 56
Updates a QA test specification limit record associated with a base test
specification in the material database.
UpdateLot on page 57 Updates a Lot record in the material database.
UpdateLotProperty
on page 57
Updates a LotProperty record in the material database.
UpdateLotState on
page 58
Updates a LotState record in the material database.
UpdateMaterial on
page 58
Updates a Material record in the material database.
UpdateMaterialClass
on page 59
Updates a Class record in the material database.
UpdateMaterialClassP
roperty on page 59
Updates a MaterialClassProperty record in the material database.
UpdateMaterialPropert
y on page 60
Updates a MaterialProperty record in the material database.
UpdateMaterialType
on page 60
Updates a MaterialType record in the material database.
UpdateStorageLocatio
n on page 61
Updates a StorageLocation record in the material database.
UpdateSubLot onpage 61
Updates a SubLot record in the material database.
UpdateTestResult on
page 62
Updates a QA test result record associated with a test specification in
the material database.
UpdateTestSpecificati
on on page 62
Updates a QA test specification record in the material database.
Item Description
-
7/24/2019 Mt Material Server API
16/70
Material Server API Technical Reference
10
-
7/24/2019 Mt Material Server API
17/70
11
CHAPTER2
Material Interface DefinitionsThis section describes all public interface definitions for the material object model.
CREATETESTRESULT
Inserts a QA test result record associated with a test specification in the material database.
Syntax
TestSpecification.CreateTestResult(TestResultAs TestResult,LotAs Lot)
The CreateTestResultmethod syntax has these parts:
Remarks
This interface allows for the creation of QA test results in the material database.
DELETECONTAINER
Deletes a Container from the material database.
Syntax
MaterialSvr.DeleteContainer(Container As Container, [ActivityDescriptionAs String])
TheDeleteContainer method syntax has these parts:
Part Description
TestSpecification Instance of the TestSpecification interface to which the method is
directed.
TestResult An instance of a TestResult object.
Lot An instance of the Lot object that the test specification is being
executed against.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Container An instance of a Container object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
-
7/24/2019 Mt Material Server API
18/70
-
7/24/2019 Mt Material Server API
19/70
2 Material Interface Definitions
13
DELETECONTAINERSTATE
Deletes a ContainerState from the material database.
SyntaxMaterialSvr.DeleteContainerState(ContainerState As ContainerState)
The DeleteContainerStatemethod syntax has these parts:
Remarks
A ContainerState can only be deleted if no Containers are using it. There is no provision in
this method to override this functionality or un-associate the Containers that are using the
ContainerState.
The Ready To Use ContainerState is system-defined and cannot be deleted via this
interface or any other means.
DELETEERRORCORRECTION
Deletes a QA error correction record associated with a test specification in the material
database.
Syntax
MaterialSvr.DeleteErrorCorrection(ErrorCorrectionAs ErrorCorrection)
The DeleteErrorCorrectionmethod syntax has these parts:
Remarks
This interface allows for the deletion of QA error corrections from the material database.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
ContainerState An instance of a ContainerState object.
Part Description
MaterialSvr Instance of the MaterialSvr interface to which the method is
directed.
ErrorCorrection An instance of an ErrorCorrection object.
-
7/24/2019 Mt Material Server API
20/70
Material Server API Technical Reference
14
DELETEL IMIT
Deletes a QA test specification limit record associated with a base test specification in the
material database.
Syntax
TestSpecification.DeleteLimit(TestSpecificationLimitAs TestSpecificationLimit)
The DeleteLimitmethod syntax has these parts:
Remarks
This interface allows for the deletion of a QA test specification limit record from the
material database.
DELETELOT
Deletes a Lot record from the material database.
Syntax
Material.DeleteLot(Lot As Lot, [ActivityDescriptionAs String])
The DeleteLotmethod syntax has these parts:
Remarks
Along with deleting the Lot, this interface will delete SubLots and LotProperties
associated with the specified Lot.
Part Description
TestSpecification Instance of the QATestSpec interface to which the method is
directed.
TestSpecificationLimit An instance of a TestSpecificationLimit object.
Part Description
Material Instance of the Material object to which the method is directed.
Lot An instance of a Lot object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
-
7/24/2019 Mt Material Server API
21/70
2 Material Interface Definitions
15
DELETELOTPROPERTY
Deletes a LotProperty from the material database.
SyntaxLot.DeleteLotProperty(LotProperty As LotProperty, [ActivityDescriptionAs String])
The DeleteLotPropertymethod syntax has these parts:
DELETELOTSTATE
Deletes a LotState from the material database.
Syntax
MaterialSvr.DeleteLotState(LotState As LotState)
The DeleteLotStatemethod syntax has these parts:
Remarks
A LotState can only be deleted if no Lots are using it. There is no provision in this method
to override this functionality, nor is there a way to un-associate the Lots that are using the
LotState.
The Ready To Use LotState is system-defined and cannot be deleted.
Part Description
Lot Instance of a Lot object to which the method is directed.
LotProperty An instance of a LotProperty object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
LotState An instance of a LotState object.
-
7/24/2019 Mt Material Server API
22/70
Material Server API Technical Reference
16
DELETEMATERIAL
Deletes a Material record from the material database.
SyntaxMaterialSvr.DeleteMaterial(Material As Material, [ActivityDescription As String])
The DeleteMaterialmethod syntax has these parts:
Remarks
Along with the deletion of the Material, all associated MaterialProperties, LotProperties,
Lots, and SubLots are deleted from the database.
DELETEMATERIALCLASS
Deletes a MaterialClass record from the material database.
Syntax
MaterialSvr.DeleteMaterialClass(MaterialClass As MaterialClass)
The DeleteMaterialClassmethod syntax has these parts:
Remarks
A MaterialClass can only be deleted if there are no Materials using it. There is no
provision in this method to override this functionality or un-associate the Materials that
are using the MaterialClass.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Material An instance of a Material object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialClass An instance of a MaterialClass object.
-
7/24/2019 Mt Material Server API
23/70
2 Material Interface Definitions
17
DELETEMATERIALCLASSPROPERTY
Deletes a MaterialClassProperty record from the material database.
SyntaxMaterialClass.DeleteMaterialClassProperty(MaterialClassProperty As
MaterialClassProperty), [ActivityDescriptionAs String])
The DeleteMaterialClassPropertymethod syntax has these parts:
Remarks
Executing this interface will delete the MaterialClassProperty from the material database
and remove all mapped material definition properties.
DELETEMATERIALPROPERTY
Deletes a MaterialProperty record from the material database.
Syntax
Material.DeleteMaterialProperty(MaterialProperty As MaterialProperty,
[ActivityDescriptionAs String])
TheDeleteMaterialProperty method syntax has these parts:
Remarks
Along with the MaterialProperty, all LotProperties associated with the specified
MaterialProperty are deleted.
Part Description
MaterialClass Instance of the MaterialClass object to which the method is
directed.
MaterialClassProperty An instance of a MaterialClassProperty object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
Part Description
Material Instance of the Material object to which the method is directed.
MaterialProperty An instance of a MaterialProperty object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
-
7/24/2019 Mt Material Server API
24/70
Material Server API Technical Reference
18
DELETEMATERIALTYPE
Deletes a MaterialType record from the material database.
SyntaxMaterialSvr.DeleteMaterialType(MaterialTypeAs MaterialType)
The DeleteMaterialType method syntax has these parts:
Remarks
A Material Type can only be deleted if there are no Materials using it. There is no
provision in this method to override this functionality or un-associate the Materials that
are using the MaterialType. The MaterialTypes Raw, Intermediate, and Finished are
system-defined MaterialTypes and cannot be deleted.
DELETESTORAGELOCATION
Deletes a StorageLocation record from the material database.
Syntax
MaterialSvr.DeleteStorageLocation(StorageLocation As StorageLocation,
[ActivityDescriptionAs String])
The DeleteStorageLocation method syntax has these parts:
Remarks
A StorageLocation can only be deleted if there are no Containers using it. There is no
provision in this method to override this functionality, nor is there a way to un-associate
the Containers that are using the StorageLocation.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialType An instance of a MaterialType object.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
StorageLocation An instance of a StorageLocation object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
-
7/24/2019 Mt Material Server API
25/70
2 Material Interface Definitions
19
DELETESUBLOT
Deletes a SubLot record from the material database.
SyntaxMaterialSvr.DeleteSubLot(SubLot As SubLot, [ActivityDescriptionAs String])
Lot.DeleteSubLot(SubLot As SubLot, [ActivityDescriptionAs String])
TheDeleteSubLot method syntax has these parts:
Remarks
SubLots that are deleted do not have the effect of returning any of the remaining SubLot
quantity back to the Lot in which the SubLot was created. In effect, the SubLot and any
quantity are deleted from inventory.
This method is available in two locations within the Material Object Model: the
MaterialServer object and the Lot Object. Use the one that is appropriate for your needs.
DELETETESTRESULT
Deletes a QA test result record associated with a test specification in the material database.
Syntax
TestSpecification.DeleteTestResult(TestResultAs TestResult)
The DeleteTestResultmethod syntax has these parts:
Remarks
This interface allows for the deletion of QA test results from the material database.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Lot Instance of a Lot object to which the SubLots are to be deleted from.
SubLot An instance of a SubLot object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
Part Description
TestSpecification Instance of the QATestSpec interface to which the method is
directed.
TestResult An instance of a TestResult object.
-
7/24/2019 Mt Material Server API
26/70
Material Server API Technical Reference
20
DELETETESTSPECIFICATION
Deletes a QA test specification record from the material database.
SyntaxMaterial.DeleteTestSpecification(TestSpecificationAs TestSpecification,ForceDeleteas
Boolean)
The DeleteTestSpecification method syntax has these parts:
Remarks
This interface will not only delete the QA test specification it will also delete all QA
test specification details that are a part of the test specification.
TheForceDeleteargument allows the user to delete a test specification and all associated
test result data by setting the value to TRUE. If the value is set to FALSE and the testspecification has associated test results, the test specification cannot be deleted.
Part Description
Material Instance of the Material interface to which the method is directed.
TestSpecification An instance of a QATestSpec object.
ForceDelete TRUE | FALSE
TRUE deletes the test specification and all detail.
FALSEdeletes the test specification if there is no detail
information. FALSE is the default for the argument, so the user must
explicitly set to TRUE to cause a force delete to occur.
-
7/24/2019 Mt Material Server API
27/70
2 Material Interface Definitions
21
D ISTRIBUTESUBLOT
Distributes all or a portion of a Lots total quantity to a Container. It also can be used to
distribute or redistribute portions of existing SubLots to other Containers.
Syntax
SubLot.DistributeSubLot(ByVal Quantity As Double, ByVal ContainerAs Long, [ByVal
LabelAs String, [ActivityDescription As String])
The DistributeSubLotmethod syntax has these parts:
Part Description
SubLot Instance of the SubLot object to which the method is directed.
Quantity Represents the Quantity of the SubLot to distribute.
Container Represents the ContainerID of the Container that is being
distributed to.
Label Represents the Label that can be applied to the distributed SubLot.
(Optional)
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
-
7/24/2019 Mt Material Server API
28/70
Material Server API Technical Reference
22
GETCONTAINER
Returns a Container object with its properties populated with corresponding data from the
material database, based on the Container Name.
Syntax
Set object =MaterialSvr.GetContainer(ByVal ContainerName As String, UseCollection
As Boolean)
The GetContainermethod syntax has these parts:
Remarks
Although this method loads the Container data of the Container object, this object contains
a collection of ContainerProperties and ContainerMaterials. These collection objects are
not populated until you explicitly call those properties on the Container object. The
purpose for this is that pre-loading these collection objects is a performance hit that need
not be taken unless those particular elements are required.
Part Description
object Reference to a valid Container object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
ContainerName Name of the Container.
UseCollection True:The method attempts to locate the specified Container in a
Container collection. If no collection is present, one is created and
the record is read from the collection. If one is present, reading from
a collection is much quicker than making a round trip to the
database. If however there is no collection and one has to be
constructed, this option may prove to be less optimal than reading
from the database.
False:The method reads the record directly from the database.
-
7/24/2019 Mt Material Server API
29/70
2 Material Interface Definitions
23
GETCONTAINERBYCONTROLLERID
Returns a Container object populated with the specified Container data from the material
database, based on the ControllerID.
Syntax
object=MaterialSvr.GetContainerByControllerID (ByVal ControllerIDAs Long)
The GetContainerByControllerIDmethod syntax has these parts:
GETCONTAINERBYID
Returns a Container object with its properties populated with corresponding data from the
material database, based on the ContainerID.
Syntax
Set object =MaterialSvr.GetContainerByID(ByVal ContainerID As Long)
The GetContainerByIDmethod syntax has these parts:
Remarks
Although this method loads the Container data of the Container object, this object contains
a collection of ContainerProperties and ContainerMaterials. These collection objects are
not populated until you explicitly call those properties on the Container object. The
purpose for this is that pre-loading these collection objects is a performance hit that need
not be taken unless those particular elements are required.
Part Description
object Reference to a valid Container object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
ControllerID ControllerID of the Container being requested. It is expected that
the program using this interface know the ControllerID for the data
entity it wants to access.
Part Description
object Reference to a valid Container object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
ContainerID ID of the Container being requested.
-
7/24/2019 Mt Material Server API
30/70
Material Server API Technical Reference
24
GETCONTAINERL IST
Returns a list of Containers in a multi-dimensioned array.
SyntaxvResult=MaterialSvr.GetContainerList(ByVal ContainerFilterAs ContainerFilterEnum
, ByValFilterValueAs String)
The GetContainerList methodsyntax has these parts:
Where vResultis:
Part Description
vResult The data returned by the Material Server.
MaterialSvr Instance of the MaterialServer Batch Interface to which the method
is directed.
ContainerFilter An enumeration representing a set of pre-defined filters.
Enumeration:
0 = GetAllContainers
1 = GetContainersNotInStorageLocation
2 = GetContainersInStorageLocation
3 = GetIndependantContainersAndStorageLocations
4 = GetAllContainersInAllStorageLocations
FilterValue A string representing the Storage Location name, used by the
ContainerFilter to filter on.
Part Description
vResult Is a two dimensional array containing
|
ContainerData Array Element [0] = ControllerID
Array Element [1] = ConatinerName
-
7/24/2019 Mt Material Server API
31/70
2 Material Interface Definitions
25
GETCONTAINERORSTORAGELOCATIONMATERIALS
Returns a collection of ContainerMaterial objects that are configured for use with a
specified Container or StorageLocation.
Syntax
MaterialSvr.GetContainerOrStorageLocationMaterials(ContainerOrStorageLocation
NameAs String) As ContainerMaterials
TheGetContainerOrStorageLocationMaterials method syntax has these parts:
Remarks
Pass it the name of a Container or StorageLocation to get back a list of Materials that are
configured for use with the specified Container or StorageLocation.
GETCONTAINERPRIORTYL ISTBYCONTAINER
Returns a collection of 1 to N ContainerPriority objects.
Syntax
Set object=MaterialSvr.GetContainerPriorityListByContainer(ContainerName As
String)
The GetContainerPriorityListByContainermethod syntax has these parts:
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
ContainerOrStorageLocationName
The instance of a Container or StorageLocation.
Part Description
object Reference to a valid ContainerPriorities collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
ContainerName String representing the name of the Container you want to produce
the list from.
-
7/24/2019 Mt Material Server API
32/70
Material Server API Technical Reference
26
GETCONTAINERPRIORITYL ISTBYMATERIAL
Returns a collection of 1 to N ContainerPriority objects.
SyntaxSet object=MaterialSvr.GetContainerPriorityListByMaterial(MaterialName As
String)
The GetContainerPriorityListByMaterialmethod syntax has these parts:
GETCONTAINERS
Returns a collection of 1 to N Container objects.
Syntax
Set object=MaterialSvr.GetContainers()
TheGetContainers method syntax has these parts:
Part Description
object Reference to a valid ContainerPriorities collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialName String representing the name of the Material you want to produce
the list from.
Part Description
object Reference to a valid Containers collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
-
7/24/2019 Mt Material Server API
33/70
2 Material Interface Definitions
27
GETCONTAINERSHAVINGMATERIAL
Returns a collection of 1 to N MaterialContainer objects.
SyntaxSet object=MaterialSvr.GetContainersHavingMaterial(IMaterialIDAs Long)
TheGetContainersHavingMaterial method syntax has these parts:
GETCONTAINERSTATE
Returns a ContainerState object with its properties populated with corresponding data
from the material database, based on the ContainerState Name.
Syntax
Set object =MaterialSvr.GetContainerState(ByValsName As String, UseCollectionAs
Boolean)
TheGetContainerStatemethod syntax has these parts:
Part Description
object Reference to a valid MaterialContainers collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialID Represents the ID of the Material.
Part Description
object Reference to a valid ContainerState object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
sName Represents the name of the ContainerState.
UseCollection True: Attempts to locate the specified ContainerState in a pre-
populated collection. If no collection is present, one is created and
the record is read from the collection.False: Reads the record directly from the database.
-
7/24/2019 Mt Material Server API
34/70
Material Server API Technical Reference
28
GETCONTAINERSTATEL IST
Returns a list of ContainerStates in a multi-dimensioned array.
SyntaxvResult=MaterialSvr.GetContainerStateList()
TheGetContainerStateListmethod syntax has these parts:
Where vResultis:
Remarks
In order to test for an empty array, you must test the upper and lower bounds of the vResult
array. If both bounds are zero, then the array is empty and can be treated as such.
GETCONTAINERSTATES
Returns a collection of 1 to N ContainerState objects.
Syntax
Set object=MaterialSvr.GetContainerStates()
The GetContainerStates method syntax has these parts:
Part Description
vResult The data returned by the Material Server.
MaterialSvr Instance of the MaterialServer Batch Interface to which the method
is directed.
Part Description
vResult Is a two dimensional array containing
|
ContainerStateData Array Element [0] = PKid
Array Element [1] = Name
Array Element [2] = Description
Array Element [3] = ControllerID
Part Description
object Reference to a valid ContainerStates collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
-
7/24/2019 Mt Material Server API
35/70
2 Material Interface Definitions
29
GETERRORCORRECTION
Gets an instance of an ErrorCorrection object based on the name of the error correction
passed to the interface.
Syntax
MaterialSvr.GetErrorCorrection(sName AS String, UseCollectionAS Boolean) As
ErrorCorrection
The GetErrorCorrectionmethod syntax has these parts:
Remarks
This interface provides you with the ability to get an instance of a particular error
correction object by providing the error correction name.
GETERRORCORRECTIONS
Gets a list of QA error corrections and presents it to the user as a collection of
ErrorCorrection objects.
Syntax
MaterialSvr.GetErrorCorrections( ) As ErrorCorrections
The GetErrorCorrections method syntax has these parts:
Remarks
This interface provides you with a list of QA error corrections.
Part Description
MaterialSvr Instance of the MaterialSvr interface to which the method is
directed.
sName Name of the error correction being retrieved.
UseCollection Boolean that, when set to TRUE, determines if a collection of error
corrections exist. If so, the name is used to search the collection to
get the error correction instance. If FALSE is specified then the
instance is retrieved directly from the material database. If a
collection is loaded, this is the fastest search method.
Part Description
MaterialSvr Instance of the MaterialSvr interface to which the method is
directed.
-
7/24/2019 Mt Material Server API
36/70
Material Server API Technical Reference
30
GETLOT
Returns a Lot object populated with the specified Lot data from the material database,
based on the Lot Name.
Syntax
Set object = MaterialSvr.GetLot(ByValsNameAs String, UseCollectionAs Boolean)
The GetLotmethod syntax has these parts:
Part Description
object Reference to a valid Lot object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
sName Represents the Lot Name.
UseCollection Boolean that, when set to TRUE, determines if a collection of error
corrections exist. If so, the name is used to search the collection to
get the error correction instance. If FALSE is specified then the
instance is retrieved directly from the material database. If a
collection is loaded, this is the fastest search method.
Because multiple Lots with the same name can exist in the material database this
interface will return the first instance of the given Lot name so there is a possibility that
the Lot returned will not be the Lot you are looking for. If this is the case, use the
Material.Lots property to get a collection of Lots for a given material and loop throughthis collection to find the desired Lot.
-
7/24/2019 Mt Material Server API
37/70
2 Material Interface Definitions
31
GETLOTL IST
Returns a list of Lots in a multi-dimensioned array.
SyntaxvResult=MaterialSvr.GetLotList(ByValLotFilter As LotFilterEnum, ByValFilterValue
As String)
The GetLotList method syntax has these parts:
Where vResultis:
Remarks
In order to test for an empty array, you must test the upper and lower bounds of the
vContainerListarray. If both bounds are zero, then the array is empty and can be treated assuch.
Part Description
vResult The data returned by the Material Server.
MaterialSvr Instance of the MaterialServer Batch Interface to which the method
is directed.
LotFilter An enumeration representing a set of pre-defined filters:
0 = GetAllLots
1 = ByMaterialName
FilterValue A string representing the material name that is used by the
ContainerFilter to filter on.
Part Description
vResult Is a two dimensional array containing
|
LotData Array Element [0] = PKid
Array Element [1] = Lot Name
Array Element [2] = Description
Array Element [3] = ControllerID
-
7/24/2019 Mt Material Server API
38/70
Material Server API Technical Reference
32
GETLOTS
Returns a collection of 1 to N Lot objects.
SyntaxSet object=MaterialSvr.GetLots()
The GetLotmethod syntax has these parts:
GETLOTSTATE
Returns a LotState object populated with the specified LotState data from the material
database, based on the LotStates name.
Syntax
Set object = MaterialSvr.GetLotState(ByValsNameAs String, UseCollectionAs
Boolean)
The GetLotStatemethod syntax has these parts:
Part Description
object Reference to a valid Lots collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Because multiple Lots with the same name can exist in the material database this
interface will fail if multiple Lots with the duplicate names exist. Because the key of
the Lot collection is Name and since each key has to be unique, if duplicate Lot names
exist the collection will stop at the first occurrence of a duplicate. If this is the case,
consider using the Material.Lots property to get a collection of Lots for a given Material
and loop through this collection to find the desired Lot.
Part Description
object Reference to a valid LotState object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
sName Represents the name of the LotState.
UseCollection True: Attempts to locate the specified LotState in a pre-populated
collection. If no collection is present, one is created and the record is
read from the collection.
False:Reads the record directly from the database.
-
7/24/2019 Mt Material Server API
39/70
2 Material Interface Definitions
33
GETLOTSTATEL IST
Returns a list of LotStates in a multi-dimensioned array.
SyntaxvResult=MaterialSvr.GetLotStateList()
The GetLotStateListmethod syntax has these parts:
Where vResultis:
Remarks
In order to test for an empty array, you must test the upper and lower bounds of the vResult
array. If both bounds are zero, then the array is empty and can be treated as such.
GETLOTSTATES
Returns a collection of 1 to N LotState objects.
Syntax
Set object=MaterialSvr.GetLotStates()
The GetLotStates method syntax has these parts:
Part Description
vResult The data returned by the Material Server.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Part Description
vResult Is a two dimensional array containing
|
LotStateData Array Element [0] = PKID
Array Element [1] = Name
Array Element [2] = Description
Array Element [3] = ControllerID
Part Description
object Reference to a valid LotStates collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
-
7/24/2019 Mt Material Server API
40/70
-
7/24/2019 Mt Material Server API
41/70
2 Material Interface Definitions
35
GETMATERIALBYID
Returns a Material object with its properties populated with corresponding data from the
material database, based on the MaterialID.
Syntax
Set object =MaterialSvr.GetMaterialByID(ByValIMaterialID As Long)
The GetMaterialByIDmethod syntax has these parts:
GETMATERIALCLASS
Returns a MaterialClass object that is populated with the specified MaterialClass data
from the material database, based on the MaterialClass Name.
Syntax
Set object =MaterialSvr.GetMaterialClass(ByValMaterialClassName As String,
UseCollection As Boolean)
The GetMaterialClass method syntax has these parts:
Part Description
object Reference to a valid Material object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
IMaterialID Represents the ID of the Material.
Part Description
object Reference to a valid MaterialClass object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialClassName Represents the name of the MaterialClass.
UseCollection True:Attempts to locate the specified MaterialClass in a pre-
populated collection. If no collection is present, one is created andthe record is read from the collection.
False:reads the record directly from the database.
-
7/24/2019 Mt Material Server API
42/70
Material Server API Technical Reference
36
GETMATERIALCLASSBYID
Returns a MaterialClass object with its properties populated with corresponding data from
the material database, based on the MaterialClassID.
Syntax
Set object =MaterialSvr.GetMaterialClassByID(ByValMaterialClassID As Long)
The GetMaterialClassByIDmethod syntax has these parts:
GETMATERIALCLASSES
Returns a collection of 1 to N MaterialClass objects.
Syntax
Set object=MaterialSvr.GetMaterialClasses()
TheGetMaterialClasses method syntax has these parts:
Part Description
object Reference to a valid MaterialClass object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialClassID Represents the ID of the MaterialClass.
Part Description
object Reference to a valid MaterialClasses collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
-
7/24/2019 Mt Material Server API
43/70
2 Material Interface Definitions
37
GETMATERIALCLASSL IST
Returns a list of Materials in a multi-dimensioned array.
SyntaxvResult=MaterialSvr.GetMaterialClassList()
The GetMaterialClassList method syntax has these parts:
Where vResultis:
Remarks
In order to test for an empty array, you must test the upper and lower bounds of the vResult
array. If both bounds are zero, then the array is empty and can be treated as such.
Part Description
vResult The data returned by the Material Server.
MaterialSvr Instance of the MaterialServer to which the method is directed.
Part Description
vResult Is a two dimensional array containing
|
MaterialClass
Data
Array Element [0] = PKID
Array Element [1] = MaterialClass Name
Array Element [2] = Description
Array Element [3] = ControllerID
-
7/24/2019 Mt Material Server API
44/70
Material Server API Technical Reference
38
GETMATERIALL IST
Returns a list of Materials in a multi-dimensioned array.
SyntaxvResult=MaterialSvr.GetMaterialList(MaterialFilterAsMaterialFilterEnum,
FilterValueAs String)
The GetMaterialList method syntax has these parts:
Where vResultis:
Remarks
In order to test for an empty array, you must test the upper and lower bounds of the vResult
array. If both bounds are zero, then the array is empty and can be treated as such.
Part Description
vResult The data returned by the Material Server.
MaterialSvr Instance of the MaterialServer to which the method is directed.
MaterialFilter An enumeration representing a set of pre-defined filters:
0 = GetAllMaterials
1 = GroupName
2 = ClassificationName
3 = MaterialName
FilterValue A string representing the filter value.
Part Description
vResult Is a two dimensional array containing
|
MaterialData Array Element [0] = Pkid
Array Element [1] = Name
Array Element [2] = Description
Array Element [3] = ControllerID
-
7/24/2019 Mt Material Server API
45/70
2 Material Interface Definitions
39
GETMATERIALS
Returns a collection of 1 to N Material objects.
SyntaxSet object=MaterialSvr.GetMaterials()
The GetMaterials method syntax has these parts:
GETMATERIALTYPE
Returns a Type object populated with the specified MaterialType data from the material
database based on the MaterialType Name.
Syntax
Set object =MaterialSvr.GetMaterialType(ByValMaterialTypeNameAs String,
UseCollection As Boolean)
TheGetMaterialType method syntax has these parts:
Part Description
object Reference to a valid Materials collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Part Description
object Reference to a valid Classification object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialTypeName Represents the name of the Material Type.
UseCollection True:Attempts to locate the specified MaterialType in a pre-
populated collection. If no collection is present, one is created and
the record is read from the collection.
False:Reads the record directly from the database.
-
7/24/2019 Mt Material Server API
46/70
Material Server API Technical Reference
40
GETMATERIALTYPEBYID
Returns a MaterialType object with its properties populated with corresponding data from
the material database, based on the MaterialTypeID.
Syntax
Set object =MaterialSvr.GetMaterialTypeByID(ByValMaterialTypeID As Long)
The GetMaterialTypeByIDmethod syntax has these parts:
GETMATERIALTYPEL IST
Returns a list of MaterialTypes in a multi-dimensioned array.
Syntax
vResult=MaterialSvr.GetMaterialTypeList()
The GetMaterialTypeList method syntax has these parts:
WherevResultis:
Remarks
In order to test for an empty array, you must test the upper and lower bounds of the vResult
array. If both bounds are zero, then the array is empty and can be treated as such.
Part Description
object Reference to a valid MaterialType object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialTypeID Represents the ID of the MaterialType.
Part Description
vResult The data returned by the Material Server.
MaterialSvr Instance of the MaterialServer to which the method is directed.
Part Description
vResult Is a two dimensional array containing
|
Material Classification Data Array Element [0] = Pkid
Array Element [1] = Name
Array Element [2] = Description
Array Element [3] = ControllerID
-
7/24/2019 Mt Material Server API
47/70
2 Material Interface Definitions
41
GETMATERIALTYPES
Returns a collection of 1 to N MaterialType objects.
Syntax:Set object=MaterialSvr.GetMaterialTypes()
The GetMaterialTypesmethod syntax has these parts:
GETSTORAGELOCATION
Returns a StorageLocation object populated with the specified StorageLocation data from
the material database, based on the Storage Location Name.
Syntax
Set object =MaterialSvr.GetStorageLocation(ByValsName As String, UseCollection As
Boolean)
TheGetStorageLocation method syntax has these parts:
Part Description
object Reference to a valid MaterialTypes collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Part Description
object Reference to a valid StorageLocation object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
sName Represents the ID of the StorageLocation record from the material
database.
UseCollection True:Attempts to locate the specified StorageLocation in a pre-
populated collection. If no collection is present, one is created and
the record is read from the collection.
False:Reads the record directly from the database.
-
7/24/2019 Mt Material Server API
48/70
Material Server API Technical Reference
42
GETSTORAGELOCATIONBYID
Returns a StorageLocation object with its properties populated with corresponding data
from the material database, based on the StorageLocationID.
Syntax
Set object =MaterialSvr.GetStorageLocationByID(ByValIStorageLocationID As Long)
The GetStorageLocationByIDmethod syntax has these parts:
GETSTORAGELOCATIONL IST
Returns a list of StorageLocations in a multi-dimensioned array.
Syntax
vResult=MaterialSvr.GetStorageLocationList()
The GetStorageLocationListmethod syntax has these parts:
Where vResultis:
Part Description
object Reference to a valid StorageLocation object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
IStorageLocationID Represents the ID of the StorageLocation.
Part Description
vResult The data returned by theMaterial Server.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Part Description
vResult Is a two dimensional array containing
|
StorageLocationData Array Element [0] =PKid
Array Element [1] = Name
Array Element [2] = Description
Array Element [3] = ControllerID
-
7/24/2019 Mt Material Server API
49/70
2 Material Interface Definitions
43
GETSTORAGELOCATIONS
Returns a collection of 1 to N StorageLocation objects.
SyntaxSet object=MaterialSvr.GetStorageLocations()
The GetStorageLocations method syntax has these parts:
INSERTCONTAINER
Inserts a Container record into the material database.
Syntax
MaterialSvr.InsertContainer(Container As Container)
The InsertContainer method syntax has these parts:
INSERTCONTAINERMATERIAL
Inserts a ContainerMaterial record into the material database.
Syntax
Container.InsertContainerMaterial(ContainerMaterial As ContainerMaterial)TheInsertContainerMaterialmethod syntax has these parts:
Part Description
object Reference to a valid StorageLocations collection object.
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Container An instance of a Container object.
Part Description
Container Instance of the Container object to which the method is directed.
ContainerMaterial An instance of a ContainerMaterial object.
-
7/24/2019 Mt Material Server API
50/70
Material Server API Technical Reference
44
INSERTCONTAINERPROPERTY
Inserts a ContainerProperty record into the material database.
SyntaxContainer.InsertContainerProperty(ContainerProperty As ContainerProperty)
The InsertContainerPropertymethod syntax has these parts:
INSERTCONTAINERSTATE
Inserts a Container State record into the material database.
Syntax
MaterialSvr.InsertContainerState (ContainerState As ContainerState)
The InsertContainerState method syntax has these parts:
Part Description
Container Instance of the Container object to which the method is directed.
ContainerProperty An instance of a ContainerProperty object.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
ContainerState An instance of a ContainerState object.
-
7/24/2019 Mt Material Server API
51/70
2 Material Interface Definitions
45
INSERTERRORCORRECTION
Inserts a QA error correction record associated with a test specification in the material
database.
Syntax
MaterailSvr.InsertErrorCorrection(ErrorCorrectionAs ErrorCorrection)
The InsertErrorCorrectionmethod syntax has these parts:
Remarks
This interface will allow for the creation of QA error corrections in the material database.
INSERTERRORCORRECTIONRESULT
Inserts a QA error correction result record associated with a test result in the material
database.
Syntax
TestResult.InsertErrorCorrectionResult(ErrorCorrectionResultAsErrorCorrectionResult)
The InsertErrorCorrectionResultmethod syntax has these parts:
Remarks
This interface allows for the creation of an error correction result on a particular test result
that ended in a failure.
Part Description
MaterialSvr Instance of the MaterialSvr interface to which the method is
directed.
ErrorCorrection An instance of a ErrorCorrection object.
Part Description
TestResult Instance of the TestResult interface to which the method is directed.
ErrorCorrectionResult An instance of an ErrorCorrectionResult object.
-
7/24/2019 Mt Material Server API
52/70
Material Server API Technical Reference
46
INSERTL IMIT
Inserts a QA test specification limit record associated with a base test specification in the
material database.
Syntax
TestSpecification.InsertLimit(TestSpecificationLimitAs TestSpecificationLimit)
The InsertLimitmethod syntax has these parts:
Remarks
This new interface will allow for the insertion of QA test specification limits to be
associated with a test specification. The requirements state that a test specification can be
comprised of any number of material properties. Having limit sections allows for a one-to-
many relationship.
INSERTLOT
Inserts a Lot record into the material database.
Syntax
Material.InsertLot(Lot As Lot)
The InsertLotmethod syntax has these parts:
Part Description
TestSpecification Instance of the QATestSpec interface to which the method is
directed.
TestSpecificationLimit An instance of a TestSpecificationLimit object.
Part Description
Material Instance of a Material object to which the method is directed.
Lot An instance of a Lot object.
-
7/24/2019 Mt Material Server API
53/70
2 Material Interface Definitions
47
INSERTLOTSTATE
Inserts a Lot State record into the material database.
SyntaxMaterialSvr.InsertLotState(LotState As LotState)
TheInsertLotState method syntax has these parts:
INSERTMATERIAL
Inserts a Material record into the material database.
Syntax
MaterialSvr.InsertMaterial(MaterialAs Material)
The InsertMaterial method syntax has these parts:
INSERTMATERIALCLASS
Inserts a MaterialClass record into the material database.
Syntax
MaterialSvr.InsertMaterialClass(MaterialClass As MaterialClass)The InsertMaterialClassmethod syntax has these parts:
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
LotState An instance of a LotState object.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Material An instance of a Material object.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialClass An instance of a MaterialClass object.
-
7/24/2019 Mt Material Server API
54/70
Material Server API Technical Reference
48
INSERTMATERIALCLASSPROPERTY
Inserts a MaterialClassProperty record into the material database.
SyntaxMaterialClass.InsertMaterialClassProperty(MaterialClassProperty As
MaterialClassProperty)
The InsertMaterialClassPropertymethod syntax has these parts:
Remarks
This allows the adding of MaterialClassProperties. The process is actually adding a record
to the material database and associating the MaterialClassProperty to the MaterialClass
via a foreign key in the MaterialClassProperty table.
INSERTMATERIALPROPERTY
Inserts a MaterialProperty record into the material database.
Syntax
Material.InsertMaterialProperty(MaterialPropertyAs MaterialProperty)
The InsertMaterialPropertymethod syntax has these parts:
Remarks
When inserting a Material Property record, the Material Server will add an accompanying
Lot Property for every Lot that is derived from the specified Material.
Part Description
MaterialClass An instance of the MaterialClass object to which the method is
directed.
MaterialClassProperty An instance of a MaterialClassProperty object.
Part Description
Material Instance of the Material Interface to which the method is directed.
MaterialProperty An instance of a MaterialProperty object.
-
7/24/2019 Mt Material Server API
55/70
2 Material Interface Definitions
49
INSERTMATERIALTYPE
Inserts a Material Type record into the material database.
SyntaxMaterialSvr.InsertMaterialType(MaterialType As MaterialType)
The InsertMaterialType method syntax has these parts:
INSERTSTORAGELOCATION
Inserts a StorageLocation record into the material database.
Syntax
MaterialSvr.InsertStorageLocation(StorageLocation As StorageLocation)
The InsertStorageLocationmethod syntax has these parts:
INSERTSUBLOT
Inserts a SubLot record into the material database.
Syntax
Container.InsertSubLot(SubLotAs SubLot)The InsertSubLotmethod syntax has these parts:
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
MaterialType An instance of a MaterialType object.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
StorageLocation An instance of a StorageLocation object.
Part Description
Container Instance of the Container object to which the method is directed.
SubLot An instance of a SubLot object.
-
7/24/2019 Mt Material Server API
56/70
Material Server API Technical Reference
50
INSERTTESTSPECIFICATION
Inserts a QA test specification record into the material database.
SyntaxMaterial.InsertTestSpecification (TestSpecficationAs TestSpecification)
The InsertTestSpecification method syntax has these parts:
Remarks
This interface allows for the creation of QA test specification records in the material
database. The interface is part of the material object. This placement allows for multiple
test specifications to be created for any given material. It also allows for the inclusion of
multiple material properties to be part of a test specification.
ISLOTAUTHOR
Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the
Lot Author security role.
Syntax:
bResult =MaterialServerSecurity.IsLotAuthor()
The IsLotAuthor method syntax has these parts:
Part Description
Material Instance of the Material interface to which the method is directed.
TestSpecification An instance of a TestSpecification object.
Part Description
bResult Boolean value that returns TRUE or FALSE which represents if the
current user has access to interfaces defined for use for the
LotAuthor Role.
MaterialServerSecurity Instance of the MaterialServerSecurity Interface to which the
method is directed.
-
7/24/2019 Mt Material Server API
57/70
2 Material Interface Definitions
51
ISMATERIALAUTHOR
Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the
Material Author security role.
Syntax
bResult =MaterialServerSecurity.IsMaterialAuthor()
TheIsMaterialAuthor method syntax has these parts:
ISMATERIALSERVERAVAILABLE
Returns a Boolean value (TRUE or FALSE) indicating if there is communications to the
Material Server.
Syntax
bResult =MaterialServerUtils.IsMaterialServerAvailable()
The IsMaterialServerAvailablemethod syntax has these parts:
Part Description
bResult Boolean value that returns TRUE or FALSE which represents if the
current user has access to interfaces defined for use for the
MaterialAuthor Role.
MaterialServerSecurity Instance of the MaterialServerSecurity Interface to which themethod is directed.
Part Description
bResult Boolean value that returns TRUE or FALSE which represents if the
server successfully initialized all connection points.
MaterialServerUtils Instance of the MaterialServerUtils Interface to which the method is
directed.
-
7/24/2019 Mt Material Server API
58/70
Material Server API Technical Reference
52
ISMATERIALV IEWER
Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the
Material Viewer security role.
Syntax
bResult =MaterialServerSecurity.IsMaterialViewer()
The IsMaterialViewer method syntax has these parts:
MAPMATERIALCLASSPROPERTY
Maps a MaterialClassProperty record to the material definition in the material database.
Syntax
Material.MapMaterialClassProperty(MaterialClassPropertyAs MaterialClassProperty)
The MapMaterialClassPropertymethod syntax has these parts:
Remarks
This interface allows the mapping of MaterialClassProperties to the material definition.
Part Description
bResult Boolean value that returns TRUE or FALSE which represents if the
current user has access to interfaces defined for use for the
MaterialViewer Role.
MaterialServerSecurity Instance of the MaterialServerSecurity Interface to which themethod is directed.
Part Description
Material Instance of the Material interface to which the method is directed.
MaterialClassProperty An instance of a MaterialClassProperty object.
-
7/24/2019 Mt Material Server API
59/70
2 Material Interface Definitions
53
MATERIALCLASSPROPERTIES
Returns a collection of MaterialClassProperty objects that are derived from the material
class upon which they are based.
Syntax
MaterialClass.MaterialClassProperties
The MaterialClassPropertiesproperty syntax has these parts:
Remarks
The MaterialClass object contains a new property, called MaterialClassProperties, that
will present a collection of MaterialClassProperty objects derived from the MaterialClass.
This functionality is consistent with how the existing material object model presents
collections that are based on a parent object. For example, the material object has a
property called MaterialProperties that presents a collection of MaterialProperties that are
derived from the represented Material.
UPDATECONTAINER
Updates a Container record in the material database.
Syntax
MaterialSvr.UpdateContainer(Container As Container, [ActivityDescriptionAs String])
The UpdateContainermethod syntax has these parts:
Part Description
MaterialClass Instance of the MaterialClass interface to which the method is
directed.
Part Description
MaterialSvr Instance of the MaterialServer Interface to which the method is
directed.
Container An instance of a Container object.
ActivityDescription Adds descriptive text to the activity journal for this operation.
(Optional)
-
7/24/2019 Mt Material Server API