MT Material Server API

INTEGRATED PRODUCTION & PERFORMANCE SUITE
Production Management
Batch
MATERIAL SERVER API TECHNICAL REFERENCE
Contact Rockwell
Customer Support Telephone 1.440.646.3434

Online 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 are
trademarks 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 be
affected 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 your
responsibility to obtain the most current information available from Rockwell when installing or using
this product.
Modified: 4/16/2010 2:26:16 PM
Contents
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteContainerMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteContainerProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteContainerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteErrorCorrection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteLimit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteLotProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteLotState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMaterial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMaterialClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMaterialClassProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMaterialProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMaterialType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteStorageLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteSubLot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteTestResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteTestSpecification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DistributeSubLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerByControllerID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerByID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerOrStorageLocationMaterials . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerPriortyListByContainer . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerPriorityListByMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainersHavingMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerStateList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetContainerStates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
11
12
12
13
13
14
14
15
15
16
16
17
17
18
18
19
19
20
21
22
23
23
24
25
25
26
26
27
27
28
28
iii
Material Server API Technical Reference
I n t er f a c e D e f i n i t i o n s ( co n t i n u ed )
GetErrorCorrection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
GetErrorCorrections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
GetLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
GetLotList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
GetLots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
GetLotState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
GetLotStateList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
GetLotStates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
GetMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
GetMaterialByControllerID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
GetMaterialByID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
GetMaterialClass. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
GetMaterialClassByID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
GetMaterialClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
GetMaterialClassList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
GetMaterialList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
GetMaterials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
GetMaterialType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
GetMaterialTypeByID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
GetMaterialTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
GetMaterialTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
GetStorageLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
GetStorageLocationByID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
GetStorageLocationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
GetStorageLocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
InsertContainer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
InsertContainerMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
InsertContainerProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
InsertContainerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
InsertErrorCorrection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
InsertErrorCorrectionResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
InsertLimit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
InsertLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
InsertLotState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
InsertMaterial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
InsertMaterialClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
InsertMaterialClassProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
InsertMaterialProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
InsertMaterialType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
InsertStorageLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
InsertSubLot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
InsertTestSpecification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
IsLotAuthor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
IsMaterialAuthor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
IsMaterialServerAvailable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
IsMaterialViewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
MapMaterialClassProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
iv
Contents
I n t er f a c e D e f i n i t i o n s ( co n t i n u ed )
MaterialClassProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateContainerPriority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateContainerProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateContainerState. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateErrorCorrection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateErrorCorrectionResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateLotProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateLotState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateMaterialClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateMaterialClassProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateMaterialProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateMaterialType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateStorageLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateSubLot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateTestResult. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateTestSpecification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
53
53
54
54
55
55
56
56
57
57
58
58
59
59
60
60
61
61
62
62
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
vi
CHAPTER 1
Introducing Material Server API

This document was developed to provide quick and easy access to information regarding
the interface between the Material Server and the Material Editor and FactoryTalk
Batch. It is intended to be used as a reference guide by those who want to develop custom
interfaces.
Document Organization
The information in this document is presented in an order that should minimize the effort
required to locate information on the Material Server API (Application Programming
Interface).
The following subjects are presented in this document:
Material Server API Overview
Material Interface Definitions
Material Server API Overview

The Material Server API is the interface between the Material Server, the Material Editor,
and FactoryTalk Batch. Using the material object model (MOM) you can develop a
custom user interface application.
The material object model provides the interface to the Material Server:
MaterialSvr
MaterialClasses
Materials
MaterialProperties
SubLots
MaterialClassProperties
MaterialTypes
Lots
LotStates
SubLots
ContainerStates
QATestSpecs
QAErrorCorrections
QATestResults
Lots
Legend
LotProperties
SubLots
Object Only
Object and Collection
QATestResults
Containers
ContainerProperties
ContainerMaterials
SubLots
StorageLocations
Material Object Model Descriptions

The following section describes the objects that comprise the material object model.
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.
1 Introducing Material Server API
Object
Description
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 this
class. 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.
Three methods are assumed to be available for every collection class 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.
Available Interface Definitions

The following is a list of all supported interface definitions in the material object model:
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 Deletes a ContainerMaterial from the material database.

al on page 12
DeleteContainerProper Deletes a ContainerProperty from the material database.
ty on page 12
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

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.
Item
Description
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 Deletes a StorageLocation record from the material database.

on page 18
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

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 Returns a Container object with its properties populated with

page 23
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
GetContainers on
page 26
Returns a collection of 1 to N Container objects.
Item
Description
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

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.
GetErrorCorrections
on page 29
Gets a list of QA error corrections and presents it to the user as a

collection 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 on
page 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

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 Returns a MaterialClass object with its properties populated with

on page 36
MaterialClassID.
Item
Description
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

MaterialTypeID.
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 Returns a StorageLocation object with its properties populated with

ID on page 42
StorageLocationID.
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 Inserts a ContainerProperty record into the material database.

y on page 44
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
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

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 Inserts a MaterialClassProperty record into the material database.

perty on page 48
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 Inserts a QA test specification record into the material database.

on page 50
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

user has rights to the Material Author security role.
IsMaterialServerAvaila Returns a Boolean value (TRUE or FALSE) indicating if there is

ble on page 51
communications to the Material Server.
IsMaterialViewer on
page 52

user has rights to the Material Viewer security role.
MapMaterialClassProp Maps a MaterialClassProperty record to the material definition in the

erty on page 52
material database.
MaterialClassPropertie Returns a collection of MaterialClassProperty objects that are derived
s on page 53
from the material class upon which they are based.
UpdateContainer on
page 53
Updates a Container record in the material database.
Item
Description
UpdateContainerPriori
ty on page 54
Updates a ContainerPriority record in the material database.
UpdateContainerPrope Updates a ContainerProperty record in the material database.

rty on page 54
UpdateContainerState Updates a ContainerState record in the material database.
on page 55
UpdateErrorCorrection Updates a QA error correction record associated with a test
on page 55
UpdateErrorCorrection Updates a QA error correction result record associated with a test
Result on page 56
result in the material database.
UpdateLimit on
page 56
Updates a QA test specification limit record associated with a base test

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 Updates a MaterialProperty record in the material database.

