Creating RA JMS Agent Receiver Jobs

You create RA JMS Agent Receiver Jobs by selecting a Connection object and a queue or topic. You can then define the message and specify other settings.

To create an RA JMS Agent Receiver Job:

  1. Add a Job object of type JMS > RECEIVER and select your RA JMS Agent Solution Agent object in the Host field on the Attributes page.
  2. Open the JMS Receiver page.
  3. Fill-in the fields on the right side of the screen.
    • Connection

      • A JMS Connection object.

    • Queue/Topic

      • Use the radio button control to select a Queue or Topic for your Job. The drop-down lists for the Queue or Topic fields include the queue or topic names defined in the selected Connection object. You can:

      • Select one of these names.
      • Select one of these names and edit it.
      • Type in a custom name.

      These editable value fields can include object variables in the format &<variable name>. The values of these object variables will be replaced at runtime.

    • Dynamic Queue/Dynamic Topic

      • Supported by TIBCO EMS and Apache ActiveMQ providers. When checked, if you enter a queue or topic name that does not exist, the RA JMS Agent will create the queue or topic for you. That queue or topic will exist as long as: 

      • There are messages on the queue or topic.
      • A message consumer is listening on the queue or topic.

      This field can also be used to enter the physical name of the queue or topic rather than the JNDI registered name. For example, if you have a queue or topic name that's hidden and you only want others to use the physical name that is not available through JNDI look-up.

    • Subscriber Properties Durable

      • Designates the subscriber as a durable subscriber. This checkbox is only active when Topic is selected above. When this box is checked, Subscriber Name and Client ID become required fields.

    • Subscriber Properties Shared

      • Designates the subscriber as a shared subscriber. This checkbox is only active when the following are true:

      • Topic is selected above.
      • A JMS 2.0 provider is selected in the Connection object.

        • Currently, TIBCO EMS is our only supported JMS 2.0 provider.

    • Subscriber

      • The name of the durable or shared subscriber. This field is used to either: 

      • Identify an existing subscriber.
      • Name a subscriber to create.

      This field is only active when the following are true:

      • Topic is selected above.
      • The Shared Subscriber or Durable Subscriber boxes below are checked.
    • Client ID

      • The name for the unique client ID that is used for durable subscriptions. This field is only active when the following are true:

      • Topic is selected above.
      • The Shared Subscriber or Durable Subscriber boxes below are checked.
    • Include Message Headers and Properties

      • When checked, the RA JMS Agent includes all headers and properties of the message in the Job report.

    • Include Message Payload

      • When checked, the RA JMS Agent includes the message payload in the Job report.

      When this checkbox and the Include Message Headers and Properties in the Job Report checkbox above are both checked, the headers, properties, and message payload are all saved to the same Job report.

      When the message is a bytes message, and this box is checked, a message is written to the Job report with the number of bytes.

    • Timeout

      • The number of seconds to wait for a message before the Job times out. The default timeout is set in the Agent definition.

    • Fail Job on Timeout

      • Specifies whether the Job should abort upon its first timeout or allow the Job to finish successfully without receiving the message.

    • Fail Job on Unexpected Message Type

      • If checked the Job should abort on receiving messages with a different type than defined in the parsing section if any parsings are defined.

    • Receive Multiple Messages

      • If checked, the Job can receive multiple messages from its queue or a topic. If you check this box, you must specify a value for Maximum Runtime, Maximum Messages, or both.

    • Maximum Runtime

      • Specifies the number of seconds for the maximum runtime. This and the Maximum Messages field are only active when the Receive Multiple Messages checkbox is selected above. Once a Job reaches its maximum runtime or maximum messages, the Job will finish normally.

      The seconds specified in the Timeout field apply to each message.

    • Maximum Messages

      • Specifies the maximum number of messages that can be received within one Job execution. This and the Maximum Runtime field is only active when the Receive Multiple Messages checkbox is selected above. Once a Job reaches its maximum runtime or maximum messages, the Job will finish normally.

      The seconds specified in the Timeout field apply to each message.

  4. Optionally filter the messages to be received. For more information, see Defining Filters for RA JMS Agent Receiver Jobs.
  5. Optionally specify report settings for the Job. For more information, see Specifying Report Settings for RA JMS Agent Receiver Jobs.
  6. Optionally define parsings for the RA JMS Agent Receiver Job headings, properties and message. For more information, see Defining Parsings for RA JMS Agent Receiver Jobs
  7. Click Save to save the Job.