The Serial Listener listens for data via a specified serial device.
Listener (Adapter) Configuration Drop-Down List
Basic Serial Listener Configuration Options
On the Basic tab, you can specify the implementation type.
Serial Listener Basic Configuration Options
Advanced Serial Listener Configuration Options
The Advanced tab allows you to specify whether or not you should only run the Listener when it is triggered externally, how many elements should be serialized and whether or not to also scan sub-folders.
Also, you can set:
- Initialize on Trigger Only – if enabled, the Listener doesn’t start up until a trigger initializes it
- Allow Command-Line Invocation – if enabled, the listener can be invoked using the CLI client application
- Restart on Listening Error – if enabled, the listener will be restarted after an error occurs
- FIFO Queue Name – The FIFO field enables a “First In, First Out” queuing mechanism between Listeners and Transports. If a “FIFO Queue Name” is provided, that name will be used as a key for a queue Transactions & will be pushed into before reaching a transport. They’ll be ordered in this queue according to when the Listener created them.
- FIFO Queue Delay – It is the interval between updates/checks against that queue. Providing a queue name guarantees that a given Transport sends Transactions in the same order the Listener created them in.
Serial Listener Advanced Configuration Options
Transaction Logging Serial Listener Configuration Options
On the Transaction Logging tab, you can enable transaction events logging. That data can be logged by a Transaction Event Listener (TransactionEventListener).
- Transaction Logging Enable – this checkbox allows transaction events originating from this Listener to be logged by a Transaction Event Listener (TransactionEventListener)
- Log Transaction Data – if enabled, logs transaction data body
- Log Transaction Data Base64 – if enabled, logs transaction data body as Base64
- Log Transaction Attribute – if enabled, logs transaction attributes
- Log All Attributes – if enabled, no attributes will be filtered
- Allowed Attributes – attributes that are allowed to be logged
Serial Listener Transaction Logging Configuration Options
Inactivity Serial Listener Configuration Options
On the Inactivity tab you can specify:
- Enable Inactivity Monitor – check this box to enable inactivity monitoring – this will throw a non-transaction exception if the specified number of transactions haven’t been processed in the specified time interval
- Minimum Transactions to Expect – the number of transactions to expect to be completed per monitoring interval
- Monitoring Interval – how often to check the specified number of transactions have been processed
- Times to Monitor – if set, monitoring will be done during the defined times of day – to ignore, set start and end time equally
- Days to Exclude from Monitoring – inactivity monitoring will not occur on the days specified
- Include Errors in Transaction Count – if checked, transactions that attempted to start, but failed at the Listener stage, will also be counted
Serial Listener Inactivity Configuration Options
Throttling Serial Listener Configuration Options
On the Throttling tab, you can specify:
- Throttling Mode – the throttling mode to use for limiting the number of transactions or messages emitted by this Listener. “Timed” will limit transactions based on time intervals, while “Concurrent” will limit based on a concurrent number of transactions. “Concurrent” mode requires a Throttling Response Processor step later in the interface workflow to acknowledge completion.
- Throttling Mechanism – the mechanism to use for throttling messages. “Blocking” prevents the Listener from continuing to process and emit messages altogether, while “Queued” pushes received messages into the Interface queue (or a default, in-memory queue).
- Max Concurrent Messages – how many messages can be concurrently processed, either by time-based limits (“Allow X per Second”) or synchronous (“Allow X at any Time”)
- Timed Emission Interval – the interval for time-based limits (“Allow X per X Timed Emission Interval”)
- Synchronous Timeout Interval – the interval to wait for a synchronous response before failing
Serial Listener Throttling Configuration Options
Serial Config Serial Listener Configuration Options
To enable the Serial Config tab click on the Open Config button
Serial Listener Basic Configuration Options
On the Serial Config tab you can specify:
- Serial Port Descriptor – serial/comm port to listen for data
- Baud Rate – baud rate of listening port
- Data Bits – number of data bits in received serial port event
- Stop Bits – stop bit configuration for serial port event
- Parity – parity bit configuration for serial port event
- Flow Control – flow control configuration for serial port event
- Listening Method – Available (reads data from the port as it becomes available), Packet (reads data once packet size in bytes is reached), or Message
- Packet Size – size, in bytes, of received packets
Serial Listener Serial Config Configuration Options