Parameters for the Push notification from MQ pattern

Worklight
Pattern parameter Default Description
Worklight version Worklight v5.0

Specifies the target version of Worklight for the generated notification adapter. This pattern only supports Worklight v5.0.

Adapter description Worklight push notification adapter

Additional information about the adapter, which is displayed in the Worklight Console.

Event source

A string containing the name of the event source. The pattern instance name is used if this field is left empty. Mobile applications use the event source name when they subscribe to push notifications.

Polling interval 30

The notification adapter waits this long after it has finished processing all pending notifications. The notification adapter processes all available notifications each time it runs. It then quieces until this polling interval has expired.

Worklight push notifications pass a standard set of fields in the JSON messages. These fields include the sound to play, a notification text and an alert to be displayed on the mobile device. The notification message can also pass application specific fields called the payload. The Payload pattern parameter allows you to specify the names of these additional fields. The generated pattern instance is configured to include these payload fields.

Table parameter Mandatory Default Description
Name Yes  

The name of the payload field. This name is used to configure the element name in the generated XML schema. It is also used as the property name in the JSON notification message.

Service information
Pattern parameter Default Description
Service name notifications

Specifies the service name for the web service endpoint. The pattern instance name is used if this field is empty. The service name configures the URL address where the web service will be available. For example, if the server address is http://localhost:7800 and the service name is mynotifications then the web service will be available at the URL http://localhost:7800/mynotifications.

Enable support for query WSDL Selected If the broker receives an HTTP GET request with a ?wsdl query string, the broker returns WSDL and XML schema information relating to the endpoint. Use this parameter to control the distribution of your WSDL.
Notification queue name NTFY

Specifies the queue name where notification messages are put. Periodically the Worklight notification adapter calls the service created by this pattern to collect any pending notification messages from this queue.

Server address http://localhost:7800 This pattern parameter defines the server address, which is used as the SOAP address element in the generated WSDL file. Set the parameter to the actual host name and port at which the web service is to be deployed. For testing purposes this address is often set to http://localhost:7800.
Logging
Pattern parameter Default Description
Logging required Cleared This pattern parameter determines whether the pattern instance includes the subflow for logging.

If this pattern parameter is cleared, the logging subflow is not included.

If this pattern parameter is selected, you must set values for Log queue manager and Log queue.

Log queue manager This pattern parameter defines the queue manager that is used for logging. You can leave this parameter blank if the broker queue manager is used for logging.

This pattern parameter is required only if Logging required is selected.

Log queue LOG This pattern parameter defines the queue that is used for logging.

This pattern parameter is required only if Logging required is selected.

Error handling
Pattern parameter Default Description
Error message required Selected This pattern parameter determines whether the pattern instance includes code for placing error messages on a queue.

If this pattern parameter is selected, values must be set for Error queue manager and Error queue.

Error queue manager This pattern parameter defines the queue manager that is used for error logging.

This pattern parameter is required only if Error message required is selected.

Error queue ERROR This pattern parameter defines the queue that is used for error messages.

This pattern parameter is required only if Error message required is selected.

General
Pattern parameter Default Description
Flow prefix This pattern parameter defines the prefix that is added to the start of all message flow names.
Flow suffix This pattern parameter defines the suffix that is added to the end of all message flow names.
Queue prefix This pattern parameter defines the prefix that is added to the start of all queue names.

If default queue names are used, the prefix, suffix, or both, must be set to identify queue names for each pattern instance.

Queue suffix This pattern parameter defines the suffix that is added to the end of all queue names.

If default queue names are used, the prefix, suffix, or both, must be set to identify queue names for each pattern instance.

Short description This pattern parameter defines the description that is added to the Short description property of all message flows that are generated.
Long description This pattern parameter defines the description that is added to the Long description property of all message flows that are generated.

All the pattern parameters are listed with their default values. Where no default is indicated, the default value is an empty string.

Back to the Push notification from MQ pattern specification