AutoBatchID_Info

The

AUTOBATCHID_INFO

execute returns the batch ID from a call to BatchIDCreation.

The format and return for this execute includes:

Format and return
Format	Description
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. The Default Batch ID is defined in the FactoryTalk Administration Console Explorer dialog > FactoryTalk Directory Batch Services Properties dialog, General or Secondary Server tab, Batch creation area.
<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

FactoryTalk Administration Console Explorer

FactoryTalk Batch Services Properties

dialog.

To configure the

Default Batch ID

, right-click an application or area name. Either select to add a new server by selecting

Add New Server

FactoryTalk Batch Server

or edit an existing server. Configure the

Default Batch ID

by opening the

FactoryTalk Batch Services Properties

dialog and selecting the

General

tab or the

Secondary Server

tab. In the

Batch creation

area, view the

Default Batch ID

The following is an example of the return on this execute.

An execute string:

AUTOBATCHID_INFO (s, dev_bjwallwi01/bjwallwi, MCLS_FRENCHVANILLA)

Output:

SUCCESS:FRENCH_VANILLA_012790$END

FAIL:DivideByZero$BATCHID:DefaultBatchID

Execute reference

Provide Feedback

Have questions or feedback about this documentation? Please submit your feedback here.