Sun Java™ System RFID Software 3.0 Administration Guide Sun Microsystems, Inc. www.sun.com Part No. 819-4685-10 February 2006, Revision A Submit comments about this document at: http://www.sun.
Copyright 2006 Sun Microsystems, Inc. 4150 Network Circle, Santa Clara, CA 95054 U.S.A. All rights reserved. Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without limitation, these intellectual property rights may include one or more U.S. patents or pending patent applications in the U.S. and in other countries. U.S. Government Rights – Commercial software.
Contents Before You Begin 7 Sun Welcomes Your Comments 1. 10 Sun Java System RFID Software Introduction RFID Electronic Product Code Details EPC Data Format EPC Network 11 11 13 RFID Information Server 2.
3. Distributed RFID Event Manager Environment General Distributed Installation Considerations Managing a Distributed Installation 57 58 Distributed Installation Component Scripts 4.
Configuring the RFID Event Manager to Use an EpcisJms Connector 119 Configuring the RFID Event Manager to Use an EpcisHttp Connector 7.
B. Adapter for Symbol MC9000-G Readers 163 Adapter for Zebra Technologies Printers 165 RFID Event Manager Component Reference Smoothing Filter Delta Filter EPC Filter 168 169 170 BandPass Filter 171 FileLogger Connector 172 HttpPMLLogger Connector JMSLogger Connector 174 NullConnector Filter 175 SocketLogger Connector 176 SSocketLogger Connector SAPAII Connector 177 178 EPCGui Connector 178 REProducer Connector EpcisJms Connector EpcisHttp Connector C.
Before You Begin This administration guide for Sun Java™ System RFID Software 3.0 (RFID software) provides an overview of the RFID software architecture and instructions for configuring the various components. This guide is designed to aid system administrators and engineers who configure, administer and deploy the RFID software subsystems and components.
Related Third-Party Web Site References Third-party URLs are referenced in this document and provide additional, related information. Note – Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources.
TABLE P-1 Definition of Variables Used in URLs (Continued) Variable Description domain Your Internet domain name path The server’s directory structure indicating the path to the individual file file The individual file name ■ UNIX specific descriptions throughout this manual also apply to the Linux operating system, except where Linux is specifically mentioned. ■ RFID installation root directories are indicated by the variable rfid-install-dir in this document.
Related Documentation The following table lists the tasks and concepts that are described in the Sun Java System RFID Software manuals and release notes. If you are trying to accomplish a specific task or learn more about a specific concept, refer to the appropriate manual. Topic For Information Late-breaking information about the software and the documentation Sun Java System RFID Software 3.0 Release Notes Installing Sun Java System RFID Software and its various components.
CHAPTER 1 Sun Java System RFID Software Introduction An overview of the Sun Java™ System RFID Software 3.0 is contained in the Sun Java System RFID Software 3.0 Installation Guide. You must be familiar with that introductory material before using this guide. The RFID Software is supported on several operating system (OS) platforms, application servers and databases. Refer to the Sun Java System RFID Software 3.0 Release Notes for the latest details.
Identifier) that uniquely identifies an individual object, and may include an optional Filter Value when it is necessary to enable the effective and efficient reading of the EPC tags. The EPC encoded in an RFID tag can identify the manufacturer, product, version, and serial number. The EPC also provides an extra set of digits to identify unique items. The major part of the standard EPC data field is the EPC Identifier. The optional Filter Value field within the EPC can supplement the basic EPC tag readings.
■ URIs for EPC patterns, which refer to a set of EPCs for the purpose of EPC filtering. A pattern of “urn:epc:pat:sgtin-64:3.0652642.[10242047].*” refers to any SGTIN Identifier 64-bit tag with a filter value of three, a company prefix of 0652642, an item reference in the range from 1024 to 2047 and any serial number.
Sun Java RFID System Sensor RFID Management Console RFID Reader Tagged EPC Tag Cases and Pallets EPC Event Manager Smart RFID Reader ALE PML XML etc. ALE Trading Partner or Supplier FIGURE 1-1 Integration and Workflow (Seebeyond, Tibco, etc.
The RFID Software uses the JMS API as one of its primary methods for communicating with third-party software. Communication with the RFID Information Server is stateless and synchronous. If HTTP is used as the transport, the client uses HTTP POST to communicate with the RFID Information Server. To implement synchronous requests with JMS API, the client uses a message ID to correlate requests with responses. JMS messages, requests and responses, are posted to a well-known topic.
Sun Java System RFID Software 3.
CHAPTER 2 Configuring the RFID Event Manager This chapter describes the necessary concepts and procedures for configuring the RFID Event Manager using the RFID Configuration Manager tool.
The adapter functions by receiving the EPC of the RFID tag and generating an event that includes a timestamp and the source of the event. The source of the event is the reader and antenna that read the tag. The event is posted to a set of listeners, such as filters or connectors, that then process the event. Filters can smooth the data by throwing away previously detected information, or by using a mask-matching algorithm to route information to other components based on the mask criteria.
The RFID Configuration Manager consists of a configuration service and a user interface to the service. To begin using the RFID Configuration Manager, it is necessary to understand the concepts of device profiles, RFID Event Manager components, roles, configuration objects, and devices. ■ Device profiles – A device profile provides the fully qualified description of a given RFID reader or other device (such as a printer or sensor) model and its properties.
configuration object might associate the Alien reader with IP address 129.146.28.22 and a specific user name and password to the Alien-ALR-9780 device profile using the DockDoor role. ■ For example, consider the case where you create two roles, 1=DockDoor and 2= ConveyorBelt.
TABLE 2-1 RFID Configuration Manager Drawing Icons (Continued) Icon Description Autolayout function redraws the diagram in a connection ordered fashion. Note: This icon has nothing to do with grouping or ungrouping functions. Grouping function that enables you select multiple boxes and move them around as a unit. Ungrouping function enables you move multiple boxes grouped as a unit one at a time again.
TABLE 2-2 Overview of RFID Event Manager Configuration Process (Continued) Task Procedure 4. Use the Configuration Manager to create roles. “To Define RFID Event Manager Roles” on page 30 5. Create the Event Manager Configuration Objects. “To Define the RFID System Configuration Object” on page 38 6. Start the RFID Event Manager. Sun Java System RFID Software 3.
2. (Optional) Expand the Device Profiles node to see the supported device profiles that have been installed with your RFID Event Manager.
▼ To Start the RFID Configuration Manager (Microsoft Windows) ■ ■ Start Menu option – Choose Start → Programs → Sun Microsystems → Sun Java System RFID Software → Configuration Manager. Command window – C:\Program Files\Sun\RFID Software\rfidem\ bin\rfidconfig.bat RFID Software Deployment Parameters During installation, you specified a unique Jini™ group to use in your RFID environment. The RFID Configuration Manager Deployment Parameters dialog box enables you to change the value of this Jini group.
3. Review or change the parameters as necessary. You are discouraged from changing these parameters except in the following situations: ■ ■ A conflict exists with the default port. The initial Jini group is not unique. Caution – Exercise extreme caution when updating these parameters, as the system can become unusable if the incorrect parameters are used. ▼ To Define the RFID System Physical Devices A device instance is a physical instance of a device profile in the RFID system.
3. Click Please Select a Profile to see a drop-down list of possible device profiles. All other fields are null until you select the base profile. 4. For the purposes of this example, select PMLReader from the drop-down list. The default properties associated with the PMLReader are displayed in the dialog box. 26 Sun Java System RFID Software 3.
5. Type the reader IP address, the IP port number, and the reader name. Use the reader IP address and IP port number for an actual physical reader in your RFID system. These property values associate the physical reader to the appropriate device profile. Use a meaningful name, as this reader name appears in the navigation tree under the Devices node. For the purposes of this example, type the following: ■ ■ ■ Reader IP address – 129.135.15.2 IP Port for Reader – 2005 Reader Name – NewPMLReader 6.
7. (Optional) Add any new necessary configuration properties. See “To Add a Configuration Property to a Reader” on page 28. ▼ To Add a Configuration Property to a Reader Prerequisite – This procedure assumes that you have created the example NewPMLReader as described in the previous procedure, “To Define the RFID System Physical Devices” on page 25. 1. If you have not already done so, start the RFID Configuration Manager.
4. Select any configuration property name field. 5. Right-click and choose Add Property from the contextual menu. A blank row appears enabling you to add the Name and Value for the new property. 6. Type the appropriate values and click Ok. The new configuration property is added to the device. The following screen capture shows shows the newly added configuration property of newProperty added to the NewPMLReader.
▼ To Define RFID Event Manager Roles Use the drawing pane of the RFID Configuration Manager to visually create the roles that comprise your RFID application. The role created in the following procedure detects RFID tags from a reader, smooths the tag distribution, and records the detected RFID tags in a file on every cycle. Depending on the physical environment, RFID tags can appear and disappear from the reader’s view at rapid intervals.
3. In the Select a Name field, type the name of the Role and click Ok. Use a descriptive name for the role. For this example, use the name testRole as shown in the following screen capture. A new window opens and displays the RFID Role and Component Editor and its drawing pane. The drawing pane is prepared to create the new role in the Role and Component Editor. The new role name appears in the navigation tree on the left of the designer under the Roles node. 4.
5. Select a component. For this example, select the Smoothing Filter. 6. Type a unique name for this filter, for example, testSmoothingFilter, and click Ok. The filter appears on the drawing pane as shown in the following screen capture. 32 Sun Java System RFID Software 3.
7. Click the connector icon (looks like a roll of film) and add a File connector named testConnector. The following screen capture shows the drawing pane after a smoothing filter and a file connector have been added. 8. Connect the components in the necessary order. To do so, click the port (the small square at the center of each component) and drag a line to another component. This action connects the output of one component to the input of another component.
Caution – Do not connect a connector to another connector, this configuration has no meaning in the RFID system configuration. The following screen capture shows the testSmoothingFilter that is connected to the testConnector. 9. Add an input point to the role. The input point for the role is the attachment point by which a physical device provides data to the role in a real configuration instance. You must define an input point for the role. a. Click the input icon.
b. Select the input point and click Ok to add it to the role. The input point appears on the drawing pane.
c. Connect the input point to the appropriate component. Once you have added the necessary filters, connectors, an input point and connected everything as needed, the role is ready to save. The following screen capture shows a completed role with one filter, one connector, and the filter designated as the input point that directs the input data to the connector. 36 Sun Java System RFID Software 3.
10. To save the role, return to the RFID Configuration Manager. When you started this procedure to define a role, a second window opened. The title bar of this second window is labeled RFID Role and Component Editor. Return the focus of your cursor to the original window with the title bar labeled RFID Configuration Manager. Caution – You cannot save the role from the RFID Role and Component Editor window. Do not close the RFID Configuration Manager window without first saving your work. 11.
Note – Changes to a role after a configuration object is created do not propagate to the configuration objects. For example, if you create a configuration object, CODemo, that instantiates the Demo role and then later, you add a new filter or connector to the Demo role, the CODemo does not include this new component. To use the updated Demo role, a new configuration object needs to be created. You can continue to use the original CODemo configuration object or it can be deleted.
1. If you have not already done so, start the RFID Configuration Manager. See “To Start the RFID Configuration Manager (UNIX)” on page 22 or “To Start the RFID Configuration Manager (Microsoft Windows)” on page 24. 2. From the RFID Configuration Manager menu, choose Configuration → New. A dialog box appears that lists the available roles. 3. Select the role on which to base this configuration object, and click Ok. The Configuration Object dialog box appears.
This dialog box has four areas for input as follows: ■ The Configuration Object Name field. ■ The Input Point Configuration area, which contains a drop-down list of the available devices. Click Select a Reader to see the drop-down list. ■ A tabbed section for customizing the role components that shows a separate tab for each component that is part of the role. ■ The Configuration Properties area that corresponds to the selected component tab.
4. In the Configuration Object Name field, type a name for your configuration object. 5. Select a reader to add that reader’s component property set to the configuration object and propagate the appropriate interconnections. In this example, select NewPMLReader. A tab is added showing the configuration properties for the selected reader. 6. Click the NewPMLReader tab to show the reader properties. You can make changes to the specific values for this configuration object on this tab.
7. When you have finished customizing the component properties, click Ok to create the configuration object. The configuration object appears on the drawing pane of the RFID Configuration Manager and also appears in the navigation tree under the Configuration Objects node. The following screen capture shows the testConfigObject created in the prior steps. 42 Sun Java System RFID Software 3.
8. To save your work, choose File → Save from the RFID Configuration Manager main menu. A confirmation message appears. 9. Click Ok. Your work is saved. ▼ To Modify a Configuration Object 1. If you have not already done so, start the RFID Configuration Manager. See “To Start the RFID Configuration Manager (UNIX)” on page 22 or “To Start the RFID Configuration Manager (Microsoft Windows)” on page 24. 2. From the RFID Configuration Manager menu, choose Configuration → Edit. 3.
4. Decide what to edit. The dialog box that appears depends on whether you choose to edit the devices associated with this configuration object or the properties of the existing devices and components. ■ To specify a new and different set of devices (readers or printers) for the role, choose Yes and follow these steps. a. Click Please Select an Input to see a drop-down list of devices. b. Select the new device and click Ok. c.
b. Change the properties as needed and click Ok. c. To save your work, choose File → Save from the RFID Configuration Manager main menu. A confirmation message appears. d. Click Ok. Your work is saved. ▼ To Start the RFID Event Manager After you have defined your RFID system’s configuration objects, you must stop and restart the RFID Event Manager if it is running. If it is not running, start it. The following command line examples use the default rfid-install-dir for each platform.
If you use the Start menu option, you must select both Start Agent and Start Station. ■ Command line option – You can also start both the Control Station and the Execution Agent by using the startall script found at C:\Program Files\ Sun\RFID Software\rfidem\bin. Note – Refer to the Sun Java System RFID Software 3.0 Installation Guide for more information on installed scripts and directories associated with this software.
Device-specific properties and additional considerations for the common properties are described in the device-specific tables that are listed in the Adapter Configuration Description column of TABLE 2-3. ■ outputs – A sequence of component names to be registered as event listeners to this adapter. The outputs normally designate one or more filters or connectors.
All device adapters support a basic set of properties, unless otherwise specified in the configuration section for the specific adapter. The common properties are described in the following table. TABLE 2-4 48 Device Adapter Common Properties Property Description LogLevel Specifies the detail of logging information to be generated by the adapter. This property overrides the system-wide logging level for the component. Also see “Additional Information for Common Properties” on page 50.
TABLE 2-4 Device Adapter Common Properties (Continued) Property Description Values autoread Available on some readers and sed in conjunction with the property, scanDuration. • When enabled, the reader is in a continuously listening mode in the following way – the reader gathers tag information for scanDuration msecs, reports the findings and loops again through the same read and report sequence.
Additional Information for Common Properties ■ Log level – Log level settings follow logging conventions that are established in J2SE, version 1.4.2. for more information, see the API documentation for the class java.util.logging.Level found at http://java.sun.com/j2se/1.4.2/docs/api/index.html. Also see “Log Files” in the Sun Java System RFID Software Installation Guide. ■ Reader EPC identifier – This property, readerepc, is the EPC value that is associated with the reader.
▼ To Edit a Device Profile 1. If you have not already done so, start the RFID Configuration Manager. See “To Start the RFID Configuration Manager (UNIX)” on page 22 or “To Start the RFID Configuration Manager (Microsoft Windows)” on page 24. 2. From the RFID Configuration Manager main menu, choose Components → Device Profiles. The RFID Role and Component Editor appears with the Device Profiles node expanded. 3. From the RFID Role and Component Editor main menu, choose Profile → Edit.
4. Select the device profile to edit and click Ok. The Profile Inspector dialog box appears. The first field is the profile Name, which identifies the profile uniquely. The next area of the dialog box shows the configuration properties. See Appendix A for detailed descriptions of these properties for each supported adapter. 5. Type the new values, and click Ok. At this point, your work is only saved to an in-memory database. You must save the results of your changes as described in the next step. 6.
RFID Event Manager Component Overview The primary types of RFID Event Manager components are filters and connectors. The RFID Software comes with a set of predefined filters and connectors that are used to create roles in the RFID system. Roles are defined in “Event Manager Concepts” on page 17. RFID Event Manager Filters Zero or more filters may be defined in a role. Filters are linked from input events to other components that name them as outputs.
TABLE 2-5 RFID Event Manager Filters (Continued) Name Description Properties Delta Reports tags leaving and entering the radio frequency (RF) field. See TABLE B-2. EPC Performs a pass filter on tag EPCs. EPCs that match the EPC mask are passed on to listeners, while other EPCs are not. See TABLE B-3. Smoothing Creates a union of EPCs discovered over the number of specified n cycles.
Custom RFID Filter and Connectors The RFID Software supports the creation of customized filters and connectors. Use the Sun Java System Software Toolkit 3.0 to create custom components. See the Sun Java System RFID Software 3.0 Developer’s Guide for details.
Sun Java System RFID Software 3.
CHAPTER 3 Distributed RFID Event Manager Environment This chapter includes the following topics: ■ ■ General Distributed Installation Considerations Managing a Distributed Installation General Distributed Installation Considerations RFID Event Manager Execution Agents communicate and gather information from the RFID readers. A single Execution Agent is capable of controlling and collecting information from multiple RFID Readers.
You can change the Control Station's group name after installation by invoking the RFID Configuration Manager. The only way to change the group name for the Execution Agents is to reinstall them, so be careful when you define the group name. Note – All of your deployment information is managed from the Control Station. No configuration information is lost by reinstalling an Execution Agent.
Starting and Stopping the Execution Agent Similarly, on hosts where the Execution Agent components are installed without the Control Station, you can find the script agent installed in /rfid-install-dir/bin. To use the script, change to the specified directory and type one of the following, as needed: ■ ■ ■ To start the Execution Agent, type agent start. To stop the Execution Agent, agent stop. To show the status of the Execution Agent, type agent status.
Sun Java System RFID Software 3.
CHAPTER 4 Configuring Communication With SAP Auto-ID Infrastructure Sun Java System RFID Software 3.0 (RFID Software) includes a plug-in to enable integration with the SAP Auto-ID Infrastructure 2.1 (SAP AII) component of the SAP NetWeaver® platform. SAP AII enables communication between the SAP® R/3® software, the mySAP™ Supply Chain Management solution (mySAP SCM solution), and other SAP Enterprise Resource Planning (ERP) components using device management/device controller software.
Setting up communication between the RFID Event Manager and the SAP AII software also requires familiarity with the SAP software. You must also have SAP AII installed to complete the procedures in this chapter. This guide does not cover the details of SAP AII installation or configuration. However, the intent is to provide sufficient information to enable a user with reasonable familiarity with SAP AII to complete the necessary tasks. Note – Configure the RFID Event Manager first, then configure SAP AII.
■ The SAPLogger connector interprets these properties and maps them to a specific XML message sent back to SAP AII. ■ The connector’s properties are set by using the RFID Configuration Manager. See “Configuring the RFID Event Manager to Communicate With SAP AII Software” on page 64. Note – The plug-in’s SAP AII web service is only used for incoming requests. The plug-in’s SAP AII connector is only used for outgoing requests.
Reader Adapter Filter SAP AII Connector Reader PML / HTTP for Read Notification Execution Agent writeIdentifier () / RMI SAP AII Reader Web Service ALE Web Service SAP AII Web Service Commission Tag SAP Netweaver AppServer Control Station FIGURE 4-1 Communication Flow Between the RFID Event Manager and SAP AII.
▼ To Define the RFID Devices 1. If you have not already done so, start the RFID Configuration Manager. See “To Start the RFID Configuration Manager (UNIX)” on page 22 or “To Start the RFID Configuration Manager (Microsoft Windows)” on page 24. The RFID Configuration Manager appears. 2. Remove the Demo role from the drawing pane by following these steps: a. Click on the Demo configuration object in the drawing pane. This action selects the object.
5. In the Reader IP address field, type the IP address for the specific device. 6. In the IP Port for Reader field, type the port number for the device. 7. In the Reader Name field, type the name for the device. Select a name that you want SAP AII to use to communicate with this device. If no name is defined, the RFID Configuration Manager generates a name based on the profile type, the host name, and the port number.
each printer. To do this add a new template property for each print format that you need. The print format defined by the original template property is the default template used by the printer. Each additional template property should be named as follows, template.f1, template.f2, and so on. The value for each template (template, template.f1, template.f2 and so on) property specifies the text file that contains the print format.
9. When you are done defining the device properties, click Ok. 10. Repeat the steps 3 through 8 to define all your readers and printers. 11. When you have finished defining your devices, proceed to the next section and define the RFID Event Manager’s SAP AII connection properties. Defining the RFID Event Manager’s SAP AII Connection Properties The RFID Software provides two default Roles for communication with SAP AII.
The reader role is used to send notifications to SAP AII by using the SAP AII-DC 1.0 protocol. In the SAP AII reader role, you specify the connection parameters (host name and port number) for SAP AII. By default, the RFID Event Manager defines the controller device ID as SunEventManager. You can specify a different controller device ID by updating the properties of the SAP AII connector in the role. ▼ To Define the RFID Event Manager’s SAP AII Connection Parameters 1.
2. Select and right-click the Connector for SAP AII. 3. Choose Edit from the contextual menu. The Connector Details dialog box appears. 70 Sun Java System RFID Software 3.
4. Update the SAPAIIUrl property field with the URL where your SAP AII software listens for notifications. Replace the default URL with your specific configuration details. 5. Confirm the value of the SapDeviceControllerName property. The SapDeviceControllerName property specifies the device controller ID used in notifications to SAP AII. You must use this value as the device controller ID in the SAP AII Auto-ID Master Data: RFID Device configuration screen.
6. Confirm the value of the SapCommand property. Every XML notification message to SAP AII includes a command element. SAP AII provides the ability to define new commands and map them to business rules. The SapCommand property defines the default command that is to be included in the notification to SAP AII. Because this command is likely to be different for readers in different business roles, you can change the command for each configuration object.
▼ To Define the Printer Configuration Object for SAP AII 1. In the RFID Configuration Manager, choose Configuration → New. The Select the Base Role dialog box appears and lists the available roles. 2. Select Printer for SAP AII and click Ok. The Configuration Object dialog box appears. 3. In the Configuration Object Name field, type a unique name for the configuration. For example: SapAiiPrinter03 4. In the section Please configure the Input Points, click Select a Reader. 5.
6. Confirm the values of the properties, and click Ok. ▼ To Define the Reader Configuration Object for SAP AII 1. In the RFID Configuration Manager, choose Configuration → New. The Select the Base Role dialog box appears and lists the available roles. 2. Select Reader for SAP AII and click Ok. The Configuration Object dialog box appears. 3. In the Configuration Object Name field, type a unique name for the configuration. For example: SapAiiReader02 4.
6. Select the tab Connector:SAPAII to review the values of the Configuration Properties. You can modify these properties without affecting other reader configurations. By default, the SapCommand property contains the value IN that tells the device to send the notification command, IN, to SAP AII. The values for the SapAIIUrl and SapDeviceControllerName properties reflect the values that were used during the role configuration. 7. Click Ok. 8.
Configuring SAP AII to Communicate With the RFID Event Manager After configuring the RFID Event Manager, you must configure the SAP AII side of the connection. You use the SAP AII software to perform this procedure. This procedure does not describe installation of the SAP AII software.
▼ To Configure SAP AII Communication With the RFID Event Manager 1. Log in to your SAP AII installation. 2. Execute transaction /nsm59 to enable use of the SAP AII interface’s Display and Maintain RFC Destinations feature. 3. Define your RFC as described in the SAP documentation. The following SAP AII screen capture shows the configuration for the RFID Event Manager deployed at IP address: 129.150.25.213, listening on port 8080, at default path /AII/AII.
Copyright SAP AG 2006. All rights reserved. 4. Create or modify (as needed) a new RFC destination with a connection type of HTTP Connections to Ext. Server. 78 Sun Java System RFID Software 3.
5. Click Test Connection to test the communication with the RFID Event Manager. You should receive the error: HTPP/1.1 500 Internal Server Error - this is expected. This error indicates that although the RFID Event Manager was able to receive the test command, because the command does not follow the SAP AII-DC 1.0 protocol, it cannot be parsed. This is the expected result at this point.
Copyright SAP AG 2006. All rights reserved. 80 Sun Java System RFID Software 3.
CHAPTER 5 Monitoring the RFID System The RFID Management Console is a web-based application for monitoring the readers and components of the RFID Event Manager system.
▼ To Access the RFID Management Console 1. Confirm that the RFID Event Manager and your application server are running. To use the RFID Management Console, your application server must be running. To see all of the screens and data for the RFID Management Console, the RFID Event Manager must also be running. 2. Open a supported web browser and type the RFID Management Console URL. The URL is of the following format: http://hostname:port-number/sdui. For example, http://myhost:8080/sdui.
4. Choose the task to perform from the links on the left side of the screen. See the following sections of this chapter for more information on using the RFID Management Console.
Performing RFID Management Console Administration Tasks From the RFID Management Console Administration menu, you can perform the following tasks: ■ ■ ■ ■ Manage groups. Manage settings. Change passwords. Manage users. Creating and Managing RFID Management Console Users When you log in to the RFID Management Console for the first time, you must log in as the default admin user. The admin user has administrator privileges and can view all readers and groups.
RFID Management Console User Roles and Privileges TABLE 5-1 Nonadministrator Without Reader Privileges Nonadministrator With Reader Privileges Action Administrator Create users X Create groups X Assign users to groups X Assign readers to groups X View groups Can view all groups Can only view groups to which the user belongs Can only view groups to which the user belongs View readers Can view all readers Can only view readers in the groups to which it belongs Can only view readers in the
▼ To Create New RFID Management Console Users Only administrators can create new users. 1. Log in to the RFID Management Console as the admin user. See “To Access the RFID Management Console” on page 82. 2. Choose Administration → Users. The existing default admin user information appears. 3. Click Create New User. The Create New User dialog box appears. 4. Type the necessary values to create the new user. 5. Select the Administrator check box to enable the user to create new users and groups. 6.
Creating and Managing Reader Groups The Groups menu option enables you to group different readers for easier tracking. Choosing this option displays the groups that have been created and the number of readers that are in each group. A default group named All Readers contains a list of all available readers. The All Readers group enables administrators to view all the available readers in the entire system.
If no groups have been created, only the default All Readers group appears. If the user is not assigned to any groups, then no groups appear. 3. Click Create Group. The following screen appears: 4. Type the Group Name 5. (Optional) Type the Description. 6. (Optional) Select the check box, Choose reader(s) to add to the new group. Selecting this check box enables you to add readers to the new group at the same time as you create the group.
8. Select the readers to add to the group, then click Add. Your new group appears in the list of groups. 9. After you have created your groups, you can log out of the RFID Management Console by choosing Logout from the menu. Managing RFID Management Console Settings The Settings menu shows the following options: ■ Jini Locators – You can add Jini locators to the Jini lookup server.
▼ To Add a Jini Locator 1. Log in to the RFID Management Console. 2. Choose Administration → Settings. The Jini Locators list appears. 3. Click Add Locator. 4. Type the locator in the format jini://IP-address:port-number. 5. (Optional) Type a description for the locator. 6. Click Save. 90 Sun Java System RFID Software 3.
▼ To Receive Email Notifications for Alerts 1. Log in to the RFID Management Console. 2. Choose Administration → Settings. The Email Notification Configuration dialog box appears. This dialog box appears with the Jini Locator dialog box described in “To Add a Jini Locator” on page 90. 3. Click Modify. The Email Notification Configuration dialog box appears. 4. Type your email server. For example, mail-server.company.com. 5. Type your email address. For example, myname@company.com.
6. Enable the Alerts email notification by typing y in the Email Notification Enabled (y/n) text box. 7. Click Save. You are returned to the original Settings page and receive the following confirmation message. Changing the admin User Password Use the following procedure to change the default password that is used to access the RFID Management Console as the admin user. ▼ To Change the admin User Password 1. Log in to the RFID Management Console as the admin user. 2. Choose Administration → Password.
Performing RFID Reader Network Management Tasks The RFID Management Console provides the following options for managing the RFID reader network. Expand the RFID menu option to see the following links: ■ ■ RFID Readers Components (only available to administrative users) RFID Reader Network Grouping Function The RFID Management Console provides a reader grouping function so that distinct groups of readers can be monitored in a meaningful way.
2. Choose a reader group to view. You see something similar to the following screen capture. In this example one reader is inactive and two readers are active. The delete Action icon is greyed out. ▼ To View Readers Using the RFID Readers View The RFID Readers view enables you to view readers by group and to view and to set the reader attributes. You can quickly view the status of all devices. 1. From the RFID Management Console main menu choose RFID → RFID Readers.
2. To view the readers in a group, click the Inspect icon in the Actions column. For example, if you click the Inspect icon for the All Readers group, the Readers in All Readers group panel appears as shown in the following screen capture. The group has one inactive reader and two active readers. The Actions icons for the inactive readers are greyed out because you cannot inspect them or view their tags when they are inactive.
3. Review the status of the readers in the selected group. The Status icons are described in the following table. TABLE 5-5 Status Indicator Icons for RFID Readers Icon Description The reader is connected. The reader is disconnected. The reader is in the “other” state. The reader is not responding. The reader is inactive. 4. To view reader attributes, click the Inspect icon (see TABLE 5-4) in the Actions column. The RFID Reader Attribute pane appears. 96 Sun Java System RFID Software 3.
5. (Optional) To modify reader properties, follow these steps: a. Scroll to the bottom of the Reader Attribute pane, and click Modify. A pane that shows the modifiable properties appears. b. Type your changes, and click Save.
c. (Optional) Click Refresh to determine if attribute values have changed while you have been reviewing them. 6. (Optional) To view the tags in view of a selected reader, from the Readers in Groups pane (shown in Step 2), click the View Tags icon located in the Actions column. The RFID Tags in View pane appears. ▼ To View RFID Components The components menu option enables you to view all RFID system components, such as filters, connectors, and reader adapters, for each running service.
3. To view the components for a specific service, click the Inspect icon in the Actions column. Each component type is grouped in its own table, similar to the following. 4. (Optional) To view the component properties, click the Inspect icon in the Actions column. For example, the following screen capture shows the properties for the PML_Smoother component.
Monitoring the Status of Your RFID Reader Network By Using Alerts The RFID Management Console enables you to view alerts from the RFID reader network. An alert indicates that one of the RFID readers or other RFID devices is malfunctioning. The red Check Alerts label and the button below it indicate that there are alerts to be viewed. When you review and dismiss the alert from the Alerts display, the alert is archived in a database.
▼ To Create and Use Alert Filters 1. From the RFID Management Console, choose Settings → Alert Filters. A list of the existing filters appears. By default, there is only one filter, the “Last 24 hours” filter. The default state for this filter is OFF, which is indicated by the Status icon, indicated by a red circle with an X. 2. Click Create New Filter. 3. Check the type of filter that you want to create. ■ To create a Date Range filter, follow these steps: a. Type a name for the filter, and click Next.
▼ To View Alerts ■ Click the Check Alerts button found in the upper left-hand corner of the Management Console. The Alerts pane appears showing the alerts for the currently active filter. You see something similar to the following screen capture. 102 Sun Java System RFID Software 3.
▼ To Modify Alert Filters 1. Click the Inspect (magnifying glass) icon next to a filter. The Edit Filter pane appears. 2. Type the new property values, and click Save. ▼ To Delete Alert Filters ● Click the Delete icon (a circle with a minus sign). The filter is immediately deleted. No undo function is available. ▼ To Turn On Alert Filters ● Click the green check icon or the red X icon in the Status column to toggle the filter’s state to on or off.
Sun Java System RFID Software 3.
CHAPTER 6 Sending Events From the RFID Event Manager to the RFID Information Server The easiest way to send the RFID tag events from the RFID Event Manager to a database is to use the Epcis connector (a component of the RFID Event Manager), the RFID Information Server (also known as EPCIS), and an application server. There are other ways to accomplish this task, but they require more programming. The Epcis connector can be used with two protocols: the Java Message Service (JMS) API and HTTP.
■ (Required to use JMS) Configuring the JMS environment – If you are using JMS queues or topics as the message transport protocol between the RFID Event Manager and the RFID Information Server, you must set up the JMS environment. See “Enabling Usage of JMS With the RFID Information Server” on page 106. Enabling Usage of JMS With the RFID Information Server Sun Java System Application Server 8.
RFID Information Server clients can be configured to use the JMS interface using a file system JNDI provider (Java Naming and Directory Interface). This section include the following topics: ■ ■ Sun Java System Message Queue Documentation Enabling Usage of JMS with Sun Java System Application Server 8.1 Sun Java System Message Queue Documentation The Sun Java System Message Queue 3 2005Q4 Administration Guide can be found at http://docs.sun.com/app/docs/doc/819-2571.
RFID Event Manager PML/HTTP Port 80 EpcisHttp Connector RFID Reader Adapter JMS (Queue Port 7676 or Topic) Filter PML/JMS Port 7676 EPC Tag RFID Information Server EpcisJms Connector JNDI Lookup Java System Message Queue Queues 1:1 epcisQueue Topics 1:Many epcisTopic JNDI Repository (Using File System) jms/epcisQueue --> epcisQueue jms/epcisTopic --> epcisTopic jms/TopicFactory --> host:port jms/QueueFactory --> host:port The procedures in this chapter show screen captures using Application Ser
1. Start the application server default server instance. 2. Log in to the application server admin console. 3. Choose Resources → JMS Resources → Connection Factories. Confirm that the jms/QueueConnectionFactory and jsm/TopicConnectionFactory nodes are present as shown in the following screen capture. 4. Choose Resources → JMS Resources → Destination Resources nodes. Confirm that the jms/epcisTopic and jsm/epcisQueue nodes are present as shown in the following screen capture.
Note – This example uses the Sun Java System Message Queue that is installed as part of the Sun Java System Application Server 8.1 installation. 1. Start the Message Queue admin console. These examples use the default Application Server installation directory for each platform.
4. Add a new broker by following these steps: a. In the Broker Label field, type a name for your broker. For this example, type TestRFIDBroker. a. In the Host field, type the IP address of the machine where your Message Queue server is installed. In this example, this is the system where Application Server is installed. b. In the Primary Port field, confirm the default value of 7676. c. Type the Message Queue admin username and password. The admin username and password is admin. d. Click OK.
5. Right-click the new Broker icon in the navigation tree and choose Connect to Broker. For this example, right-click TestRFIDBroker. The destinations match the destinations that you viewed in the Application Server JMS Resources. ▼ To Add an Object Store for RFID Information Server From the Message Queue admin console, add a new Object Store by following these steps: 112 Sun Java System RFID Software 3.
1. Select the Object Stores node in the navigation tree. 2. From the menu, choose Actions → Add Object Store. The Add Object Store dialog box appears and enables you to add the necessary JNDI Naming Server Properties. The following screen capture shows the JNDI Naming Server Properties drop-down list. 3. Add the following fields: Object Store Property Name Example Value java.naming.factory.initial com.sun.jndi.fscontext.RefFSContextFactory java.naming.provider.
6. Right-click the new Object Store node in the navigation tree and choose Connect to Object Store. You should see a successful connection. ▼ To Add a Topic Connection Factory From the Message Queue admin console, add a new connection factory for the epcisTopic by following these steps: 1. Select the Connection Factories node in the navigation tree. 2. From the menu, choose Actions → Add Connection Factory Object. The Add Connection Factory Object dialog box appears.
3. Type the Lookup Name. For this example, use TopicConnectionFactory. 4. In the Factory Type field, select TopicConnectionFactory from the drop-down list. 5. Select the 3.0 Connection Handling tab and complete the fields as shown in the following screen capture. In the fields, Broker Host Name and HTTP URL, replace localhost with the name of the machine where your Message Queue broker resides.
6. Click OK. The topic connection factory object is added to the object store. ▼ To Add a Queue Connection Factory 1. Select the Connection Factories node in the navigation tree. 2. From the menu, choose Actions → Add Connection Factory Object. The Add Connection Factory Object dialog box appears. 3. Type the Lookup Name. For this example, use QueueConnectionFactory. 4. In the Factory Type field, select QueueConnectionFactory from the drop-down list. 5. Select the 3.
6. Click OK. The new queue connection factory object is added to the object store. ▼ To Add the EPCIS Destination Objects 1. Select the Destinations node in the navigation tree. 2. From the menu, choose Actions → Add Destination Object. The Add Destination Object dialog box appears. 3. Add both a topic and a queue destination object as shown in the following screen captures.
4. Confirm that your new object store appears similar to the following screen capture. 118 Sun Java System RFID Software 3.
5. When you are finished, exit the Message Queue Admin Console. You have completed the JMS configuration for your system. Now, you must configure the RFID Event Manager to send the tag events to the RFID Information Server. See “Configuring the RFID Event Manager to Use an EpcisJms Connector” on page 119. Configuring the RFID Event Manager to Use an EpcisJms Connector The following procedures use the RFID Configuration Manager, a component of the RFID Event Manager.
▼ To Define the EpcisJms Connector Role Use these steps to define a new role that uses the EpcisJms connector. A role specifies a series of filters and connectors that receive tag events and pass them to a listener application. In this example, the Westerner is the RFID Information Server. Roles are described in Chapter 2 of this guide. Review “To Define RFID Event Manager Roles” on page 30 if you have not used the RFID Configuration Manager previously.
4. Click the Add a connector icon (looks like a roll of film) and select EpcisJms from the list. 5. Type a name and click OK. For the example, type JMSConnector. The Epcis connector named JMSConnector appears in the drawing pane.
6. Right-click the connector (move the cursor over the small square at the center of the Connector symbol) and select Edit. The Connector Details dialog appears. 7. Confirm that the Configuration Properties fields contain the correct values for your JMS configuration and click OK. The values of the java.naming properties must match the values in your JNDI object store as shown in the following table. Configuration Property Name Value java.naming.factory.initial com.sun.jndi.fscontext.
8. Add a Delta filter by using the Add a filter icon (looks like a meter). You must use a Delta filter to feed the tag events to the EpcisJms connector. If you do not add the Delta filter to this role, the tag events are ignored by the connector. 9. Type a name for your Delta filter and click OK. 10. Add a Smoothing filter by using the Add a filter icon (looks like a meter). 11. Type a name for your Smoothing filter and click OK. The drawing pane appears similar to the following screen capture. 12.
Note – The drawing pane icons are described in TABLE 2-1. Your drawing pane appears similar to the following screen capture. 17. Click Close. Your work is not yet saved. To save your work at this time, choose File → Save from the RFID Configuration Manager main menu. 18. You must complete the following procedure to configure the EpcisJMS configuration object. 124 Sun Java System RFID Software 3.
▼ To Create the EpcisJms Configuration Object 1. Choose Configuration → New. The Select the Base Role dialog box appears. 2. Select the role, JMS Message for IS, that you defined in the previous procedure and click OK. The Configuration Object properties dialog appears. Notice that there are three tabs corresponding to the components that you defined in the JMS Message for IS role. 3. Type a name in the Configuration Object Name field. For this example, type JMSConfigObject. 4.
▼ To Test the EpcisJms Connector 1. Start or restart your application server. 2. Start or restart the RFID Event Manager. Each time you change a configuration object, the RFID Event Manager must be restarted in order for the changes to take effect. Wait until the system is completely started or you may lose tag events. Depending on the components you used in your role, the RFID Tag Viewer may or may not appear (it depends on the objects in your role).
Configuring the RFID Event Manager to Use an EpcisHttp Connector To use HTTP to communicate with the RFID Information Server, use an EpcisHttp connector. The tasks for configuring an EpcisHttp connector are similar to configuring a EpcisJms connector, except you do not need to do the JMS configuration.
▼ To Define the Epcis Connector Role 1. Start the RFID Configuration Manager. 2. Choose Roles → New. The Select a Role dialog appears. 3. Type the new role name and click Ok. For this example, type testEpcisHttpRole. 4. Click the Add a connector icon (looks like a roll of film) and select EpcisHttp from the list. 5. Type a name and click OK. 6. To edit/confirm the properties, right-click the connector and choose Edit. Move the cursor over the port (the small square at the center of the connector object).
8. Add a Smoothing filter and a Delta filter. See Step 8 through Step 11 in “To Define the EpcisJms Connector Role” on page 120. 9. Right-click the Smoothing filter and choose Create Input from the context menu. 10. To connect everything together, click the port (small square) at the center of the input and drag it to the Smoothing filter. 11. Click the port of the Smoothing filter and drag it to the Delta filter. 12. Click the port of the Delta filter and drag it to the EpcisHttpConnector. 13.
14. Click close and proceed to the next procedure, Your work is not yet saved. Do not exit the RFID Configuration Manager without saving your work. ▼ To Create the EpcisHttp Configuration Object 1. Start the RFID Configuration Manager. 2. If the drawing pane displays the default Demo configuration object, delete it following these steps. a. Select the Demo configuration object. b. Choose Configuration → Delete. 3. Choose Configuration → New. The Select the Base Role dialog box appears.
4. For this example, select the role, testEpcisHttpRole, that you defined in the previous procedure and click OK. The Configuration Object properties dialog appears. Notice that there are three tabs corresponding to the components that you defined in the role. 5. Type a name in the Configuration Object Name field. For this example, type HTTPConfigObject. 6. To configure the input point for the configuration object, select a reader by following these steps: a. Click Select a Reader. b.
3. Start the RFID Tag Viewer from the command line using the following options. tagviewer -p PMLReader You should see tags appearing in the RFID Tag Viewer. 4. After a few seconds, you can stop the PML Reader. 5. (Optional) To verify that events are flowing from the RFID Event Manager to the RFID Information Server, follow these steps: a. In your web browser, access the RFID Information Server index page by typing the EPCIS URL. For example, http://localhost/epcis. b.
CHAPTER 7 Sun Java System RFID Information Server Configuration The Sun Java System RFID Information Server (RFID Information Server) is a Java 2 Platform, Enterprise Edition (J2EE™) application that serves as an interface for the storage and query of the tag data captured by RFID readers. The RFID Information Server is typically used to translate a set of low-level observations into higher-level business functions.
Client Application RFIDIS Java Client Library epcis-client.jar FIGURE 7-1 XML/HTTP XML/JMS RFID Information Server RDBMS Sun Java System RFID Information Server Alternatively, you can consider the EPC-related tag data as being either static or timestamped. Static data includes the serial-level and product-level properties of tagged items, such as the GTIN number of a box of detergent. Timestamped data is collected over a period of time and typically changes more often than static data.
■ Sensors – The SENSOR table lists all the RFID readers and antennas in use in the RFID sensor network. ■ Tag observations – Observations are generated by RFID readers and captured in two tables in the RFID Information Server. The CURRENT_OBSERVATION table captures the output of a Delta filter. The purpose of this filter is to capture the currently visible EPC tags at any particular sensor. The OBSERVATION_LOG table captures the history of all tag observations.
Configuring the RFID Information Server Database This section describes RFID Information Server database configuration information. The following topics are described: ■ ■ Database Schema Description Configuring the Logging Parameters Database Schema Description The EpcisDbSchema.xml file describes the database schema in a databaseindependent manner. This schema is used by the client and the server to perform type checking and data validation at run time.
▼ To Modify the RFID Information Server Database Schema File 1. Save a copy of EpcisDbSchema.xml in a permanent location. 2. Modify the file to add or delete extended attributes. 3. Copy the modified file to the document root of the application server. 4. Restart the application server. Caution – The EpcisDbSchema.xml file is intended to be modified once at deployment. If changes are made to the file after the database has been populated, the result might be inconsistent data in the database.
▼ To Add Extended Attributes Using the Template 1. Enter the name of the attribute in the name and dbName tags. 2. Enter the type of the attribute. The type can be one of: STRING, FLOAT, LONG, TIMESTAMP, INTEGER or BOOLEAN The paramNum tag is always 3. Configuring the Logging Parameters The logging parameters are set using Application Server’s administration interface. Refer to the Application Server administration guide for more details.
Configuring RFID Information Server Clients The RFID Information Server client library (shown in FIGURE 7-1 as “EPCIS Java Client Library”) requires two Java system properties. ■ rfidis.db.schema – Specifies the HTTP URL to the EpcisDbSchema.xml file ■ java.util.logging.config.file – Specifies the path to the client logging properties file ▼ To Add the Java System Properties 1. From the Application Server Admin Console, choose Application Server → JVM Settings → JVM Options. 2. Click Add JVM Option. 3.
Securing the RFID Information Server Using the Application Server Admin Console, you can manage user access to the RFID Information Server. Basic user authentication is the first step to securing the RFID Information Server. Component level security encompasses web components and EJB components. A secure web container authenticates users and authorizes access to a servlet or JSP by using the security policy defined in the servlet XML deployment descriptors (web.xml and sun-web.xml files).
APPENDIX A RFID Device Adapter Reference This appendix describes the supported RFID device profiles (also known as adapters) and their properties. This information can be seen and modified using the RFID Configuration Manager. See “Managing Device Profiles” on page 46 for procedures. The following tables list the properties (also known as attributes), a description and the valid values.
TABLE A-1 Adapter Properties for the AWID MPR-2010 Reader (Continued) Property Name Description Values Common Properties See TABLE 2-4 for general description and values.
TABLE A-1 Adapter Properties for the AWID MPR-2010 Reader (Continued) Property Name Description Values writeEPCRetry Number of tries to write before returning. 1 – Default = 1 0 – Write until complete sleeptime The sleep time between reads in milliseconds. Default = 250 msec gatherUserData If true, reads the user data in the transponder (RFID tag) and associates it with the identifier during the inventory round.
TABLE A-2 Adapter Properties for the Feig LRU1000 Readers (Continued) Property Name Description Values Additional Properties . antennaSequence A list of which antenna ports have antennas connected. One or more comma-separated port numbers. For example, 1,2,4 tagIdRepresentation Specifies the encoding to use for interpreting the ID on the tag. Values are: • ISO • EPC Default value is EPC. protocolType Specifies which air interface protocol to activate.
TABLE A-3 Adapter Properties for the Feig ISCMR100/PR100 Readers (Continued) Property Name Description Values readerepc autoread communicationTimeout scanDuration Adapter for Intermec IF5 Readers This adapter is used to communicate with Intermec Intellitag IF5 readers. The adapter properties are shown in the following table. TABLE A-4 Adapter Properties for the Intermec Intelligtag IF5 Reader Property Name Description Values Name Unique name identifying this adapter.
TABLE A-4 Adapter Properties for the Intermec Intelligtag IF5 Reader (Continued) Property Name Description Values Default value is 500 msec scanDuration Additional Properties The type of transponder (RFID tag) the reader expects. Only one value is valid at a time. tagType The valid types are the following: • MIXED – ISO G1, G2, AND V1.19 • ISO6BG1 – ISO6B G1 • ISO6BG2 – ISO6B G2 • ISO6C – The ISO equivalent to EPCglobal UHF Gen 2 • ICODE119 – Phillips v1.
TABLE A-5 Adapter Properties for the PMLReader (Continued) Name Description Values Must match the corresponding entry in the Simulator.properties of the PMLReader. readerepc PMLReader supports autoread mode. autoread Setting this property to true causes the PMLReader to begin generating simulated RFID events. scanDuration Adapter for Alien Readers This adapter communicates with the Alien ALR-9780 or Alien NanoScanner 915 RFID readers. The adapter properties are shown in the following table.
TABLE A-6 148 Adapter Properties for the Alien Reader (Continued) Property Name Description Values Additional Properties Also see “Additional Properties Information for Alien Reader” on page 149. readerepcANT0, readerepcANT1, and so on. The EPC identifier associated with antenna 0, 1, 2 or 3 of the reader. antennaSequence Specifies the order in which antennae are read. This property must be set to enable the various antennae.
Additional Properties Information for Alien Reader ■ readerepcANT0, readerepcANT1 – This property overrides the value specified by the readerepc property for this particular antenna. (The readerepc property applies to the entire system as long as an EPC has not been specified for a particular antenna.) This property enables the events from two or more antennae from a single reader to be handled by two or more separate processing chains of filters and connectors.
TABLE A-7 Adapter Properties for the Mercury 3 and Agile 1 Readers (Continued) Name Description Values readerepc autoread communicationTimeout scanDuration Additional Properties Also see “Additional Properties Information for Mercury 3 and Agile 1 Reader” on page 150. protocol Use this property to specify the protocol to be used during data capture. At this time, only one protocol can be active at a time. readerepcUHF1, readerepcUHF2, and so on. readerepcUHF1 specifies the EPC for antenna UHF1.
Note – It is not necessary to set the antenna property to enable the various antennae. Setting the EPC identifier for the antenna instructs the RFID Event Manager to discriminate between the antennae if they are enabled. Enabling a specific antenna is done through the use of the antenna property.
TABLE A-8 Adapter Properties for Mercury4 and Agile 2 Readers (Continued) Property Name Description Values default = 80 port readerepc autoread communicationTimeo ut scanDuration Additional Properties Also see “Additional Properties Information for Mercury 3 and Agile 1 Reader” on page 150. protocol Use this property to specify the protocol to be used during data capture.
Note – The use of a serial to network (Ethernet) adapter is required. TABLE A-9 Adapter Properties for the Matrics Reader Property Name Description Values Name Unique name identifying this adapter. Sample name = MatricsReader classname Java class name. com.sun.autoid.adapter.matrics.
TABLE A-9 Adapter Properties for the Matrics Reader (Continued) Property Name Description Values Antennan Specifies whether a particular antenna is to be used where n, indicates the number of the antenna. This readers supports antenna 1-4. A value of 1 means it is to be used. A value of zero means it is to be inhibited.
readerepcANT0 corresponds to physical antenna 1, readerepcANT1 corresponds to antenna 2, readerepcANT2 corresponds to antenna 3, and readerepcANT3 corresponds to antenna 4. Note – It is necessary to set the antennan (where n is the number of the antenna) property to 1 to enable the use of antenna 1. Setting the EPC identifier for antenna 1 tells the RFID Event Manager to discriminate between the antennae if they are enabled, but enabling the antenna is done through the use of the antennan property.
In an environment where tags move in and out of the read field of a reader, it is important to read as fast as possible to be able to start negotiating with new tags coming into the read field. That is why in dynamic environments the variable is usually small. The environment property is dependent on the location of the system. Generally, it is safe to start with the smallest value (00 for dynamic, 04 for static) to evaluate the performance.
Adapter for Printronix RFID Printers This adapter is used to communicate with the Printronix SL 5000e RFID printer. The adapter properties are shown in following table. TABLE A-10 Adapter Properties for the Printronix SL 5000e RFID Printer Name Description Values Name Unique name identifying this adapter. Sample name = PrintronixPrinter classname Java class name. com.sun.autoid.adapter.printronix.
Adapter for SAMSys Readers This adapter is used to communicate with the SAMSys MP9320 EPC V2.7 Reader. The adapter properties are shown in the following table. TABLE A-11 Adapter Properties for the SAMSys Reader Name Description Values Name Unique name identifying this adapter. Sample value = SAMSysReader classname Java class name. com.sun.autoid.adapter. SAMSys.
TABLE A-11 Adapter Properties for the SAMSys Reader (Continued) Name Description Values protocols Specifies the type of RF protocol to be scanned for by the reader. When no protocols property is defined, the settings on the reader are used without modification. The reader can scan for multiple types simultaneously. Multiple protocols can be specified by using a commaseparated list such as, [IS186B,EPC1]. Tested values are IS186B and EPC1.
TABLE A-11 160 Adapter Properties for the SAMSys Reader (Continued) Name Description Values antennanPower Specifies the preferred power level, where the variable n designates the antenna number. Values can be entered as hexadecimal or decimal digits. Hexadecimal values must be prefixed with the characters 0x. The following example sets the same power levels for both antenna 1 and antenna 2.
Additional Properties Information for SAMSys Reader ■ communicationTimeout – This property is used exclusively for all commands and responses on the device, except tag read commands and the respective responses. The property defines the inactivity threshold for reader responses. Performance can be highly dependent on this property, therefore reduce it from the default value of 10000 msec (10 seconds).
■ ■ For ISO 18000-6B, Intermec Intellitag, Philips I-CODE HSL, the value is IS186B. ■ For Alien EPC, the value is EPC1. ■ For EM 4022, EM4222 the value is STG. ■ For EPC0, the value is EPC0. readerepcANTn – Specifies the EPC value associated with the ANT1, ANT2, ANT3, and ANT4 antennae of the reader, where the variable n equals the number of the antenna. This property overrides the value specified by readerepc for this particular antenna.
direction of SAMSys personnel. See the SAMSys Comprehensive Heuristic Unified Messaging Protocol in the SAMSys documentation for more detailed information. Adapter for Symbol MC9000-G Readers This adapter communicates with a custom software program hosted on the Symbol MC9000 device. This adapter opens a server socket over TCP and listens for connections from the Symbol MC9000-G device.
In this example, the adapter receives three class 1, 64-bit EPC tags from the reader. The first tag was detected once, the second tag was detected three times, and the third tag was detected fifteen times. In release 3.0 , the time that the tag was read is used as the current time. The adapter ignores the count and class type, which are not passed up stream to the event listeners. Any application hosted on the Symbol MC9000-G device that conforms to this protocol will suffice.
TABLE A-13 Adapter Properties for the Symbol MC9000-G Reader (Continued) Name Description Values port Specifies the port on which to create a server socket. Default = 59000 Default = 15,000 msecs scanDuration This property indicates the data format. Currently, this adapter supports only the comma-separated values (CSV) format described above. datafmt Adapter for Zebra Technologies Printers This adapter is used to communicate with the Zebra Technologies R110XiIIIPlus Printer.
TABLE A-14 166 Adapter Properties for Zebra Technologies RFID Printer (Continued) Name Description Additional Properties . template Specifies the location of the default print template. /tmp/templatefile.txt template.variable Template identified by the variable. There can be zero or more occurences of this property, each with a unique substitution for variable. The value can be either a URL or a local file. For example, if the property name = template.case, then the value = /tmp/templatecase.
APPENDIX 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” on page 30.
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 168 Smoothing Filter Properties Property Description Value classname Java class name. com.sun.autoid.filter.
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.
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 170 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.
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.
FileLogger Connector This component provides a general connector for the RFID Event Manager and writes PML core to an output file. TABLE B-5 172 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.
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.
JMSLogger Connector This component provides a connector that sends PML core events using a JMS Message. TABLE B-7 174 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.
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.
SocketLogger Connector This component creates a socket connection and starts writing PML core to the connection. TABLE B-9 176 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.
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.
SAPAII Connector See “Architecture Overview of the RFID Software Plug-In for SAP AII” on page 62. 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.
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.
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 180 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.
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” on page 119. TABLE B-14 EpcisJms Connector Properties Property Description classname com.sun.autoid.logger.
TABLE B-14 182 EpcisJms Connector Properties (Continued) Property Description 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.
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” on page 127. TABLE B-15 EpcisHttp Connector Properties Property Description classname com.sun.autoid.logger.
TABLE B-15 184 EpcisHttp Connector Properties (Continued) Property Description 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.
APPENDIX C RFID Configuration File Reference This appendix provides sample configuration files for the configuration of an Execution Agent. The configuration is contained in an XML configuration file for each Execution Agent. It might be necessary to create and edit these configuration files manually. By default, the RFID Event Manager is configured to run with one Execution Agent.
FIGURE C-1 Configuration File Hierarchy The name and value properties used are case sensitive. For instance, a value of EPC is treated differently from Epc. Properties appropriate to each of the configurable entities (adapters, filters and connectors) are shown in other appendices in this book. 186 ■ Refer to Appendix A for properties information for the supported reader adapters.
CODE EXAMPLE C-1 Sample XML for a Reader Adapter PMLReader com.sun.autoid.adapter.pml.
TABLE C-1 Sample xml Code for a Filter RfidSmoother com.sun.autoid.filter.
Index A adapters configuring, 46 reference, 141 adding configuration properties, 28 custom components, 55 JMS broker, 109 JMS connection factory, 114 JMS object store, 112 JMS queue connection factory, 116 alerts creating filters, 101 email notifications, 91 Alien readers adapter properties, 147 AWID readers adapter properties, 141 C changing configuration objects, 43 deployment parameters, 24 Jini group, 24 reader properties, 51 components custom, 55 definition, 19 configuration objects changing, 43 SAP
EpcisHttp connector, 127 java client library, 139 event manager components defined, 19 configuring, 17 to 55 starting, 45 M Feig readers adapter properties, 143 filters custom, 55 definition, 19 management console overview, 81 password, 82, 92 starting, 82 users, 84 viewing readers, 93, 94 Matrics readers adapter properties, 153 message queue documentation, 107 monitoring reader network, 100 G P group see Jini group passwords management console, 82, 92 PMLReader, 47 printers configuring, 25 Printroni
Rio Webster port number, 24 roles defining, 30 S SAMSys readers adapter properties, 158 SAP AII configuring, 77 connection parameters, 69 defining configuration objects, 73 defining devices, 65 plug-in, 61 to 79 Sensormatic readers adapter properties, 151 SSocket adapter adapter properties, 164 starting configuration manager, 22 event manager, 45 management console, 82 Symbol readers adapter properties, 164 T ThingMagic readers adapter properties, 149, 151 transport protocols HTTP, 105 JMS, 105 W web ser
Sun Java System RFID Software 3.
