Edgeflow Reference

Edgeflow Module Reference

This section describes reference information for the WebLogic RFID Edge Server edgeflow modules.

You may notice similarities across modules. Each module requires parameters for operation (which can include information such as timing data and EPCIS data) and parameters that allow it to connect to other modules and send data to outside destinations.

You configure edgeflow modules using the RFID Edge Server Administration Console. See Configuring Workflow Modules in Using the Administration Console.

The following edgeflow modules are described:

Aggregation Reconciler

An Aggregation Reconciler module receives an aggregation event and sends to an external sender to request the manifest for the aggregation.

The Aggregation Reconciler module can be used to find out if an aggregation has the expected items or not. The Aggregation Reconciler module compares an aggregation with its manifest (expected elements in an aggregation). The comparison result is based on the properties such as percentage of children-match required.

Consider the following usage:

The Aggregation Reconciler module fields are shown in Table 3-1.

Bar Code Decoder

This module takes in a bar code string or bar code Tag List and converts it to an EPC ID or EPC ID pattern.

For example, you might use an HTTP Receiver (One Way) module to receive bar codes from an external source, or you might receive a bar code tag list from a Tag List Filter module that itself receives ECReports for an ECSpec configured to read from a bar code reader.

This module supports the following bar code types:

Table 3-2 describes how bar codes are processed based on the number of digits in the bar code.

The Bar Code Decoder module fields are shown in Table 3-3.

Counter

This module is used to display a count, or similar information on a numeric display device.

For example, you can use the output of a Tag Accumulator module with a Counter module to get a count of EPCs seen.

The Counter module fields are shown in Table 3-4.

Directional Filter

You can use this module to determine the direction in which an EPC is moving. Specifically, the module is used to determine the direction between two points.

This module is similar to the Directional Filter (Auto Configuration) module. However, in this module the user is responsible for defining the ECSpec and its subscriptions.

The Directional Filter module fields are shown in Table 3-5.

Directional Filter (Auto Configuration)

Use this module to determine the direction in which an EPC is moving. The module can be used to determine the direction between two points.

The module creates an ECSpec for the read points and subscribes itself to receive notifications of EPC sightings. Logical reader names are required to be configured for each side.

The Directional Filter module fields are shown in Table 3-6.

ECSpec Subscriber

Use this module to subscribe to ECSpecs only when needed: ECSpecs do not stay active.

The ECSpec names parameter allows you to specify from which ECSpecs this module should get ECReports.

A subscribe request adds a subscription for itself for an ECSpec; an unsubscribe request removes the subscription from the ECSpec.

The ECSpec Subscriber module fields are shown in Table 3-7.

EPC Cache Manager

An EPC cache is an ordered list of EPC values used in sequence to program tags. An EPC cache allows a series of tags to be programmed without application intervention or extra tag programming to supply new EPC codes.

You can use this module to create and manage a cache. The configuration values are specific to the caches managed by this module. This module will:

For example, you might use the EPC Cache Manager together with the Serial Number Replenisher (Static) module (or a Serial Number Replenisher (BEA Service) module) as follows:

The EPC Cache Manager module fields are shown in Table 3-8.

EPCIS Aggregation Event Generator

You can use this module to generate an EPCIS aggregation event for a given set of EPCs.

An EPCIS event is an observation of EPC-related activity, expressed at the business level. EPCIS events typically have four informational aspects: what (which EPCs or other entities participated in the event), when (the date and time of the event), where (the location where the event took place and where the entities are expected to be afterward), and why (what business transaction was taking place and what is the business condition of the entities afterward).

Consider the following usage:

The EPCIS Aggregation Event Generator module fields are shown in Table 3-9.

EPCIS Manifest Query

This module gets a manifest, which specifies what the content of an aggregation should be, from an EPCIS repository. It determines the manifest based on the latest ADD and DELETE aggregation event for the parent ID on the input aggregation.

When the exact IDs expected in an aggregation are known, the URI is the EPC ID. If only the item type is known, the URI is an EPC ID Pattern identifying the type. The module produces an error if the (input) aggregation does not have a parent ID.

The EPCIS Manifest Query module fields are shown in Table 3-10. The generated manifest is a map from URI to the expected-count for the URI.

EPCIS Object Event Generator

This module is used to generate an EPCIS Object Event from a given list of EPCs.

An EPCIS event is an observation of EPC-related activity, expressed at the business level. EPCIS events typically have four informational aspects: what (which EPCs or other entities participated in the event), when (the date and time of the event), where (the location where the event took place and where the entities are expected to be afterward), and why (what business transaction was taking place and what is the business condition of the entities afterward).

You might use a Directional Filter module or output from a Tag List Filter module to send the A to B Tag List to the Object Event Generator module. The generated EPCIS object event may be sent to an EPCIS system.

The EPCIS Object Event Generator module fields are shown in Table 3-11.

External Sender

This module is used to send a message from edgeflow modules to external destinations.

This module has one input port, Input, which takes messages of any type and processes them as follows:

The External Sender module fields are shown in Table 3-12.

HTTP Receiver (One Way)

You use the HTTP Receiver (One Way) module to send messages from external systems to edgeflow modules. The full URL specifies the target module and input port. The HTTP client will receive a response whether the message was delivered to the target module or not.

The HTTP Receiver module fields are shown in Table 3-13.

HTTP Receiver (Request Response)

