The Google Cloud Storage Listener/Adapter is used to retrieve data from Google Cloud Storage.
Listener (Adapter) Configuration Drop-Down List
Basic Google Cloud Storage Listener Configuration Options
On the Basic configuration tab, you specify the following options:
- Polling Interval – this time interval is used for setting how often Google Cloud Storage should be scanned
- Bucket Name – this configuration item is used to specify the unique name of the bucket you need to access
- Polling Directory – this is the directory in the storage to be polled
- Include Sub-Folders – check the box if sub-folders should be included in the polling.
- Specify Full File Path – check to enable and pick up a particular file
- File Path – this is enabled when the Specify Full File Path box is checked allowing the file path to be entered
Google Cloud Storage Listener Basic Configuration Options
Advanced Google Cloud Storage Listener Configuration Options
The Advanced tab allows you to specify:
- 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.
- Max Transactions Per Run – the maximum number of transactions that can be started during a single polling cycle
Google Cloud Storage Listener Advanced Configuration Options
Transaction Logging Google Cloud Storage 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
Google Cloud Storage Listener Transaction Logging Configuration Options
Inactivity Google Cloud Storage 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
Google Cloud Storage Listener Inactivity Configuration Options
Throttling Google Cloud Storage 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.
Google Cloud Storage 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
Google Cloud Storage Listener Throttling Configuration Options
Scheduling Google Cloud Storage 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:
Google Cloud Storage Listener Scheduling Configuration Options
Credentials Google Cloud Storage Listener Configuration Options
The Credentials configuration tab allows you to specify:
- JSON Key File – the path to the JSON key file for authenticating with Google Cloud Storage
Google Cloud Storage Listener Credentials Configuration Options
Post-Process Google Cloud Storage Listener Configuration Options
The Post-Process configuration tab allows you to specify:
- Post-Process Action – the post-process action to take
- Move to Bucket – the bucket in Google Cloud Storage to move the file to. If blank, the bucket the file was read from will be used.
- Move to Directory – the directory in Google Cloud Storage to move the file to. If blank, it’ll be moved to the root of the bucket.
Google Cloud Storage Listener Post-Process Configuration Options