Redis Listener

The Redis Listener in the PilotFish Integration Platform parses the Redis XML and executes the commands against a Redis system. There are 40+ different Listeners/Connectors available. There are 6 tabs: Basic, Advanced, Transaction Logging, Inactivity, Throttling, and Debug.

Listener (Adapter) Configuration Drop-Down List

Basic Redis Listener Configuration Options

On the Basic tab, you can specify:

• Polling Interval – the interval in which to execute the XML file. If the value is set with enhanced properties, the units are seconds.
• Input File – input file, if the transaction contents do not contain the document to evaluate
• Validate XML – if the received or loaded XML document should be validated against its schema
• Cache Schema – if the schema for validation should be cached, so it won’t be re-loaded on every execution
• Redis Host – the URL for the Redis instance to connect to
• Redis Port – the port of the Redis instance to connect to
• Database Number – the database number to connect to. Valid values are between 0-15.

Redis Listener Basic Configuration Options (top half of screen)

• Password – the password of the Redis instance. If not required, leave blank.
• Use SSL – check if SSL connection is desired

Redis Listener Basic Configuration Options (bottom half of screen)

Advanced Redis Listener Configuration Options

The Advanced tab allows you to specify whether or not you should only run the Listener when it is triggered externally, and how many elements should be serialized.

Also, you can set:

• 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 options enable a “First In, First Out” queuing mechanism between Listeners and Transports. If a FIFO Queue Name is provided, it will be used as a key for a transaction queue. Transactions will be written to this queue before they reach a Transport. The transactions in this queue will be ordered according to when they were created by the Listener.
• FIFO Queue Delay – this is the interval between updates or checks against that queue. Providing a queue name guarantees that a given Transport sends transactions in the same order that the Listener created them in.
• Cache Type – set the type of cache used internally for storing data when the XML structure is executed: Default Cache, Memory Cache, File Cache, Segment Cache

Redis Listener Advanced Configuration Options

Transaction Logging Redis Listener Configuration Options

The Transaction Logging tab allows you to specify:

• Transaction Logging Enabled – if enabled, allows transaction events originating from this Listener to be logged by a TransactionEventListener
• Log Transaction Data – if enabled, logs transaction data body
• Log Transaction Data Base64 – if enabled, logs transaction data body as Base64
• Log Transaction Attributes – if enabled, logs transaction attributes
• Log All Attributes – if enabled, no attributes will be filtered
• Allowed Attributes –  attributes that are allowed to be logged

Redis Listener Transaction Logging Configuration Options

Inactivity Redis Listener Configuration Options

The Inactivity tab allows you to 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.
• Min. 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 that have been processed
• Times to Monitor – if set, monitoring will be done during the defined times of the 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

Redis Listener Inactivity Configuration Options

Throttling Redis Listener Configuration Options

The Throttling tab allows you to 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 your interface workflow to acknowledge completion.

Redis Listener Throttling Mode

• 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

Redis Listener Throttling Configuration Options

Debug Redis Listener Configuration Options

On the Debug configuration tab, you can specify:

• Evaluation Logging – if selected, extra information about the evaluation process will be logged to help with debugging its execution. Keep in mind that, in some cases, sensitive information may be logged with this option, so it should be kept off by default. NOTE: This is separate from the Log elements in the XML structure.

Redis Listener Debug  Configuration Options