JMS QueueBrowser

JMS QueueBrowser is used to browse for a message in the queue as per the given search criteria. The queue browser reads the last 1000 messages and returns the message which matches as per the selection criteria. Queue browsers are used to read the messages from the message queues such as IBM Broker and JMS. A client uses a Queue Browser object to look at messages on a queue without removing them.

Pre-condition:

Before using a JMS QueueBrowser node in designing any task, the JMS Queue configuration must be defined.


1.1 Defining the JMS Queue Configuration:

Do the following to define the JMS Queue configuration:
1. Login to Jiffy.
2. Navigate to Task Design -> Configurations -> JMS Queue Configuration.
3. Click on the Add button to define the configuration.
   
   The following dropdown is displayed with two options:
   
   
   • Create New: Use this option to create a new JMS Queue configuration.
     Do the following to add new configuration:
     • Click on the Create New button to display the display the Add JMS Queue Configuration window.
       
       Specify the details for the following fields:
       • Configuration Name: Name to be provided for the configuration and the specified name is used in the Properties section of the node.
       • Initial context factory: Context factory object name provided by client.
       • Protocol URL: Queue URL provided by the client.
       • Connection factory: Connection factory object name provided by the client.
       • Username: Username, if authentication required provided by the client.
       • Password: password. The password can be normal/secure vault/Cyber ark.
     • Click on the Save button.
   • Copy Existing: Use this option to copy from the existing configurations that are defined earlier.
     • Click on the Copy Existing button to display the Copy Configuration window.
       
       
     • Type the details of the required configuration in the above Search fields.
     • Select the required configuration from the filtered list.
     • Click on the Copy button.
Note: All the defined Sterling configurations are available in the JMS Queue Configuration dropdown in the Properties tab of the Task Design screen for creating a task.



Designing a Task Using a JMS Queue Browser Node:

Do the following to use an JMS Queue Browser node in a task:
1. Use an existing task or create a new task based on the requirement.
   Note: Refer Create A Task for more details on how to create a task and how to open an existing task.
2. Drag and drop the JMS Queue Browser node from the Objects -> Sterling Components section and connect the nodes.
   
   
3. Click on the JMS Queue Browser node and specify the properties:
   
   
   • Name: Name of the node. A default name is displayed in this field, which the user can edit according to the task and the intent of using the node.
   • Description: A short note on the purpose of the node.
   • Mark run Failure on Node Fail: When the Mark run Failure on Node Fail field is ON, if the node execution fails then the complete task execution is marked as fail.
   • Continue even without match: When the Continue even without match field is ON, the execution will continue even if data does not match the queue.
   • JMS Queue Configuration: The configuration of the release/environment level where you want to run the task case. The task will get the release level configuration from the design run and the environment level configuration from the execution run. For more details on how to add a configuration, click here.
   • Destination: Queue Name where the message is to be put or fetch from.
   • Mapping template: Select the template in the dropdown below. Template will be added in the data template repository before selecting in the dropdown.
   • Run with User config?: This is used to run the node if any user-level configuration is defined for.
4. Click on the Trial Run icon to run the task.
5. Click on the Book icon above the JMS Queue Browser node to display the Result of execution window of the JMS Queue Browser node.