The Reporting Reusable Component queries the back-end system
for tag and location history based on previously observed events.
The output attributes for the Reporting Reusable Component are
an array of maps. Each map includes name-value pairs pulled from the
recorded observation events for the specified tag or location. These
generally include tag, location, timestamp, eventId, eventType, and
any metadata.
If the tag or location filter is left blank, all recorded observation
events will be returned.
In order to reduce the massive amount of data that could be returned
from a call to the Reporting Reusable Component, the startTime and endTime parameters
are allowed. Either or both of these can be null or empty if time
filtering is not desired.
The filter eventCountLimit : number is
supported as an optional agent property. Use this property to limit
the total size of the array of maps returned by the queries to number.
WebSphere Premises Server configuration
Table 1. Reporting agent propertiesName |
Description |
PID |
Agent properties |
ReportingAgent |
RUC Reporting Agent |
com.ibm.premises.reusable.reporting.ReportingAgent |
- ruc.targetBackend=ruc.epcis
- bytag.output.success=rucresponse/reporting/bytag/success
- bytag.output.failure=rucresponse/reporting/bytag/failure
- byloc.output.success=rucresponse/reporting/byloc/success
- byloc.output.failure=rucresponse/reporting/byloc/failure
- eventCountLimit=number
|
WebSphere Application Server configuration
Table 2. Activation specification valuesName |
JNDI name |
Destination type |
Destination JNDI name |
Message selector |
Bus name |
ReportingRUCAS |
eis/ReportingRUCAS |
Topic |
jms/ibmse |
ibmse LIKE ‘rucaction/reporting/%’ OR ibmse
LIKE ‘%/rucaction/reporting/%’ |
ibmsensorevent |
Methods
- (Map[]) getTagLocationHistory(String tag) (Exposed
as Web service)
- (Map[]) getTagLocationHistory(String tag, String startTime,
String endTime) (Exposed as Web service)
- (Map[]) getLocationTagHistory(String location) (Exposed
as Web service)
- (Map[]) getLocationTagHistory(String location, String
startTime, String endTime) (Exposed as Web service)
Using the Reporting Reusable Component
It
is recommended to invoke the methods using stateless session beans
or a Web service by passing the following parameters:
- startTime
- Sets a start time for reporting tag and location history. String
xsd:dateTime [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]
- endTime
- Sets a end time for reporting tag and location history. String
xsd:dateTime [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]
To invoke the Reporting Reusable Component using IBM® Sensor Events or XML, the payload
must include:
- PassiveRFIDTagRead
- PassiveRFIDAggregatedTagRead
Generic payload created from a map can also be used. It must
include either of the following:
- ReportingRUCConstants.TAG_KEY_INOUT
- ReportingRUCConstants.TAGLIST_KEY_INOUT
Note: TAG_KEY_INOUT takes
a String value. TAGLIST_KEY_INOUT takes
a value of java.util.List populated with Strings.
To
invoke
getLocationTagHistory/byloc, either the payload
or payloadMetadata must include:
- ReportingRUCConstants.BIZLOCATION_KEY_OUT
To publish to Reusable Components MDBs, set the following
values for the JMS topic and eventType. For multi-action Reusable
Components, the topic is checked in the message selector and in the
MDB code.
- getTagLocationHistory: profileid/rucaction/reporting/bytag
- getLocationTagHistory: profileid/rucaction/reporting/byloc
The JMS topic and eventType for the MDB output from the Reusable
Component comes from the agent properties. Default output topics for
success and failure for each action are shown in Table 1. The payload
includes a group with the name
ReportingRUCConstants.REP_RUC_RESULTMAPLIST_KEY_OUT with
a counter appended for every event map returned. For example:
- com.ibm.premises.reusable.reporting.result1 ->
Map1
- com.ibm.premises.reusable.reporting.result2 ->
Map2
- com.ibm.premises.reusable.reporting.result3 ->
Map3