Material_In Resource Parameter

Material_In Sub-Parameters | Reference

Provided in the Batch Procedure framework to track and/or trace (without quantity count) materials through a workflow.

Material_In resource parameter defines:

material by material_name
source by lot_no
procedure (batch recipe) reference by Phase > Unit Class to Unit Procedure assignment.

Add parameter to an element within the batch procedure framework and set the Data Type to Material_In.

You can add material parameters to any phase type within Batch Procedure.

This is a python dictionary that holds resource data for materials.

Sub-Parameter Name and Dictionary Name	Description	sort by type	Recording Type	Value Source Type	Tag Type	Calculation	Data Type
Active_Allocation	Informational sub-parameter that is used when there are multiple Material_In parameters with the same Alternate_Group.	Allocation	All to Object Default -editable	Neither Default -editable	Memory Default -editable	blank Default -editable	String Default -not editable
Actual_Quantity	The actual amount consumed from a lot. The system populates this value. Included in history for analysis.	Quantity	All to Object and History	Execution	Memory		Double
Alternate_Group	Optional Can add multiple Material_In parameters and make them all the same Alternate Group. Create an ENUM and make the default values of the enum “alternate group 1”, “alternate group 2”, etc.	Material Lot	Changes Not Saved	Recipe	Memory		String
Alternate_Priority	Optional based on using alternate materials. Order in which to check the groups for inventory evaluation. Check 1 first, 2 second, etc.	Material Lot	Changes Not Saved	Recipe	Memory		Integer
Auto_Create_Lot	Boolean T/F True - Create material lot under all circumstances. If True, values must be provided for: Lot_Number Material_Name For configuration details, see Material Lot Configuration in Material Resource Parameters \| Batch Procedure.	Material Lot	Changes Not Saved	Recipe	Memory		Boolean
Auto_Select_Lot	Boolean T/F True - Do not ask to use a lot. Just pick the next one and use it. The next available lot or alternate lot is automatically selected, however, the operator can change it to another appropriate lot. False - Ask to use a material lot. A Hold command is sent to the phase and a confirm lot change message is generated. The operation must confirm the lot change before proceeding with the phase. After confirming the next lot, a Restart command is sent to the phase. For configuration details, see Material Lot Configuration in Material Resource Parameters \| Batch Procedure.	Material Lot	Changes Not Saved	Recipe	Memory		Boolean
Bypass_Quantity_Check bypassQuantityCheck	Used in systems where inventory checks are not relevant, and does not require rigorous accounting of material quantities. For configuration details, see Material Lot Configuration in Material Resource Parameters \| Batch Procedure.	Material Lot	Changes Not Saved	Recipe	Memory		Boolean
Enable	Used in conjunction with Alternate set.	Enable/Disable	Changes Not Saved in database	Recipe	Memory		Boolean
Lot_Equipment	Can be path, class, supplemental equipment, or manifest to limit the lots.	Equipment	All to Object and History	Recipe and Execution	Memory		String
Lot_Equipment_Class	Equipment can be filtered by Equipment Class.	Equipment	All to Object and History	Recipe	Memory		String
Lot_Manifest	Used with Alternate materials.	Material Lot	All to Object and History	Recipe and Execution	Memory		String
Lot_Manifest_Class	Filter by Manifest Class for a grouping of manifests to use.	Material Lot	All to Object and History	Recipe	Memory		String
Lot_No	Must be provided when setting Auto_Create_Lot to True; Otherwise this can be provided during runtime.	Material Lot	All to Object and History	Execution	Memory		String
Lot_Status	The lots that can be selected are limited to have this lot status. Use Lot_Status ENUM default. If left blank, only Lot_Status = Complete are available. To include all, enter a wildcard '*'.	Material Lot	All to Object and History	Recipe and Execution	Memory		Enum (Lot_Status)
Material_Class	Optional based on using material classes. The lots that can be selected are limited to be a material of this class of material. If left blank, system returns all lots with statue=complete. Use wildcard '*' to return all.	Material Lot	All to Object and History	Recipe	Memory		String
Material_Name materialName	The lots that can be selected are limited to be of this material. Make part of history for analysis. If a Material_Class is provided, this is not required.	Material Lot	All to Object and History	Recipe and Execution	Memory		String
Material_UOM	Optional - Unit of Measure (UOM)	Material Lot	All to Object and History	Recipe	Memory		Enum (Material_UOM)
Message	Leave this blank. This is for system messages.	System Message	All to History	Neither	Memory		String
Preallocate	Optional based on using a Pre-allocate phase. If true, then the inventory is allocated when the Unit Procedure starts.	Allocation	Changes Not Saved	Recipe	Memory		Boolean
Record_Trace	Triggers the Trace User ID	Trace	Changes Not Saved	Execution	Memory		Boolean
Target_Quantity	The target amount to consume from a lot. Included in history for analysis.	Quantity	All to Object and History	Recipe and Execution	Memory		Double
Trace_User_ID	This ID is used by the system to trace material through a process and to update values. Updated each time Record_Trace is triggered. Exposed in Tag Browser	Trace	All to History	Recipe	Memory		String

Provided from:

3.81.8 RC 1 and 3.81.8 Stable Release.

MES Platform 3.0

Business Connector

Sepasoft Resources

Inductive Resources

Help Versions

Material_In Sub-Parameters | Reference

Material_In Sub-Parameters