Inventory

Sepasoft MES Module Suite

Binding Function | Inventory

The Inventory binding function is used to retrieve inventory information based on the filter parameters.

Warning

The Inventory binding function has effectively been replaced by the Equipment WIP binding function.


Parameters

NameDescriptionProperty Type
Begin Date Time

When the Include Inactive Lots parameter is set to True, the results are limited to only include results that were processed at or after this property.

Calendar

(See https://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html)

End Date TimeWhen the Include Inactive Lots parameter is set to True, the results are limited to only include results that were processed at or before this property.

Calendar

(See https://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html)

Include Active Lots

If true, include active MES Material Lots or MES Material Sublots. Active items are those currently being processed.Boolean

Include Completed Lots

If true, include completed MES Material Lots or MES Material Sublots.Boolean
Include Supplemental EquipmentWhen set to TRUE, Supplemental Equipment with the matching Equipment Path will be included in the filter results. Defaults to FALSE.Boolean
Include Custom Lot StatusIf the Final Lot Status setting of a material resource is set, then it can be filtered using this property. For example, MES Material Lot or MES Material Sublot objects can be set to Hold or any other value and then can be filtered here. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.String
Lot NameThe lot name to return the trace details. Optionally Lot UUID can be used but not both.

String

Lot Availability Status (Default Available)

The availability of the lots can be filtered using this property.

Options

Available - The material lots that are currently available.

Used The material lots that are being used.

Both Results will contain both available and the used lots.

String
Material Definition Name

The results can be limited to only include lots or sublots that the associated material matches this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Only one of the Material Class Name, Material Class UUID, Material Definition Name, Material Definition UUID properties can be specified at a time.

Example: *Balsamic*

String
Material Class Name

The results can be limited to only include lots or sublots that the associated material is included in a material class that matches this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Only one of the Material Class Name, Material Class UUID, Material Definition Name, Material Definition UUID properties can be specified at a time.

Example: Vinegar

String
Equipment Name

The results can be limited to only include lots or sublots that are or were stored at the equipment that are included in a equipment class that match this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Only one of the EquipmentName, EquipmentUUID, or Equipment Path properties can be specified at a time.

Example: Vinegar Tank 1

String
Equipment Path

The results can be limited to only include lots or sublots that are or were stored at the equipment that match this property. See Equipment for more information on equipment paths 

Only one of the Equipment Class Name, Equipment Class UUID, Equipment Path or Equipment UUID properties can be specified at a time.

Example: My Enterprise\California\Storage\Vinegar Tanks\Vinegar Tank 1

String
Equipment Class Name

The results can be limited to only include lots or sublots that are or were stored at the equipment that are included in an equipment class that match this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Only one of the Equipment Class Name, Equipment Class UUID, Equipment Path or Equipment UUID properties can be specified at a time.

Example: Vinegar Storage Tanks

String
Personnel Class Name

The results can be limited to only include lots or sublots that are or were handled by personnel that are included in a personnel class that match this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Only one of the Personnel Class Name, Personnel Class UUID or Person First Name and Person Last Name combination properties can be specified at a time.

Example: Unload Operator

String
Person First NameThe results can be limited to only include lots or sublots that are or were handled by personnel that match this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.String
Person Last NameThe results can be limited to only include lots or sublots that are or were handled by personnel that match this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.String
Operation Name

The results can be limited to only include lots or sublots that performs the operation that match this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Example: Unload Vinegar

String
Segment Name

The results can be limited to only include lots or sublots that are handled by segment that match this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Example: Unload Balsamic Vinegar

String
Segment Equipment Name

The results can be limited to only include lots or sublots that are handled by equipment that matches this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Only one of the Segment Equipment Class Name properties can be specified at a time.

Example: Bottling Line 1

String
Segment Equipment Path

The results can be limited to only include lots or sublots that are or were stored at the segment equipment that matches this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Only one of the Segment Equipment Class Name properties can be specified at a time.

Example: Dressings Inc\California\Bottling\Bottling Line 1

String
Segment Equipment Class

The results can be limited to only include lots that were processed at the equipment that belong to the segment equipment class that matches this property. It can contain wildcard characters including * or ?. The * character can be any characters and the ? character represents any single character.

Only one of the Segment Equipment Class Name properties can be specified at a time.

Example: Bottling

String
Custom Property Values

The results can be limited to only include items that have a custom property expressions defined by this property that evaluates to true.

Example: Kind > 3

PyDictionary
Limit Rows To (Default 1000)The maximum number of samples to return in the results.Integer

Table Columns

ColumnDescriptionData Type
MESMaterialLotUUIDUnique identifier for the material lotString
LotNumber assigned to the material lotString
LotSequenceThe sequence property is incremented every time a new Material Lot is created for a given lot number. If it is less than zero, then the lot holding the maximum value is returned and if the same lot number is used for multiple segments, each lot with the same lot number will be assigned a different lot sequence number. Integer
LotDescriptionDescription for the material lotString
LotStatusThe status of the Material Lot. It can be either Active or Complete. When active, there is a response segment to create this material lot that is currently runningString
LotUnitsUnits for the quantity settingString
LotAssemblyTypeType of lot assemblyString
LotBeginDateTimeDate and time that this lot resource startedDate
LotEndDateTimeDate and time that this lot resource endedDate
LotQuantityQuantity of a specific item corresponding to the material lotDouble
LotPropertyStatusWhen Active, there is a response material that has a material reference complex property linked to this material lot that is Active.String
MaterialUUIDUnique identifier for each material objectString
MaterialNameName of the material objectString
MaterialDescriptionDescription for material objectString
LotLocationNameName of locationString
LotLocationPathPath for locationString
LotLocationDescriptionDescription of locationString

Sepasoft MES Module Suite