A P P E N D I X B

RFID Event Manager Component Reference

This appendix describes the properties of the RFID Event Manager 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 determine the specific settings for your RFID system. The components are used to create RFID Event Manager roles as described in Chapter 2. See To Define RFID Event Manager Roles.

Smoothing Filter

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

TABLE B-1 Smoothing Filter Properties
Property	Description	Value
classname	Java class name.	`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.

Delta Filter

This component 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 TagsIn events are reported. If at time T2, one of the EPCs disappeared, then a TagsOut event is reported.

TABLE B-2 Delta Filter Properties
Property	Description	Value
classname	Java class name.	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)
reportIn	Specifies whether to report the incoming tags.	Default = true
reportOut	Specifies whether to report the leaving tags.	Default = true
reportOnEmpty	Specifies whether to report even if no tags have changed.	Default = false
useRecord	Specifies whether to use recorded events from the previous run.	Default = false
RecordRoot	Specifies the path to get and save the events.	Default = `java.io.tmpdir`

EPC Filter

This component performs a pass filter on the value of the RFID tag EPC values. Those EPC values that match the specified EPC pattern are passed on to listeners, while others are not.

TABLE B-3 EPC Filter Properties
Property Name	Description	Example
classname	Java class	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.	Examples are: For a 96-bit GID tag mask - `urn:epc:pat:gid-96:10.1002.[1-20]` For a 64-bit SGTIN tag mask - `urn:epc:pat:sgtin-64:7.1234567.100734.[1-20]` For a 64-bit giai tag mask - `urn:epc:pat:giai-64:7.0614141.[2-4]`
EPC	EPC identifier URI for the matching id.	Examples are: For a 96-bit GID EPC - `urn:epc:tag:gid-96:10.1002.50` For a 64-bit SGTIN EPC - `urn:epc:tag:sgtin-64:7.1234567.100734.20` For a 64-bit giai EPC - `urn:epc:tag:giai-64:7.0614141.4`

BandPass Filter

The BandPass filter is used to select a subset of events that match the specified event source's identity. If an event matches, the Event object is passed to the listeners of the filter, otherwise the Event object is dropped.

An event source identity matches if any of the following conditions are true:

An EPC identifier property has been specified in the configuration for this filter and the event source is an identifier that matches exactly the specified EPC identifier.

An EPC String has been specified in the configuration for this filter and the event source is a String that matches exactly the specified EPC String

A Mask property has been specified in the configuration for this filter and the event source is an identifier that matches the specified Mask's identity URI pattern.

TABLE B-4 BandPass Filter Properties
Property Name	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. See TABLE B-3 for examples.
EPC	An EPC identifier URI or a `String` for the matching ID. If `EPC` is an identifier URI, then the match is successful only if the event's source is an identifires that matches the value of this `EPC` property. If the `EPC` property is not an identifier URI, then it is treated as a `String` and the event's source must be a `String` that matches the `EPC` value

FileLogger Connector

This component provides a general connector for the RFID Event Manager and writes PML core to an output file.

TABLE B-5 FileLogger Properties
Property Name	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 is written.
Append	Specifies whether to append to the file. Append to the file if true. Starts a new file at the beginning if false.

HttpPMLLogger Connector

This component 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.

JMSLogger Connector

This component provides a connector that sends PML core events using 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 the 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).

NullConnector Filter

The NullConnector filter consumes events and does nothing with them. The primary purpose of this connector is to terminate processing of the the event chain if no external processing is required.

TABLE B-8 NullConnector Properties
Property	Description
classname	com.sun.autoid.logger.NullConnector
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

SocketLogger Connector

This component creates a socket connection and starts writing PML core to the connection.

TABLE B-9 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 for the connection.
Port	Target port for the connection.
CloseOnSend	If true, closes the socket connection after each message

SSocketLogger Connector

This component creates a server socket and, when the socket connection is accepted, starts writing PML to the connection.

TABLE B-10 SSocketLogger Properties
Property Name	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.

SAPAII Connector

See Architecture Overview of the RFID Software Plug-In for SAP AII.

TABLE B-11 SAPAII ConnectorProperties
Property	Description\Value
classname	`com.sun.autoid.logger.SapLogger`
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)
SapAIIUrl	The URL where the SAP AII software listens for notifications.
SapDeviceControllerName	The device controller ID used in notifications to the SAP AII software.
SapCommand	The default command to include in the notification to SAP AII software. The default value is `IN`.

EPCGui Connector

The EPCGui connector is a graphical user interface (GUI) 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 viewed.

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 for 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 connector, which posts events to the TagViewer that can run independently from the Execution Agent.

The EPCGui is useful for debugging. Use the combination of a RemoteEventProducer and TagViewer in a production environment. The system automatically creates a RemoteEventProducer connector for every adapter. This enables the TagViewer to receive nonfiltered tags detected by the reader. If you want to see only filtered tags, then you need to attach a RemoteEventProducer connector to the output of the filter. Then use the TagViewer to see the filtered tags.

TABLE B-12 EPCGui Connector Properties
Property Name	Description/Value
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.

REProducer Connector

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

TABLE B-13 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 the `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, then use the RoundRobin dispatcher. If false, then dispatch to all registered listeners.
MaxIgnoredEvents	Maximum number of times trying to fire an event with no listeners registered before an exception is thrown The default = 25.

