AddEvent

The
ADDEVENT
execute allows an external application to append an event in one or all active
FactoryTalk Batch
 electronic batch record files based on the BatchID.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute with this format:
[ADDEVENT(
Item,UserID,BatchID,Type,Desc,Value,EU,Cell,Unit,Phase
)]
where:
Item
Item name as specified by the client.
UserID
User ID entered into the event journal with this event.
BatchID
Operator entered batch identification. Use ‘*’ to place the event information into all open electronic batch records.
Type
Type of event being added.
Desc
Description of the event being added.
Value
Value of the event being added.
EU
(optional) Engineering units associated with the event.
Cell
(optional) Process cell which is associated with the event.
Unit
(optional) Unit which is associated with the event.
Phase
(optional) Phase associated with the event.
Action
A successful ADDEVENT
execute places the event into the specified electronic batch record(s). The
FactoryTalk Batch
 Server automatically completes these fields: TIME, AREA, RECIPE, PHASE_DESC, and UNIQUE_ID. If, however, the event is targeted at a single batch, and the batch product is configured for signature confirmation of "comments", then the addition of the event record to the event journal is queued pending a successful signature request signoff.
Return Format
The item populates with this data:
SUCCESS: | SUCCESS:
<ActionID>
| FAIL:
<message>
where:
Field
Format
Description
<ActionID>
ASCII – Integer
Action ID associated with signature(s) generated as a result of the potential prompt response. The prompt response is not actually processed unless all signature requests are successfully signed off.
<message>
ASCII - String
Error message appropriately formatted for operator display.
The following table shows an example of the return on this execute.
Example:
An execute string consisting of:
[ADDEVENT(Item,Station5\Operator,Batch_100,Comment,OperatorComment,This is a comment)]
Could return:
SUCCESS:997
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal