A P P E N D I X B

RFID Event Manager Component Reference

This appendix describes the properties of the Event Manager Components (Components) included with the RFID software. The following tables list the properties with a description and the valid values. Refer to the property descriptions and values to decide on the specific settings for your RFID system. The components are used to create Event Manager Roles as described in Chapter 2. Refer to the section To Define RFID Event Manager Roles.

Smoothing Filter

This function creates a union of EPCs discovered over the number of specified n cycles. If an EPC was discovered in cycle < n, it is reported. If it hasn't been seen in more than the last n cycles, it is not reported. This function is necessary because the RFID readers do not report tags with 100% accuracy.

TABLE B-1 Smoothing Filter Properties
Property	Description
classname	com.sun.autoid.filter.Smoothing
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
MaxCycles	The maximum read cycles that an item stays in the virtual view of the reader
MaxPersistTime	The maximum time (in msec) to wait for a reader message before issuing a prune event.
DiscriminateReaders	If true, separate smoothing using reader EPCs. If false, then smooth all events without regard to reader EPC. Default is true.

Delta Filter

This function reports RFID tags leaving and entering the radio frequency fields. For example, on a reader, if at time T1, two EPCs were discovered, then two "tags-in" events are reported. If at time T2, one of the EPCs disappeared, then a "tags-out" event is reported.

TABLE B-2 Delta Filter Properties
Property	Description
classname	com.sun.autoid.filter.Delta
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
DiscriminateReaders	If true, separate smoothing using reader EPCs. If false then smooth all events without regard to reader EPC. Default is true.
reportIn	If true, report incoming tags. Default is true.
reportOut	If true, report leaving tags. Default = true.
reportOnEmpty	If true, report out even if no tags changed. Default = false.
useRecord	If true, use recorded events from previous run. Default = false.
RecordRoot	Path to get and save the events. Default = `java.io.tmpdir`

EPC Filter

This function performs a pass filter on tag EPCs. Those that match the EPC pattern are passed on to listeners, while others are not.

TABLE B-3 EPC Filter Properties
Property	Description
classname	com.sun.autoid.filter.EPCFilter
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values in addition to ALL are: SEVERE (highest value) - fewest messages WARNING INFO CONFIG FINE FINER FINEST (lowest value) most messages
Mask	An Identity URI Pattern used for matching.
EPC	EPC Identifier URI for the matching id.

Bandpass Filter

This function performs a pass filter on Reader Identities; events from readers that match the Identity Pattern are passed on to listeners, while others are not.

TABLE B-4 Bandpass Filter Properties
Property	Description
classname	com.sun.autoid.filter.BandPass
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
Mask	An Identity URI Pattern used for matching.
EPC	EPC Identifier URI for the matching id.

File Connector

This function provides a general connector for the Event Manager. Writes PML Core to an output file.

TABLE B-5 FileLogger Properties
Property	Description
classname	com.sun.autoid.logger.FileLogger
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
File	Destination file where the output will be written.
Append	Append to the file if true. Start a new file at the beginning if false.

HttpPML Connector

This function provides a connector that writes PML Core to an HTTP connection.

TABLE B-6 HttpPMLLogger Properties
Property	Description
classname	com.sun.autoid.logger.HttpPMLLogger
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
URL	Destination HTTP address to connect to.
Proxy	Optional proxy host.
ProxyPort	Optional proxy port, default is 80 if proxy host is set.

JMS Connector

This function provides a connector that sends PML Core events in a JMS Message.

TABLE B-7 JMSLogger Properties
Property	Description
classname	com.sun.autoid.logger.JMSLogger
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
JndiContextFactory	Sets the `java.naming.factory.initial` property with the default value of `com.sun.jndi.fscontext.RefFSContextFactory`.
JndiProviderURL	java.naming.provider.url.
Principal	java.naming.security.principal
Credentials	java.naming.security.credentials
Authentication	java.naming.security.authentication
ConnectionFactory	connection factory
UserName	optional user name for creating connections
UserPassword	optional user password for creating connections
QueueName	queue name
TopicName	topic name
Transacted	indicates whether session is transacted, default false
AcknowledgeMode	indicates whether the consumer or the client acknowledges messages received. Default value = `Session.AUTO_ACKNOWLEDGE`
SendPML	If true, sends PML as a text message; otherwise sends the event object as the message (default is true).

Socket Connector

This function creates a Socket connection and starts writing PML to the connection.

TABLE B-8 SocketLogger Properties
Property	Description
classname	com.sun.autoid.logger.SocketLogger
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
Host	target host to connect to
Port	target port to connect to
CloseOnSend	f true, closes the socket connection after each message

ServerSocket Connector

This function creates a Server Socket and, when the socket connection is accepted, starts writing PML to the connection.

TABLE B-9 SSocketLogger Properties
Property	Description
classname	com.sun.autoid.logger.SSocketLogger
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
Port	target port on which to listen for connections.
CloseOnSend	if true, closes the socket connection after each message

EPCGui Connector

The EPCGui connector is a graphical user interface that displays RFID tags and the number of consecutive times the tags have been sensed by a reader. The tags change colors from red to yellow to green to indicate the number of times they have been seen.

Red - the tag has just been discovered

Yellow - the tag has been in the reader's sensing field for over 10 cycles

Green - the tag has been in the reader's sensing field 30 cycles or more

This GUI runs inside the same Java virtual machine (Java VM) as the rest of the Execution Agent. To display the GUI on a different system, the shell that launched the Execution Agent must be remotely displayed. To avoid this limitation, use the RemoteEventProducer, which posts events to a TagViewer that can run independently from the Execution Agent.

The EPCGui is useful for debugging. It is recommended to use the combination of a RemoteEventProducer and TagViewer in a production environment.

TABLE B-10 EPCGui Connector Properties
Property	Description
classname	com.sun.autoid.logger.epcui.viewer.GuiLogger
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value)
Title	A string that appears as the title of the window

RemoteEventProducer Connector

RemoteEventProducer is a general connector to produce Remote Events. This class does not implement guranteed event delivery. If there are no registered consumers of the generated events, the events are lost.

TABLE B-11 RemoteEventProducer Properties
Property	Description
classname	com.sun.autoid.logger.REProducer
LogLevel	Defines a set of standard logging levels that can be used to control logging output. Possible values are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value) Also see `java.util.logging.Level` and `LogLevel` property description in TABLE 2-4.
EventID	Integer identifier for the event. The consumer must specify the same `EventID` in order to discover the events.
LogicalReader	Name of the logical reader for this producer
PhysicalReader	Name of the physical reader for this producer
RoundRobin	If true, use the RoundRobin dispatcher, else dispatch to all registered listeners.
MaxIgnoredEvents	Maximum number of times trying to fire an event with no listeners registered before an exception is thrown, default is 25.