Description

The Rest Poller WS Listener is a generic web service client that collects data in different formats (XML, JSON) from an external source. 

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

Endpoint

Any string

Endpoint of a Restful web service to poll.

Polling interval

Any integer

Polling interval in seconds (default is 300)

Single format

Specifies if the data resulting from a a listener plugin (a poller) must be interpreted as one message or as multiple messages. The default format is multiple. So if there is an array of values, each value will be a different message. The other possibility is single format, where the result will be interpreted as only one message (in the case of an array, the whole array will be included in one message). For example, Salesforce returns the following response:

[
{
"key":"NA14",
"location":"NA",
"environment":"production",
"releaseVersion":"Spring '17 Patch 13.1",
"releaseNumber":"",
"status":"OK",
"isActive":false,
"Products":[
{
"key":"Chatter",
"order":50
},
{
"key":"Community_Cloud",
"order":40
},
{
"key":"Einstein_Analytics",
"order":60
},
{
"key":"Financial_Services_Cloud",
"order":80
},
{
"key":"CPQ_and_Billing",
"order":100
},
{
"key":"Sales_Cloud",
"order":1
},
{
"key":"Service_Cloud",
"order":10
},
{
"key":"Health_Cloud",
"order":90
},
{
"key":"LiveAgent_Omni-Channel",
"order":20
},
{
"key":"Lightning_Platform",
"order":30
}
],
"Incidents":[
 
],
"Maintenances":[
 
],
"Tags":[
 
]
},
{
"key":"NA88",
"location":"NA",
"environment":"production",
"releaseVersion":"Summer '18 Patch 15.1",
"releaseNumber":"214.15.1",
"status":"OK",
"isActive":true,
"Products":[
{
"key":"Chatter",
"order":50
},
{
"key":"Community_Cloud",
"order":40
},
{
"key":"Einstein_Analytics",
"order":60
},
{
"key":"Financial_Services_Cloud",
"order":80
},
{
"key":"CPQ_and_Billing",
"order":100
},
{
"key":"Health_Cloud",
"order":90
},
{
"key":"LiveAgent_Omni-Channel",
"order":20
},
{
"key":"Sales_Cloud",
"order":1
},
{
"key":"Service_Cloud",
"order":10
},
{
"key":"Lightning_Platform",
"order":30
}
],
"Incidents":[
 
],
"Maintenances":[
 
],
"Tags":[
 
]
}
]
JS

A single format will create one message with the whole array as a list in the message, while a multiple format will create two messages, where each object in the array is a message.

See also