You can use the HTTP Receiver (Request Response) module to send a message to any module port and return the output from that module (or another module) in the response. The HTTP client will receive a response whether the message was delivered to the target module or not.

The HTTP Receiver (Request Response) module fields are shown in Table 3-14.

Numeric Display (EDI111 LED)

You can use the Numeric Display module to display a count or similar information on a device.

The Numeric Display module fields are shown in Table 3-15.

Preset Message (Dynamic)

You can use the Preset Message module to to send a preset message to its destination. The message sending activity may be because of a trigger activation or other event. The message to be sent is preset through the message content input port. Note the following:

The Preset Message (Dynamic) module fields are shown in Table 3-16.

Preset Message (Static)

You can use the Preset Message module to to send a preset, static message to its destination. The message sending activity may be because of a trigger activation or other event.

If the send message is received but there is no static message, an empty string is sent.

The Preset Message (Static) module fields are shown in Table 3-17.

Serial Number Replenisher (BEA Service)

You can use the Serial Number Replenisher (BEA Service) module to contact the RFID Enterprise Server Serial Number Assignment Service to get unique EPC's.

As a possible use, you might use the EPC Cache Manager together with the Serial Number Replenisher (Static) module or a Serial Number Replenisher (BEA Service) module as follows:

The Serial Number Replenisher module fields are shown in Table 3-18.

Serial Number Replenisher (Static)

You can use the Serial Number Replenisher (Static) module to set a fixed range of serial numbers of any EPC type.

As a possible use, you might use the EPC Cache Manager together with the Serial Number Replenisher (Static) module or a Serial Number Replenisher (BEA Service) module as follows:

The Serial Number Replenisher (Static) module fields are shown in Table 3-19.

Stack Light

You can use the Stack Light module to turn the lights on a stack light on or off.

The Stack Light module fields are shown in Table 3-20.

State Filter

You can use the State Filter module split the Working State output of other modules into distinct Working and Idle outputs.

For example, consider the Module State output of the EPCIS Object Event Generator module. The state for this module can be either Working or Idle, and it is up to the destination to parse the string to determine what the actual current state is.

The State Filter module provides this service for you: it receives the generic Module State as input, parses it, and splits in into distinct Working and Idle outputs.

The State Filter module fields are shown in Table 3-21.

Tag Accumulator

You can use the Tag Accumulator module to accumulate tags for a period of time, or for a period of time delineated by start and end messages. The module starts collecting and keeping track of tags seen on a start message or at start-up time. The module sends the collected tags on a message to the send port, or after a configured amount of time.

The output of this module may typically be used by modules like EPCIS Object Event Generator or EPCIS Aggregation Event Generator. For example, use the Final Tag List output from the Tag Accumulator as the Tag List input to a EPCIS Object Event Generator to generate an object event for all accumulated tags.

The Tag Accumulator module fields are shown in Table 3-22.

Tag Counter

The Tag Counter module accepts an ECReport, a PCWriteReport, or tag list and outputs a count of the tags in the input.

For example, a Tag Counter module can take the ECReports produced by an ECSpec and output the number of tags in the input.

The Tag Counter module fields are shown in Table 3-23.

Tag List Filter

The Tag List Filter module extracts tag information from ECReports, or PCWriteReports and creates a tag list.

For example, a Tag List Filter module can take the ECReports produced by the ECSpec, extract the tag information and send it to the Add port of a Tag Accumulator module.

The Tag List Filter module fields are shown in Table 3-24.

Tag Verifier

You can use the Tag Verifier module to verify that tags are readable. It takes in tags to be verified and tags read, and produces a list of verified tags, missing tags, extra tags, and a Boolean indicating whether the verification was successful.

The Tag Verifier module fields are shown in Table 3-25.

Trigger Receiver

You can use Trigger Receiver modules to configure an edgeflow module to receive a trigger. Triggers are typically used by counted input ports, such as start, stop, clear, and send.

The Trigger Receiver module fields are shown in Table 3-26.

Wait For Time

You can use the Wait For Time module to hold (queue) input before sending it. It will discard the first message on the hold queue if a discard message is received.

The size of the queue is configurable.

The Wait For Time module fields are shown in Table 3-27.

Wait For Trigger

You can use the Wait For Trigger module to hold (queue) input until a send or discard trigger is received. If there is no message on the queue and a send trigger is received, an error is generated.

The Wait For Trigger module fields are shown in Table 3-28.

Write Tag

This port accepts an EPC or EPC Pattern. If it receives an EPC on this port, it will program a tag with that EPC and output the PCWriteReport.

If the module receives an EPC pattern as input, it will send that to other modules (such as EPC Cache Manager) through the PCspec request output port to construct the PCSpec required to program a tag for the input item type. It will then program a tag using that PCSpec and output the PCWriteReport.

For example, in the case of EPC pattern you might use the Write Tag module together with the EPC Cache Manager module as follows:

The Write Tag module fields are shown in Table 3-29.

XML Generator

You can use the XML Generator module to accept any input type (except Lists) and generate XML output. The Input port takes messages of Any (excluding Lists), String List, or Tag List.

The XML Generator module fields are shown in Table 3-30.

XML Parser

You can use the XML Parser module to convert XML to a Java object. This module supports all of the object types known to the edgeflow framework or registered with the naming service.

The XML Parser module fields are shown in Table 3-31.

XML Transformer

This module takes XML as input and applies an XSLT to it to create transformed XML output.

The XML Transformer module fields are shown in Table 3-32.