Queue sender
The following documentation content might not be fully up to date since content here refers to an older version or is currently being reviewed. Come back later to check status.
The following documentation content might not be fully up to date since content here refers to an older version or is currently being reviewed. Come back later to check status.
Description
Sends messages to a queue in 1Gateway to be polled externally.
Prerequisites
Installation
Make sure you have the 1gateway zip file that includes the plugin files and valid licences information ready. This file has been provided to you with the installation files.
1 - Login
Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).
2 - System Maintenance
Click on the menu icon and choose the option "System maintenance"
3 - Upload file
In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.
4 - Restart
After the upload installation will be confirmed. Restart 1Gateway to ensure any locked files are updated.
Configuration
Open the main menu and click on "New plugin"
Select the plugin you want to configure. Use the Filter field if needed.
Field name | Supported values | Description |
|---|---|---|
Queue name | Any string | Queue name (used to poll it externally) |
Message type | Any string | Type of the messages to be stored in the queue |
Note: Once the plugin is configured, a URL used to poll the messages externally will appear. For a QueueSender with a queue name of "1GatewayQueue" the URL will be: http://1Gateway-server:8090/ws/rest/queue/1GatewayQueue/?token=*** This will poll all messages currently in the queue. To poll the queue with a specific number of messages, for example a hundred messages: http://1Gateway-server:8090/ws/rest/queue/1GatewayQueue/100?token=***
Advanced configuration
The advanced configuration of the QueueSender plugin includes further configuration of the queue.
Field name | Supported values | Description |
|---|---|---|
Persistent queue | True / false | Persist queues to disk |
Maximum queue size | Any integer | Maximum size of queue. When the queue is full, messages will be discarded (oldest first) |
See also