Mtrl_Info
The
MTRL_INFO
execute returns the information necessary allowing material selection for a Material Manager
phase written as material class-based.The format and return for this execute includes:
Execute Format | A FactoryTalk Batch Server supports an execute with this format:[MTRL_INFO( Item,UserID,RecipeFileName )] | ||
where: | Item | Item name as specified by the client. | |
UserID | User identification associated with this event. | ||
RecipeID | Recipe filename. | ||
Action | A MTRL_INFO execute returns necessary information to select materials for Material Manager phases that have a MATERIAL_CLASS parameter set to a non-NULL_CLASS value. | ||
Return Format | The MTRL_INFO execute returns in this format: SUCCESS: <Phase-MaterialInfo> | FAIL: <Message> | ||
where: | |||
<Phase-MaterialInfo> | is | <Null List> | < Phase-Material List> | |
<Phase-MaterialList> | is | <Phase-Material Record> | <Phase-Material Record> \crlf < Phase-Material List> | |
<Phase-MaterialRecord> | is | <Phase Pathname> \t <Material Class Name> \t <Material List> $END | |
<MaterialList> | is | < Material Name> | < Material Name> \t <Material List> | |
where: | |||
Field Name | Format | Description | |
<Phase Pathname> | ASCII | Full recipe pathname to the phase. (for example, PROC_1\UNITPROC_1:1\OPER_1:3\ADD:4) | |
<MaterialClass Name> | ASCII | Name of material class referenced by the MATERIAL_CLASS parameter. (for example, SWEETENER) | |
<MaterialName> | ASCII | Name of a material of the designated material class. (for example, RAW_SUGAR) | |
TIP:
"SUCCESS:" followed by a null list indicates that no material class references exist to be resolved.
"
SUCCESS:" followed by a non-null list implies that all Material Lists returned must also be non-empty. If an empty Material List would have resulted (that is, no Material to choose for the Material Class), MTRL_INFO returns "FAIL:".The following table shows an example of the return on this execute.
Example: | An execute string consisting of: MTRL_INFO (Item,User,VANILLA_ICE_CREAM.BPC) Could return: SUCCESS:YUMMY_STUFF\SWEETCREAM_UP:1\SWEETCREAM_OP:2\ADD:1\tSWEETENERS\tRAW_SUGAR\tBROWN_SUGAR\tSYRUP$END\crlf YUMMY_STUFF\CHOCOLATE_UP:1\CHOCOLATE_OP:2\ADD:1\tDARK_CHOCOLATES\t68_PER_CENT_COCOA\t52_PER_CENT_COCOA$END |
Provide Feedback