Execute Command Line Listener
The Execute Command Line Listener is used to execute commands on the command line and passes the results along as a new transaction. To configure this listener, select the Execute Command Line Listener from the Listener Type drop-down menu.
Listener (Adapter) Configuration Drop-Down List
Basic Execute Command Line Listener Configuration Options
On the Basic configuration tab, you should specify the Polling Interval for how often to execute commands. The Command Source could be two types: Simple Config, Script File.
- Polling Interval – How often the directory is polled for new files. If the value is set with enhanced properties, the units are seconds.
- Command Source – Select the source of the command to execute. Simple Config allows a simple command to be configured in the UI. Script File allows for the execution of a command script file.
- Command – the command to execute when this transport runs
- Script File – The path to the command script to execute. This script needs to be in the appropriate Format.
- Params – The parameters to provide to the command to be executed. Each parameter will be used in its entirety, even if it has multiple elements
- Command Timeout – time to wait for the command to complete, in seconds
Execute Command Line Listener Basic Configuration Options
Advanced Execute Command Line 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:
- 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.
- Allow Failure – If selected, the command failing will be logged, and the transaction will continue with the failure message in the data. Otherwise, if the command fails, an exception will be thrown and the Route will terminate.
Execute Command Line Listener Advanced Configuration Options
Transaction Logging Execute Command Line 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 which are allowed to be logged
Execute Command Line Listener Transaction Logging Configuration Options
Inactivity Execute Command Line 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
Execute Command Line Listener Inactivity Configuration Options
Throttling Execute Command Line 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.
Execute Command Line 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
Execute Command Line Listener Throttling Configuration Options
Scheduling Execute Command Line Listener Configuration Options
The Scheduling tab allows you to create a schedule for how often the chosen Listener should be run. You can easily modify the start time or end time.
- Scheduled Start Time – specify the scheduled start time. If left blank, the system will defer to the polling interval listed on the Basic tab.
- Scheduled End Time – specify the scheduled end time. If left blank, the system will defer to the polling interval listed on the Basic tab.
- Week Days to Exclude – specify days of the week to exclude from scheduling
- Dates to Exclude – specify specific dates to exclude from scheduling
- Time Zone – specify the Time Zone that should be used for scheduling. By default, it is set to the Time Zone of the eiConsole during the initial configuration.
To modify the scheduled start or end time, choose the three dots next to the corresponding line. You will receive a dialogue box that looks like this:
Execute Command Line Listener Scheduling Configuration Options