AddEvent_Instruction

The ADDEVENT_INSTRUCTION
execute allows an external application to append an event associated with an

e
Procedure

control step in an electronic batch record using the name of the equipment phase that is currently executing, the control step index, and the control step reactivation number.

The format and return for this execute includes:

Execute Format	A FactoryTalk Batch Server supports an execute with this format: [ADDEVENT_INSTRUCTION( Item,UserID,Phase,Type,Desc,StepIndex,ReactivationNumber,InstructionHTML )]
where:	Item	Response item name as specified by the client.
	UserID	User ID entered into the event journal with this event.
	Phase	Phase associated with this event.
	Type	Type of event being added.
	Desc	Description of the event being added.
	StepIndex	Step index of the control step associated with this event. This field’s value writes to the PVALUE field in the event journal.
	Reactivation Number	Control step reactivation number associated with this event.
	InstructionHTML	(optional) HTML for the instruction step.
Action	A successful ADDEVENT_INSTRUCTION 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 targets a single batch, and the batch product is configured for signature confirmation of "comments", then adding the event record to the event journal is queued pending a successful signature request signoff.
Return Format	The item populates with this data: SUCCESS\| FAIL: <message> \| FAILED

The following table shows an example of the return on this execute.

Example:

An execute string:

[ADDEVENT_INSTRUCTION(Item,Earl\ADD_SUGAR,Instruction Complete,Step Completed,1,0,<FORM>Open the big green valve</FORM>]

Execute reference

Provide Feedback

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