AddEvent_CI
The
ADDEVENT_CI
execute allows an external application to append an event in a FactoryTalk Batch
electronic batch record file based on its unique CreateID.The format and return for this execute includes:
Execute Format | A FactoryTalk Batch Server supports an execute with this format:[ADDEVENT_CI( Item,UserID,CreateID,Type,Desc,Value,EU,Cell,Unit,Phase )] | |
where: | Item | Response item name as specified by the client. |
UserID | User ID entered into the event journal with this event. | |
CreateID | Unique batch ID assigned by the FactoryTalk Batch Server. | |
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 associated with the event. | |
Unit | (optional) Unit associated with the event. | |
Phase | (optional) Phase associated with the event. | |
Action | A successful ADDEVENT_CI FactoryTalk Batch Server automatically completes these fields: TIME, AREA, RECIPE, PHASE_DESC, and UNIQUE_ID. If, however, the batch product is configured for signature confirmation of "comments", then adding the event record to the event journal is queued pending successful signoff of a signature request. | |
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 will not actually be 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: [ADDEVENT_CI(Item,Station5\Operator,11,Comment,OperatorComment,This is a comment] |
Provide Feedback