WebSphere brand IBM WebSphere Sensor Events, Version 6.2

WBE agent

The WBE agent allows WebSphere® Sensor Events application developers to forward tag read events to WebSphere Business Events to be processed by the rules engine.

Properties

There are common properties shared by all Reusable Component agent. For more details on these properties, see the WebSphere Sensor Events Toolkit documentation.

Table 1. Common Reusable Component agent properties
Property Description
action-name.output.success The topic to use for a response from the message-driven bean (MDB) when an action is successful.
action-name.output.failure The topic to use a response from the MDB when an action is unsuccessful.
ruc.targetBackend This property defines the target interface or enterprise application that contains the Reusable Component implementation logic, such as ruc.epcis, ruc.wse, ruc.its, ruc.db, or ruc.custom.
ruc.targetBackendJNDI This property is used when you have a custom back-end implementation (ruc.custom). Use this property to point to the new back-end EJB.

The possible values for action-name for the WBE agent properties are:

Table 2. Additional WBE agent properties
Property Description
include.location.context This property determines whether to include location context (metadata) in the agent event that is stored in the sage.objectinstancemetadata table when the event is generated. The possible values are true to include, or false to exclude. The default value is false.
publish.outbound.topic The name of the event template defined in the WebSphere Sensor Events server that will publish the event.
publish.outbound.parameter.key The property key used when building the outbound topic. It is added to the publish.outbound.topic value.
wbe.local.jms.topic This property is the JMS topic used by WebSphere Business Events. It is only valid when the wbe.location property is set to local, otherwise, it is ignored. When WebSphere Business Events is running on the same WebSphere Application Server instance (local), this agent publishes the WebSphere Business Events event packet on this topic directly to the WbeBus using the connection factory, jms/WbeTopicConnectionFactory. This topic is the JNDI name of the event topic for WebSphere Application Server.

The default is jms/eventTopic.

wbe.location Location of WebSphere Business Events. Values are local or remote. When set to local, WebSphere Business Events and WebSphere Sensor Events are installed on the same WebSphere Application Server instance. When the value is set to remote, the products are using different instances of WebSphere Application Server.
wbe.port Port used by WebSphere Business Events. The default value is 9080.

This property is only valid when the wbe.location property is set to remote, otherwise, it is ignored. When WebSphere Business Events is not running on the same WebSphere Application Server instance as WebSphere Sensor Events, then the agent delivers WebSphere Business Events event packets using HTTP over this port.

wbe.url URL of WebSphere Business Events.

This property is only valid when the wbe.location property is set to remote, otherwise, it is ignored. When WebSphere Business Events is not running on the same WebSphere Application Server instance as WebSphere Sensor Events, then the agent delivers WebSphere Business Events event packets using HTTP to this URL.

This URL should use the host name or IP address of the remote server. This property should not include the port number. The port number is defined in the wbe.port property settings.

wbe.version Version of WebSphere Business Events. Valid values are 6.1 or 6.2.

WebSphere Business Events 6.1 and 6.2 use different event packet formats. For compatibility with WebSphere Business Events 6.1 set this property to 6.1, otherwise, keep the default value of 6.2.

wbe.xsltransform This property is a URL to an XSL transformation used by WebSphere Business Events. The value can be set to none.

If this property is specified the WBE agent will not perform any conversions. The transformation is expected to convert the inbound XML to a WebSphere Business Events event packet. If the conversion is successful, then the agent will forward the result to WebSphere Business Events without any further modifications.

wbe.eventname This property allows you to set the event name that will be used when generating the WebSphere Business Events event packet. This property is static and every event being sent to WebSphere Business Events will have the same event name. If the application requires this name to be dynamic, the same property can be set in the payload metadata of the IBMSensorEvent. If the property is in the payload metadata of the event it will override the property value defined in the WBE agent properties.
For known WebSphere Sensor Events system event types, the default event names are:
  • PassiveRFIDTagRead = WSE_PassiveRFIDTagRead
  • PassiveRFIDAggregatedTagRead = WSE_PassiveRFIDAggregatedTagRead
  • Heartbeat = WSE_Heartbeat
  • Alert Error = WSE_AlertError
  • Alert Warning = WSE_AlertWarning
  • Alert Info = WSE_AlertInfo
  • PortalCommand = WSE_PortalCommand
  • Reload = WSE_Reload
  • Restart = WSE_Restart
  • Application Ping = WSE_ApplicationPing
  • Application Pong = WSE_ApplicationPong
  • PortalReport = WSE_PortalReport
  • TagReadFeedback = WSE_TagReadFeedback

For user defined event types the default value is: WSE_IBMSensorEvent


Library | Support | Terms of use

(c) Copyright IBM Corporation 2004, 2009. All rights reserved.
U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.