EpcisJms Connector

The EpcisJms connector sends events from the RFID Event Manager to the RFID Information Server using the Java Message Service (JMS) protocol. This connecter populates the CURRENT_OBSERVATION table and the OBSERVATION_LOG table in the RFID Information Server database. Also see Configuring the RFID Event Manager to Use an EpcisJms Connector.

TABLE B-14 EpcisJms Connector Properties
Property	Description
classname	com.sun.autoid.logger.EpcisLogger
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 descriptions in TABLE 2-4.
EpcisUrl	Specifies the URL for the RFID Information Server. The URL is of the form: `http://`hostname:portnumber`/epcis/service` where hostname is the name of the machine where you installed your RFID Information Server and the portnumber is your HTTP port.
HttpProxyHost	(Optional) Specifies the host name of the HTTP proxy server.
HttpProxyPort	(Optional) Specifies the port number for the HTTP proxy server.
UseJms	(Required) Specifies the delivery method. Value must be one of the following: `true` `topic` (see `TopicName` property) `queue` (see `QueueName` property)
TopicName	(Optional) Only used if the `UseJms` property is `true` or `topic`. Specifies the topic name for JMS. Default value is `epcisTopic`.
QueueName	(Optional) Only used if the `UseJms` property is `queue`. Specifies the queue name for JMS. Default value is `epcisQueue`.
ConnectionFactory	(Optional) Only use if the `UseJms` property is `true`, topic, or queue. Specifies the Java Naming and Directory Interface (JNDI) name of the connection factory. When `UseJms` property is `true` or `topic` , this property is `TopicConnectionFactory` When `UseJms` property is `queue`, this property is `QueueConnectionFactory`.
java.naming.security.principal	RFID Information Server user name.
java.naming.security.credentials	RFID Information Server user password.
java.naming.factory.initial	(Optional) Specifies the class name of the initial context factory. See `javax.naming.InitialContext` for more information.
java.naming.provider.url	(Optional) Specifies the provider URL property used by the `InitialContext` specified by the `java.naming.factory.initial` property.
java.naming.security.authentication	(Optional) Specifies the authentication mechanism to be used. Values can be one of the following: `none` - Use no authentication (anonymous) `simple` - Use weak authentication (clear-text password) space-separated list of Simple Authentication and Security Layer (SASL) mechanism names. Default value is `none`

EpcisHttp Connector

The EpcisHttp connector sends events from the RFID Event Manager to the RFID Information Server using the HTTP protocol. This connecter populates the CURRENT_OBSERVATION table and the OBSERVATION_LOG table in the RFID Information Server database. Also see Configuring the RFID Event Manager to Use an EpcisHttp Connector.

TABLE B-15 EpcisHttp Connector Properties
Property	Description
classname	com.sun.autoid.logger.EpcisLogger
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 the `java.util.logging.Level` and `LogLevel` property descriptions in TABLE 2-4.
EpcisUrl	Specifies the URL for the RFID Information Server. The URL is of the form: `http://`hostname:portnumber`/epcis/service` The hostname is the name of the machine where you installed your RFID Information Server. The portnumber is your HTTP port.
HttpProxyHost	(Optional) Specifies the host name of the HTTP proxy server
HttpProxyPort	(Optional) Specifies the port number for the HTTP proxy server
UseJms	Specifies the delivery method. The value must be one of the following: `false` `http` The default is `http`.
java.naming.security.principal	RFID Information Server user name.
java.naming.security.credentials	RFID Information Server user password.
java.naming.factory.initial	(Optional) Specifies the class name of the initial context factory. See `javax.naming.InitialContext` for more information.
java.naming.provider.url	(Optional) Specifies the provider URL property used by the `InitialContext` specified by the `java.naming.factory.initial` property.
java.naming.security.authentication	(Optional) Specifies the authentication mechanism to be used. Values can be one of the following: `none` - use no authentication (anonymous) `simple` - sue weak authentication (clear-text password) space-separated list of Simple Authentication and Security Layer (SASL) mechanism names