y on page 60
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 on
page 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

UpdateTestSpecificati
on on page 62
Updates a QA test specification record in the material database.
10
CHAPTER 2
Material Interface Definitions

This 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(TestResult As TestResult, Lot As Lot)
The CreateTestResult 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.
Remarks
This interface allows for the creation of QA test results in the material database.
D E L E T E C ONTAI NER
Deletes a Container from the material database.
Syntax
MaterialSvr.DeleteContainer(Container As Container, [ActivityDescription As String])
The DeleteContainer method syntax has these parts:
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)
11
Remarks
Along with the deletion of the Container, all associated ContainerProperties,
ContainerPriorities, ContainerMaterials and Promises are deleted from the database when
this method is executed.
Containers cannot be deleted if they are in use by any SubLot in the material database.
The Virtual Container is a system-defined Container which cannot be deleted via this
method or any other means.
D E L E T E C ONTAI NER M ATERIAL

Deletes a ContainerMaterial from the material database.
Syntax
Container.DeleteContainerMaterial(ContainerMaterial As ContainerMaterial,
[ActivityDescription As String])
The DeleteContainerMaterial method syntax has these parts:
Part
Description
Container
Instance of the Container object to which the method is directed.
ContainerMaterial
An instance of a ContainerMaterial object.
ActivityDescription

(Optional)
D E L E T E C ONTAI NER P R O P E R T Y
Deletes a ContainerProperty from the material database.
Syntax
Container.DeleteContainerProperty(ContainerProperty As ContainerProperty,
The DeleteContainerProperty method syntax has these parts:
12
Part
Description
Container
ContainerProperty
An instance of a ContainerProperty object.
ActivityDescription

(Optional)
2 Material Interface Definitions
D E L E T E C ONTAI NER S T ATE

Deletes a ContainerState from the material database.
Syntax
MaterialSvr.DeleteContainerState(ContainerState As ContainerState)
The DeleteContainerState method syntax has these parts:
Part
Description
MaterialSvr

directed.
ContainerState
An instance of a ContainerState object.
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.
D E L E T E E R R O R C O RR E C T IO N
Deletes a QA error correction record associated with a test specification in the material
database.
Syntax
MaterialSvr.DeleteErrorCorrection(ErrorCorrection As ErrorCorrection)
The DeleteErrorCorrection method syntax has these parts:
Part
Description
MaterialSvr
Instance of the MaterialSvr interface to which the method is

directed.
ErrorCorrection
An instance of an ErrorCorrection object.
Remarks
This interface allows for the deletion of QA error corrections from the material database.
13
D E L E T E L I M IT
Deletes a QA test specification limit record associated with a base test specification in the
material database.
Syntax
TestSpecification.DeleteLimit(TestSpecificationLimit As TestSpecificationLimit)
The DeleteLimit method 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.
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, [ActivityDescription As String])
The DeleteLot method syntax has these parts:
Part
Description
Material
Instance of the Material object to which the method is directed.
Lot
An instance of a Lot object.
ActivityDescription

(Optional)
Remarks
Along with deleting the Lot, this interface will delete SubLots and LotProperties
associated with the specified Lot.
14
D E L E T E L O T P R O P E R TY
Deletes a LotProperty from the material database.
Syntax
Lot.DeleteLotProperty(LotProperty As LotProperty, [ActivityDescription As String])
The DeleteLotProperty method syntax has these parts:
Part
Description
Lot
Instance of a Lot object to which the method is directed.
LotProperty
An instance of a LotProperty object.
ActivityDescription

(Optional)
D E L E T E L O T S TA TE
Deletes a LotState from the material database.
Syntax
MaterialSvr.DeleteLotState(LotState As LotState)
The DeleteLotState method syntax has these parts:
Part
Description
MaterialSvr

directed.
LotState
An instance of a LotState object.
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.
15
D E L E T E M ATERIAL
Deletes a Material record from the material database.
Syntax
MaterialSvr.DeleteMaterial(Material As Material, [ActivityDescription As String])
The DeleteMaterial method syntax has these parts:
Part
Description
MaterialSvr

directed.
Material
An instance of a Material object.
ActivityDescription

(Optional)
Remarks
Along with the deletion of the Material, all associated MaterialProperties, LotProperties,
Lots, and SubLots are deleted from the database.
D E L E T E M ATERIAL C LA SS
Deletes a MaterialClass record from the material database.
Syntax
MaterialSvr.DeleteMaterialClass(MaterialClass As MaterialClass)
The DeleteMaterialClass method syntax has these parts:
Part
Description
MaterialSvr

directed.
MaterialClass
An instance of a MaterialClass object.
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.
16
D E L E T E M ATERIAL C LA SS P R O P E R T Y
Deletes a MaterialClassProperty record from the material database.
Syntax
MaterialClass.DeleteMaterialClassProperty(MaterialClassProperty As
MaterialClassProperty), [ActivityDescription As String])
The DeleteMaterialClassProperty method syntax has these parts:
Part
Description
MaterialClass
Instance of the MaterialClass object to which the method is

directed.
MaterialClassProperty
An instance of a MaterialClassProperty object.
ActivityDescription

