public interface EventReportItf
method to create data collection event reports.
Your application needs to call the
method after defining the
desired event reports to setup and enable the desired event reports with
the equipment. After initialize is called, only the event reports you
have configured are enabled with the equipment. So if you want the equipment
to report all of its events, call the method
after calling initialize.
Events can be given meaningful names and descriptions using the
In the event report data, you receive both the underlying event identifier sent
by the equipment, the CEID value, and the identifier for the event you have
optionally customized, the EventID.
You are able to assign your own variable names using the
Using host specified names for variables allows the logic to ensure
that each name is unique, and provides for uniform naming across equipment instances.
If you do not provide your own name values for variables, the default variable
names are assigned using the naming conventions of the
Sematech Virtual Factory Equipment Interface (VFEI) standard.
The ability to rename events and variables is referred to as Virtual Reporting.
The default names for variables are computed as follows. The variable names defined by the equipment are folded to uppercase, with white space and non-alphanumeric letters being replaced by underscores. Hyphens are not changed. An underscore is inserted for each transition from lowercase to uppercase in the equipment provided name. If the computed name is not unique for the equipment instance, the name is made unique by concatenating an underscore and the variable ID. For example, the equipment variable name PPExecName is assigned the default name PP_EXEC_NAME. The following 8 computed names are exceptions to the naming algorithm and are reassigned based on the Sematech VFEI standard:
ESTABLISH_COMMUNICATONS_TIMEOUT becomes COM_TIMER,
MDLN becomes EQ_MODEL_ID,
PREVIOUS_PROCESS_STATE becomes PREV_PROC_STATE,
SOFTREV becomes EQ_SOFT_VER,
MID becomes MATERIAL_ID,
CMD becomes CMD_VAR,
TID becomes TID_VAR, and
MTY becomes MTY_VAR.
void eventReport(SecsHost sh, String CEID, String EventID, HashMap<String,String> dataItems)
sh- the SECS host connection
CEID- the SECS data collection event ID in the Stream 6 message
EventID- your customized virtual event name
dataItems- the data values of the event report parsed as name and value pairs. The name values are the virtual names that you may customize using the variableUpdate() method.