AutoBatchID_Info
The
AUTOBATCHID_INFO
execute returns the batch ID from a call to BatchIDCreation.The format and return for this execute includes:
Execute Format | AUTOBATCHID_INFO( Item, UserID, RecipeName ) | |
where: | Item | Item name on which to place the execute. |
UserID | Computer name or user name performing the given execute as well as the user ID who issued the given execute. | |
Recipe Name | String representing the recipe file name without an extension. | |
Action | A successful AUTOBATCHID_INFO execute causes the <BatchIDInfo> value, as defined in the CreateBatchID.dll , to return. | |
Return Format | The item populates with this data: SUCCESS:< BatchIDInfo> $END|FAIL: <Message> $BATCHID: <Default-BatchID > | |
where: | ||
Field Name | Format | Description |
<BatchID> | ASCII | Value generated by a custom batch ID implementation; or, if no customization is applied, the default batch ID as defined in the batchsvr.ini file. |
<Message> | ASCII | Custom or generic message specifying the context of an error. |
TIP:
FAIL: can indicate that an error took place at the boundary between the
FactoryTalk Batch
Server and BatchIDCreation application (COM failure), or that a failure generates from within the BatchIDCreation code implementation (custom generated error or internal failure). In either case, following the FAIL: identifier is the message specifying the textual context of the error and the default batch ID, as configured in the Equipment Editor Server Options
dialog box.The following table shows an example of the return on this execute.
Example: | An execute string: AUTOBATCHID_INFO (s, dev_bjwallwi01/bjwallwi, MCLS_FRENCHVANILLA) |
Example: | Output: SUCCESS:FRENCH_VANILLA_012790$END OR FAIL:DivideByZero$BATCHID:DefaultBatchID |
Provide Feedback