(Optional)
Remarks
Executing this interface will delete the MaterialClassProperty from the material database
and remove all mapped material definition properties.
D E L E T E M ATERIAL P R O P E R TY
Deletes a MaterialProperty record from the material database.
Syntax
Material.DeleteMaterialProperty(MaterialProperty As MaterialProperty,
The DeleteMaterialProperty method syntax has these parts:
Part
Description
Material
MaterialProperty
An instance of a MaterialProperty object.
ActivityDescription

(Optional)
Remarks
Along with the MaterialProperty, all LotProperties associated with the specified
MaterialProperty are deleted.
17
D E L E T E M ATERIAL T YPE
Deletes a MaterialType record from the material database.
Syntax
MaterialSvr.DeleteMaterialType(MaterialType As MaterialType)
The DeleteMaterialType method syntax has these parts:
Part
Description
MaterialSvr

directed.
MaterialType
An instance of a MaterialType object.
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.
D E L E T E S TORAGE L OCATI ON
Deletes a StorageLocation record from the material database.
Syntax
MaterialSvr.DeleteStorageLocation(StorageLocation As StorageLocation,
The DeleteStorageLocation method syntax has these parts:
Part
Description
MaterialSvr

directed.
StorageLocation
An instance of a StorageLocation object.
ActivityDescription

(Optional)
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.
18
D E L E T E S UB L OT
Deletes a SubLot record from the material database.
Syntax
MaterialSvr.DeleteSubLot(SubLot As SubLot, [ActivityDescription As String])
Lot.DeleteSubLot(SubLot As SubLot, [ActivityDescription As String])
The DeleteSubLot method syntax has these parts:
Part
Description
MaterialSvr

directed.
Lot
Instance of a Lot object to which the SubLots are to be deleted from.
SubLot
An instance of a SubLot object.
ActivityDescription

(Optional)
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.
D E L E T E T E S T R ESULT
Deletes a QA test result record associated with a test specification in the material database.
Syntax
TestSpecification.DeleteTestResult(TestResult As TestResult)
The DeleteTestResult method syntax has these parts:
Part
Description
TestSpecification

directed.
TestResult
Remarks
This interface allows for the deletion of QA test results from the material database.
19
D E L E T E T E S T S P ECI FI CA T ION
Deletes a QA test specification record from the material database.
Syntax
Material.DeleteTestSpecification(TestSpecification As TestSpecification, ForceDelete as
Boolean)
The DeleteTestSpecification method syntax has these parts:
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.
FALSE deletes 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.
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.
The ForceDelete argument 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 test
specification has associated test results, the test specification cannot be deleted.
20
D I S TR I B UT E S U B L O T
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 Container As Long, [ByVal
Label As String, [ActivityDescription As String])
The DistributeSubLot method 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

(Optional)
21
G ET C O NT AI N ER
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 GetContainer method syntax has these parts:
Part
Description
object
Reference to a valid Container object.
MaterialSvr

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.
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.
22
G ET C O NT AI N E R B Y C ONTRO LLER I D
Returns a Container object populated with the specified Container data from the material
database, based on the ControllerID.
Syntax
object = MaterialSvr.GetContainerByControllerID (ByVal ControllerID As Long)
The GetContainerByControllerID method syntax has these parts:
Part
Description
object
MaterialSvr

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.
G ET C O NT AI N E R B Y I D
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 GetContainerByID method syntax has these parts:
Part
Description
object
MaterialSvr

directed.
ContainerID
ID of the Container being requested.
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.
23
G ET C O NT AI N ER L IST
Returns a list of Containers in a multi-dimensioned array.
Syntax
vResult = MaterialSvr.GetContainerList(ByVal ContainerFilter As ContainerFilterEnum
, ByVal FilterValue As String)
The GetContainerList 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.
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.
Where vResult is:

Part
Description
vResult
Is a two dimensional array containing

<Empty Array> | <ContainerData>
ContainerData
Array Element [0] = ControllerID

Array Element [1] = ConatinerName
24
G ET C O NT AI N E R O R S TO R AGE L OCATIO N M A T E RI ALS

Returns a collection of ContainerMaterial objects that are configured for use with a
specified Container or StorageLocation.
Syntax
MaterialSvr.GetContainerOrStorageLocationMaterials(ContainerOrStorageLocation
Name As String) As ContainerMaterials
The GetContainerOrStorageLocationMaterials method syntax has these parts:
Part
Description
MaterialSvr

directed.
ContainerOrStorageLocatio The instance of a Container or StorageLocation.

nName
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.
G ET C O NT AI N E R P RI OR T Y L I ST B Y C ONTAINER
Syntax
Set object = MaterialSvr.GetContainerPriorityListByContainer(ContainerName As
String)
The GetContainerPriorityListByContainer method syntax has these parts:
Part
Description
object
Reference to a valid ContainerPriorities collection object.
MaterialSvr

directed.
ContainerName
String representing the name of the Container you want to produce

the list from.
25
G ET C O NT AI N ER P RI OR IT Y L IST B Y M ATERIAL
Syntax
Set object = MaterialSvr.GetContainerPriorityListByMaterial(MaterialName As
String)
The GetContainerPriorityListByMaterial method syntax has these parts:
Part
Description
object
Reference to a valid ContainerPriorities collection object.
MaterialSvr

directed.
MaterialName
String representing the name of the Material you want to produce

the list from.
G ET C O NT AI N ER S
Returns a collection of 1 to N Container objects.
Syntax
Set object = MaterialSvr.GetContainers()
The GetContainers method syntax has these parts:
26
Part
Description
object
Reference to a valid Containers collection object.
MaterialSvr

directed.
G ET C O NT AI N E RS H AVING M ATERIAL
Returns a collection of 1 to N MaterialContainer objects.
Syntax
Set object = MaterialSvr.GetContainersHavingMaterial(IMaterialID As Long)
The GetContainersHavingMaterial method syntax has these parts:
Part
Description
object
Reference to a valid MaterialContainers collection object.
MaterialSvr

directed.
MaterialID
Represents the ID of the Material.
G ET C O NT AI N E R S TA T E
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(ByVal sName As String, UseCollection As
Boolean)
The GetContainerState method syntax has these parts:
Part
Description
object
Reference to a valid ContainerState object.
MaterialSvr

directed.
sName
Represents the name of the ContainerState.
UseCollection
True: Attempts to locate the specified ContainerState in a prepopulated 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.
27
G ET C O NT AI N ER S TA TE L IST
Returns a list of ContainerStates in a multi-dimensioned array.
Syntax
vResult = MaterialSvr.GetContainerStateList()
The GetContainerStateList method syntax has these parts:
Part
Description
vResult
MaterialSvr

is directed.
Where vResult is:

Part
Description
vResult

<Empty Array> | <ContainerStateData>
ContainerStateData
Array Element [0] = PKid

Array Element [1] = Name
Array Element [2] = Description
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.
G ET C O NT AI N ER S TATES
Returns a collection of 1 to N ContainerState objects.
Syntax
Set object = MaterialSvr.GetContainerStates()
The GetContainerStates method syntax has these parts:
28
Part
Description
object
Reference to a valid ContainerStates collection object.
MaterialSvr

directed.
G ET E RR OR C ORRECTI ON
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, UseCollection AS Boolean) As
ErrorCorrection
The GetErrorCorrection method syntax has these parts:
Part
Description
MaterialSvr

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.
Remarks
This interface provides you with the ability to get an instance of a particular error
correction object by providing the error correction name.
G ET E RR OR C ORRECTI ONS
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:
Part
Description
MaterialSvr

directed.
Remarks
This interface provides you with a list of QA error corrections.
29
G ET L O T
Returns a Lot object populated with the specified Lot data from the material database,
based on the Lot Name.
Syntax
Set object = MaterialSvr.GetLot(ByVal sName As String, UseCollection As Boolean)
The GetLot method syntax has these parts:
Part
Description
object
Reference to a valid Lot object.
MaterialSvr

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 through
this collection to find the desired Lot.
30
G ET L O T L I ST
Returns a list of Lots in a multi-dimensioned array.
Syntax
vResult = MaterialSvr.GetLotList(ByVal LotFilter As LotFilterEnum, ByVal FilterValue
As String)
The GetLotList method syntax has these parts:
Part
Description
vResult
MaterialSvr

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.
Where vResult is:

Part
Description
vResult

<Empty Array> | <LotData>
LotData
Array Element [0] = PKid

Array Element [1] = Lot Name
Remarks
In order to test for an empty array, you must test the upper and lower bounds of the
vContainerList array. If both bounds are zero, then the array is empty and can be treated as
such.
31
G ET L O T S
Returns a collection of 1 to N Lot objects.
Syntax
Set object = MaterialSvr.GetLots()
The GetLot method syntax has these parts:
Part
Description
object
Reference to a valid Lots collection object.
MaterialSvr

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.
G ET L O T S TA TE
Returns a LotState object populated with the specified LotState data from the material
database, based on the LotStates name.
Syntax
Set object = MaterialSvr.GetLotState(ByVal sName As String, UseCollection As
Boolean)
The GetLotState method syntax has these parts:
Part
Description
object
Reference to a valid LotState object.
MaterialSvr

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.
32
G ET L O T S TA TE L I S T
Returns a list of LotStates in a multi-dimensioned array.
Syntax
vResult = MaterialSvr.GetLotStateList()
The GetLotStateList method syntax has these parts:
Part
Description
vResult
MaterialSvr

directed.
Where vResult is:

Part
Description
vResult

<EmptyArray> | <LotStateData>
LotStateData
Array Element [0] = PKID

Remarks
G ET L O T S TATES
Returns a collection of 1 to N LotState objects.
Syntax
Set object = MaterialSvr.GetLotStates()
The GetLotStates method syntax has these parts:
Part
Description
object
Reference to a valid LotStates collection object.
MaterialSvr

directed.
33
G ET M ATERIAL
Returns a Material object populated with the specified Material data from the material
database, based on the Material Name.
Syntax
Set object = MaterialSvr.GetMaterial(ByVal sName As String, UseCollection As
Boolean)
The GetMaterial method syntax has these parts:
Part
Description
object
Reference to a valid Material object.
MaterialSvr

directed.
sName
Represents the name of the Material.
UseCollection
True: Attempts to locate the specified Material 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.
G ET M ATERIAL B Y C ONTROL LER ID

Returns a Material object populated with the specified Material data from the material
database, based on the ControllerID.
Syntax
object = MaterialSvr.GetMaterialByControllerID (ByVal IControllerID As Long)
The GetMaterialByControllerID method syntax has these parts:
34
Part
Description
object
MaterialSvr

directed.
IControllerID
ControllerID of the Material being requested. It is expected that the

program using this interface know the ControllerID for the data
entity it wants to access.
G ET M ATERIAL B Y ID
Returns a Material object with its properties populated with corresponding data from the
material database, based on the MaterialID.
Syntax
Set object = MaterialSvr.GetMaterialByID(ByVal IMaterialID As Long)
The GetMaterialByID method syntax has these parts:
Part
Description
object
MaterialSvr

directed.
IMaterialID
Represents the ID of the Material.
G ET M ATERIAL C LA SS
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(ByVal MaterialClassName As String,
UseCollection As Boolean)
The GetMaterialClass method syntax has these parts:
Part
Description
object
Reference to a valid MaterialClass object.
MaterialSvr

directed.
MaterialClassName
Represents the name of the MaterialClass.
UseCollection
True: Attempts to locate the specified MaterialClass in a prepopulated collection. If no collection is present, one is created and
False: reads the record directly from the database.
35
G ET M ATERIAL C LA SS B Y I D
Returns a MaterialClass object with its properties populated with corresponding data from
the material database, based on the MaterialClassID.
Syntax
Set object = MaterialSvr.GetMaterialClassByID(ByVal MaterialClassID As Long)
The GetMaterialClassByID method syntax has these parts:
Part
Description
object
Reference to a valid MaterialClass object.
MaterialSvr

directed.
MaterialClassID
Represents the ID of the MaterialClass.
G ET M ATERIAL C LA SSES
Returns a collection of 1 to N MaterialClass objects.
Syntax
Set object = MaterialSvr.GetMaterialClasses()
The GetMaterialClasses method syntax has these parts:
36
Part
Description
object
Reference to a valid MaterialClasses collection object.
MaterialSvr

directed.
G ET M ATERIAL C LA SS L IST
Returns a list of Materials in a multi-dimensioned array.
Syntax
vResult = MaterialSvr.GetMaterialClassList()
The GetMaterialClassList method syntax has these parts:
Part
Description
vResult
MaterialSvr
Instance of the MaterialServer to which the method is directed.
Where vResult is:

Part
Description
vResult

<EmptyArray> | <MaterialClassData>
MaterialClass
Array Element [0] = PKID
Data
Array Element [1] = MaterialClass Name

Remarks
37
G ET M ATERIAL L I ST
Returns a list of Materials in a multi-dimensioned array.
Syntax
vResult = MaterialSvr.GetMaterialList(MaterialFilter As MaterialFilterEnum,
FilterValue As String)
The GetMaterialList method syntax has these parts:
Part
Description
vResult
MaterialSvr
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.
Where vResult is:

Part
Description
vResult

<EmptyArray> | <MaterialData>
MaterialData
Array Element [0] = Pkid

Remarks
38
G ET M ATERIAL S
Returns a collection of 1 to N Material objects.
Syntax
Set object = MaterialSvr.GetMaterials()
The GetMaterials method syntax has these parts:
Part
Description
object
Reference to a valid Materials collection object.
MaterialSvr

directed.
G ET M ATERIAL T YPE
Returns a Type object populated with the specified MaterialType data from the material
database based on the MaterialType Name.
Syntax
Set object = MaterialSvr.GetMaterialType(ByVal MaterialTypeName As String,
UseCollection As Boolean)
The GetMaterialType method syntax has these parts:
Part
Description
object
Reference to a valid Classification object.
MaterialSvr

directed.
MaterialTypeName
Represents the name of the Material Type.
UseCollection
True: Attempts to locate the specified MaterialType in a prepopulated collection. If no collection is present, one is created and
39
G ET M ATERIAL T YPE B Y ID
Returns a MaterialType object with its properties populated with corresponding data from
the material database, based on the MaterialTypeID.
Syntax
Set object = MaterialSvr.GetMaterialTypeByID(ByVal MaterialTypeID As Long)
The GetMaterialTypeByID method syntax has these parts:
Part
Description
object
Reference to a valid MaterialType object.
MaterialSvr

directed.
MaterialTypeID
Represents the ID of the MaterialType.
G ET M ATERIAL T YPE L I S T
Returns a list of MaterialTypes in a multi-dimensioned array.
Syntax
vResult = MaterialSvr.GetMaterialTypeList()
The GetMaterialTypeList method syntax has these parts:
Part
Description
vResult
MaterialSvr
Where vResult is:

Part
Description
vResult

<EmptyArray> | <MaterialTypeData>
Material Classification Data Array Element [0] = Pkid

Remarks
40
G ET M ATERIAL T YPES
Returns a collection of 1 to N MaterialType objects.
Syntax:
Set object = MaterialSvr.GetMaterialTypes()
The GetMaterialTypes method syntax has these parts:
Part
Description
object
Reference to a valid MaterialTypes collection object.
MaterialSvr

directed.
G ET S T O R A G E L O CA TI ON
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(ByVal sName As String, UseCollection As
Boolean)
The GetStorageLocation method syntax has these parts:
Part
Description
object
Reference to a valid StorageLocation object.
MaterialSvr

directed.
sName
Represents the ID of the StorageLocation record from the material

database.
UseCollection
True: Attempts to locate the specified StorageLocation in a prepopulated collection. If no collection is present, one is created and
41
G ET S T O R A G E L OCA TI ON B Y ID
Returns a StorageLocation object with its properties populated with corresponding data
from the material database, based on the StorageLocationID.
Syntax
Set object = MaterialSvr.GetStorageLocationByID(ByVal IStorageLocationID As Long)
The GetStorageLocationByID method syntax has these parts:
Part
Description
object
Reference to a valid StorageLocation object.
MaterialSvr

directed.
IStorageLocationID
Represents the ID of the StorageLocation.
G ET S T O R A G E L OCA TI ON L IST
Returns a list of StorageLocations in a multi-dimensioned array.
Syntax
vResult = MaterialSvr.GetStorageLocationList()
The GetStorageLocationList method syntax has these parts:
Part
Description
vResult
MaterialSvr

directed.
Where vResult is:

Part
Description
vResult

<EmptyArray> | <StorageLocationData>
StorageLocationData
Array Element [0] =PKid

42
G ET S T O R A G E L O CA TI ON S
Returns a collection of 1 to N StorageLocation objects.
Syntax
Set object = MaterialSvr.GetStorageLocations()
The GetStorageLocations method syntax has these parts:
Part
Description
object
Reference to a valid StorageLocations collection object.
MaterialSvr

directed.
I N S E R T C ONTAINER
Inserts a Container record into the material database.
Syntax
MaterialSvr.InsertContainer(Container As Container)
The InsertContainer method syntax has these parts:
Part
Description
MaterialSvr

directed.
Container
I N S E R T C ONTAINER M ATERIAL
Inserts a ContainerMaterial record into the material database.
Syntax
Container.InsertContainerMaterial(ContainerMaterial As ContainerMaterial)
The InsertContainerMaterial method syntax has these parts:
Part
Description
Container
ContainerMaterial
An instance of a ContainerMaterial object.
43
I N S E R T C ONTAINER P R O P E R T Y
Inserts a ContainerProperty record into the material database.
Syntax
Container.InsertContainerProperty(ContainerProperty As ContainerProperty)
The InsertContainerProperty method syntax has these parts:
Part
Description
Container
ContainerProperty
I N S E R T C ONTAINER S TA TE
Inserts a Container State record into the material database.
Syntax
MaterialSvr.InsertContainerState(ContainerState As ContainerState)
The InsertContainerState method syntax has these parts:
44
Part
Description
MaterialSvr

directed.
ContainerState
I N S E R T E R R O R C ORRECTION
Inserts a QA error correction record associated with a test specification in the material
database.
Syntax
MaterailSvr.InsertErrorCorrection(ErrorCorrection As ErrorCorrection)
The InsertErrorCorrection method syntax has these parts:
Part
Description
MaterialSvr

directed.
ErrorCorrection
An instance of a ErrorCorrection object.
Remarks
This interface will allow for the creation of QA error corrections in the material database.
I N S E R T E R R O R C ORRECTION R E S U L T
Inserts a QA error correction result record associated with a test result in the material
database.
Syntax
TestResult.InsertErrorCorrectionResult(ErrorCorrectionResult As
ErrorCorrectionResult)
The InsertErrorCorrectionResult method syntax has these parts:
Part
Description
TestResult
Instance of the TestResult interface to which the method is directed.
ErrorCorrectionResult
An instance of an ErrorCorrectionResult object.
Remarks
This interface allows for the creation of an error correction result on a particular test result
that ended in a failure.
45
I N S E R T L IM IT
Inserts a QA test specification limit record associated with a base test specification in the
material database.
Syntax
TestSpecification.InsertLimit(TestSpecificationLimit As TestSpecificationLimit)
The InsertLimit method syntax has these parts:
Part
Description
TestSpecification

directed.
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-tomany relationship.
I N S E R T L OT
Inserts a Lot record into the material database.
Syntax
Material.InsertLot(Lot As Lot)
The InsertLot method syntax has these parts:
46
Part
Description
Material
Instance of a Material object to which the method is directed.
Lot
I N S E R T L OT S TA TE
Inserts a Lot State record into the material database.
Syntax
MaterialSvr.InsertLotState(LotState As LotState)
The InsertLotState method syntax has these parts:
Part
Description
MaterialSvr

directed.
LotState
I N S E R T M A TE R I AL
Inserts a Material record into the material database.
Syntax
MaterialSvr.InsertMaterial(Material As Material)
The InsertMaterial method syntax has these parts:
Part
Description
MaterialSvr

directed.
Material
I N S E R T M A TE R I AL C LASS
Inserts a MaterialClass record into the material database.
Syntax
MaterialSvr.InsertMaterialClass(MaterialClass As MaterialClass)
The InsertMaterialClass method syntax has these parts:
Part
Description
MaterialSvr

directed.
MaterialClass
An instance of a MaterialClass object.
47
I N S E R T M A TE R I AL C LASS P R O P E R T Y
Inserts a MaterialClassProperty record into the material database.
Syntax
MaterialClass.InsertMaterialClassProperty(MaterialClassProperty As
MaterialClassProperty)
The InsertMaterialClassProperty method syntax has these parts:
Part
Description
MaterialClass
An instance of the MaterialClass object to which the method is

directed.
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.
I N S E R T M A TE R I AL P RO P ERT Y
Inserts a MaterialProperty record into the material database.
Syntax
Material.InsertMaterialProperty(MaterialProperty As MaterialProperty)
The InsertMaterialProperty method syntax has these parts:
Part
Description
Material
Instance of the Material Interface to which the method is directed.
MaterialProperty
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.
48
I N S E R T M A TE R I AL T YPE
Inserts a Material Type record into the material database.
Syntax
MaterialSvr.InsertMaterialType(MaterialType As MaterialType)
The InsertMaterialType method syntax has these parts:
Part
Description
MaterialSvr

directed.
MaterialType
I N S E R T S TO R AGE L OCATIO N
Inserts a StorageLocation record into the material database.
Syntax
MaterialSvr.InsertStorageLocation(StorageLocation As StorageLocation)
The InsertStorageLocation method syntax has these parts:
Part
Description
MaterialSvr

directed.
StorageLocation
I N S E R T S UB L OT
Inserts a SubLot record into the material database.
Syntax
Container.InsertSubLot(SubLot As SubLot)
The InsertSubLot method syntax has these parts:
Part
Description
Container
SubLot
49
I N S E R T T EST S PECIFICATION
Inserts a QA test specification record into the material database.
Syntax
Material.InsertTestSpecification(TestSpecfication As TestSpecification)
The InsertTestSpecification method syntax has these parts:
Part
Description
Material
TestSpecification
An instance of a TestSpecification object.
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.
I S L OT A UTHO R
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:
50
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.
I S M ATERIA L A UTHO R
Material Author security role.
Syntax
bResult = MaterialServerSecurity.IsMaterialAuthor()
The IsMaterialAuthor method syntax has these parts:
Part
Description
bResult

MaterialAuthor Role.

method is directed.
I S M ATERIA L S ERVER A VAI LAB LE

Returns a Boolean value (TRUE or FALSE) indicating if there is communications to the
Material Server.
Syntax
bResult = MaterialServerUtils.IsMaterialServerAvailable()
The IsMaterialServerAvailable method syntax has these parts:
Part
Description
bResult

server successfully initialized all connection points.
MaterialServerUtils
Instance of the MaterialServerUtils Interface to which the method is

directed.
51
I S M ATERIA L V I E WER
Material Viewer security role.
Syntax
bResult = MaterialServerSecurity.IsMaterialViewer()
The IsMaterialViewer method syntax has these parts:
Part
Description
bResult

MaterialViewer Role.

method is directed.
M AP M ATERIAL C L ASS P R O PER T Y

Maps a MaterialClassProperty record to the material definition in the material database.
Syntax
Material.MapMaterialClassProperty(MaterialClassProperty As MaterialClassProperty)
The MapMaterialClassProperty method syntax has these parts:
Part
Description
Material
Remarks
This interface allows the mapping of MaterialClassProperties to the material definition.
52
M ATERIAL C LA SS P R O PER T I E S
Returns a collection of MaterialClassProperty objects that are derived from the material
class upon which they are based.
Syntax
MaterialClass.MaterialClassProperties
The MaterialClassProperties property syntax has these parts:
Part
Description
MaterialClass
Instance of the MaterialClass interface to which the method is

directed.
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.
U P D A T E C ONTA INER
Updates a Container record in the material database.
Syntax
MaterialSvr.UpdateContainer(Container As Container, [ActivityDescription As String])
The UpdateContainer method syntax has these parts:
Part
Description
MaterialSvr

directed.
Container
ActivityDescription

(Optional)
53
U P D A T E C ONTA INER P R I O R I TY
Updates a ContainerPriority record in the material database.
Syntax
MaterialSvr.UpdateContainerPriority(ContainerPriority As ContainerPriority)
The UpdateContainerPriority method syntax has these parts:
Part
Description
MaterialSvr

directed.
ContainerPriority
An instance of a ContainerPriority object.
Remarks
The only property that can be updated in the ContainerPriority object is the Priority.
U P D A T E C ONTA INER P R O P E R TY
Updates a ContainerProperty record in the material database.
Syntax
Container.UpdateContainerProperty(ContainerProperty As ContainerProperty,
The UpdateContainerProperty method syntax has these parts:
54
Part
Description
Container
ContainerProperty
ActivityDescription

(Optional)
U P D A T E C ONTA INER S TA TE
Updates a ContainerState record in the material database.
Syntax
MaterialSvr.UpdateContainerState(ContainerState As ContainerState)
The UpdateContainerState method syntax has these parts:
Part
Description
MaterialSvr

directed.
ContainerState
Remarks:
The Ready To Use ContainerState is a system-defined state and cannot be deleted
through this interface or by any other means.
U P D A T E E R RO R C O R R E C TI O N
Updates a QA error correction record associated with a test specification in the material
database.
Syntax
MaterialSvr.UpdateErrorCorrection(ErrorCorrection As ErrorCorrection)
The UpdateErrorCorrection method syntax has these parts:
Part
Description
MaterialSvr

directed.
ErrorCorrection
An instance of a ErrorCorrection object.
Remarks
This interface will allow for the modification of QA error correction records in the
material database.
55
U P D A T E E R RO R C O R R E C TI O N R E S U L T
Updates a QA error correction result record associated with a test result in the material
database.
Syntax
TestResult.UpdateErrorCorrectionResult(ErrorCorrectionResult As
ErrorCorrectionResult)
The UpdateErrorCorrectionResult method syntax has these parts:
Part
Description
TestResult
Instance of the TestResult interface to which the method is directed.
ErrorCorrectionResult
An instance of an ErrorCorrectionResult object.
Remarks
This interface allows for the updating of an error correction result on a particular test result
that ended in a failure.
U P D A T E L IMI T
Updates a QA test specification limit record associated with a base test specification in the
material database.
Syntax
TestSpecification.UpdateLimit(TestSpecjficationLimit As TestSpecificationLimit)
The UpdateLimit method syntax has these parts:
Part
Description
TestSpecification

directed.
Remarks
This interface will allow for the modification of a QA test specification detail record after
it has been added to the material database.
56
U P D A T E L OT
Updates a Lot record in the material database.
Syntax
Material.UpdateLot(Lot As Lot, [ActivityDescription As String])
The UpdateLot method syntax has these parts:
Part
Description
Material
Lot
ActivityDescription

(Optional)
U P D A T E L OT P R O PER T Y
Updates a LotProperty record in the material database.
Syntax
Lot.UpdateLotProperty(LotProperty As LotProperty, [ActivityDescription As String])
The UpdateLotProperty method syntax has these parts:
Part
Description
Lot
Instance of the Lot object to which the method is directed.
LotProperty
An instance of a LotProperty object.
ActivityDescription

(Optional)
57
U P D A T E L OT S TA TE
Updates a LotState record in the material database.
Syntax
MaterialSvr.UpdateLotState(LotState As LotState)
The UpdateLotState method syntax has these parts:
Part
Description
MaterialSvr

directed.
LotState
Remarks
The Ready To Use LotState is a system-defined state and can not be updated via this
method or any other means.
U P D A T E M ATERIA L
Updates a Material record in the material database.
Syntax
MaterialSvr.UpdateMaterial(Material As Material, [ActivityDescription As String])
The UpdateMaterial method syntax has these parts:
58
Part
Description
MaterialSvr

directed.
Material
ActivityDescription

(Optional)
U P D A T E M ATERIA L C L AS S
Updates a Class record in the material database.
Syntax
MaterialSvr.UpdateMaterialClass(MaterialClass As MaterialClass)
The UpdateMaterialClass method syntax has these parts:
Part
Description
MaterialSvr

directed.
MaterialClass
An instance of a MaterialClassGroup object.
U P D A T E M ATERIA L C L AS S P ROPERT Y
Updates a MaterialClassProperty record in the material database.
Syntax
MaterialClass.UpdateMaterialClassProperty(MaterialClassProperty As
MaterialClassProperty), PropagateChanges As Boolean, [ActivityDescription As String])
The UpdateMaterialClassProperty method syntax has these parts:
Part
Description
MaterialClass
Instance of the MaterialClass public interface to which the method

is directed.
ActivityDescription

(Optional)
59
U P D A T E M ATERIA L P R O P E R T Y
Updates a MaterialProperty record in the material database.
Syntax
Material.UpdateMaterialProperty(MaterialProperty As MaterialProperty,
The UpdateMaterialProperty method syntax has these parts:
Part
Description
Material
MaterialProperty
ActivityDescription

(Optional)
U P D A T E M ATERIA L T YPE
Updates a MaterialType record in the material database.
Syntax
MaterialSvr.UpdateMaterialType(MaterialType As MaterialType)
The UpdateMaterialType method syntax has these parts:
Part
Description
MaterialSvr

directed.
MaterialType
Remarks
The Ungrouped MaterialType is a system-defined state which cannot be deleted through
this interface or by any other means.
60
U P D A T E S TORA GE L O C AT IO N
Updates a StorageLocation record in the material database.
Syntax
MaterialSvr.UpdateStorageLocation(StorageLocation As StorageLocation)
The UpdateStorageLocation method syntax has these parts:
Part
Description
MaterialSvr

directed.
StorageLocation
UPDATESUBLOT
Updates a SubLot record in the material database.
Syntax
Lot.UpdateSubLot(SubLot As SubLot, [ActivityDescription As String])
The UpdateSubLot method syntax has these parts:
Part
Description
Lot
Instance of the Lot object to which the method is directed.
SubLot
ActivityDescription

(Optional)
61
U P D A T E T EST R E S U L T
Updates a QA test result record associated with a test specification in the material
database.
Syntax
TestSpecification.UpdateTestResult(TestResult As TestResult)
The UpdateTestResult method syntax has these parts:
Part
Description
TestSpecification
Instance of the TestSpecification interface to which the method is

directed.
TestResult
Remarks
This interface allows for the modification of QA test result records in the material
database.
U P D A T E T EST S PECIFICATION
Updates a QA test specification record in the material database.
Syntax
Material.UpdateTestSpecification(TestSpecification As TestSpecification)
The UpdateTestSpecification method syntax has these parts:
Part
Description
Material
TestSpecification
An instance of a TestSpecification object.
Remarks
This interface will allow for the modification of a QA test specification after it is added to
62
Index
GetLotList 31
GetLots 32
available interface definitions 4
GetLotState 32
GetLotStateList 33
CreateTestResult 11
GetLotStates 33
GetMaterial 34
DeleteContainer 11, 12
GetMaterialByControllerID 34
DeleteContainerProperty 12
GetMaterialByID 34, 35
DeleteErrorCorrection 13
GetMaterialClass 35
DeleteLimit 14
GetMaterialClassByID 36
DeleteLot 14
GetMaterialClasses 36
DeleteLotProperty 15
GetMaterialClassList 37
DeleteLotState 15
GetMaterialList 38
DeleteMaterial 16
GetMaterials 39
DeleteMaterialClass 16
GetMaterialType 39
DeleteMaterialClassProperty 17
GetMaterialTypeByID 40
DeleteMaterialType 18
GetMaterialTypeList 40
DeleteSubLot 19
GetMaterialTypes 41
DeleteTestResult 19
GetStorageLocation 41
DeleteTestSpecification 20
GetStorageLocationByID 42
DistributeSubLot 21
GetStorageLocationList 42
GetStorageLocations 43
G
GetContainer 22
GetContainerByID 23
I
InsertContainer 43
GetContainerList 24
InsertContainerMaterial 43
GetContainerOrStorageLocationMaterials 25
InsertContainerProperty 44
GetContainerPriorityListByMaterial 26
InsertContainerState 44
GetContainerPropertyListByContainer 25
InsertErrorCorrection 45
GetContainers 23
InsertErrorCorrectionResult 45
GetContainersHavingMaterial 26
InsertLimit 46
GetContainerState 27
InsertLot 46
GetContainerStateList 28
InsertLotState 47
GetContainerStates 28
InsertMaterial 47
GetErrorCorrection 29
InsertMaterialClass 47
GetErrorCorrections 29
InsertMaterialClassProperty 48
GetLot 30
InsertMaterialProperty 48
63
InsertMaterialType 49
Material 3
InsertStorageLocation 49
MaterialClass 3
InsertSubLot 49
MaterialClass group 3
InsertTestSpecification 50
MaterialProperty 3
IsLotAuthor 50
MaterialSVR 3
IsMaterialAuthor 51
MaterialType 3
IsMaterialServerAvailable 51
StorageLocation 3
IsMaterialViewer 52
SubLot 3
U
MapMaterialClassProperty 52
UpdateContainer 53
Material Object Model
UpdateContainerPriority 54
diagram 2
UpdateContainerProperty 54
objects 2
UpdateContainerState 55
MaterialClassProperties 53
UpdateErrorCorrection 55
Methods
UpdateErrorCorrectionResult 56
Count 4
UpdateLimit 56
Item 4
UpdateLot 57
NewEnum 4
UpdateLotProperty 57
UpdateLotState 58
O
Objects
Container 2
ContainerMaterial 2
ContainerProperty 2
ContainerState 2
Lot 3
LotProperty 3
LotState 3
64
UpdateMaterial 58
UpdateMaterialClass 59
UpdateMaterialClassProperty 59
UpdateMaterialProperty 60
UpdateMaterialType 60
UpdateStorageLocation 61
UpdateSubLot 61
UpdateTestResult 62
UpdateTestSpecification 62

MT Material Server API

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

MT Material Server API

Enviado por

Direitos autorais:

Formatos disponíveis

INTEGRATED PRODUCTION & PERFORMANCE SUITE

MATERIAL SERVER API TECHNICAL REFERENCE

Customer Support Telephone 1.440.646.3434

2010 Rockwell Automation, Inc. All rights reserved. Printed in USA.

Modified: 4/16/2010 2:26:16 PM

Chapter 1 Introducing Material Server API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Material Server API Technical Reference

Material Server API Technical Reference

Introducing Material Server API

Material Server API Overview

Material Interface Definitions

Material Server API Overview

Material Server API Technical Reference

Material Object Model Descriptions

Represents a single Container record from the material database. The

Represents a single ContainerMaterial record from the material

Represents a single ContainerProperty record from the material

Represents a single ContainerState record from the material database.

1 Introducing Material Server API

Represents a single LotProperty record from the material database. The

Represents a single LotState record from the material database. The

Represents a single material record from the material database. The

Represents a single MaterialType record from the material database.

Represents a single MaterialClass record from the material database.

Represents a single MaterialProperty record from the material

Provides methods that can be executed to perform some specific task

Represents a single StorageLocation record from the material database.

Represents a single SubLot record from the material database. The

Material Server API Technical Reference

Returns the number of items in the collection.

Returns a reference to an item in the collection via the index of the

Delegates an enumerator to the collection object. This allows for the

Available Interface Definitions

Inserts a QA test result record associated with a test specification into

Deletes a Container from the material database.

DeleteContainerMateri Deletes a ContainerMaterial from the material database.

Deletes a ContainerState from the material database.

Deletes a QA error correction record associated with a test

Deletes a QA test specification limit record associated with a base test

Deletes a Lot record from the material database.

Deletes a LotProperty from the material database.

Deletes a LotState from the material database.

Deletes a Material record from the material database.

Deletes a MaterialClass record from the material database.

1 Introducing Material Server API

Deletes a MaterialClassProperty record from the material database.

Deletes a MaterialProperty record from the material database.

Deletes a MaterialType record from the material database.

DeleteStorageLocation Deletes a StorageLocation record from the material database.

Deletes a SubLot record from the material database.

Deletes a QA test result record associated with a test specification in

Deletes a QA test specification record from the material database.

Distributes all or a portion of a Lots total quantity to a Container. Also

Returns a Container object with its properties populated with

Returns a Container object populated with the specified Container data

GetContainerByID on Returns a Container object with its properties populated with

Returns a list of Containers in a multi-dimensioned array.

Returns a collection of ContainerMaterial objects that are configured

Returns a collection of 1 to N ContainerPriority objects.

Returns a collection of 1 to N ContainerPriority objects.

Returns a collection of 1 to N Container objects.

Material Server API Technical Reference

Returns a collection of 1 to N MaterialContainer objects.