Receive Message

Operation Name

Receive Message

Function Overview

Receive a message from queue/topic on JMS provider server.

Data Model

Data model of this component is XML type.

Properties

For information about using variables, refer to "variables".
Basic settings
Item name Required / Optional Use of Variables Description Remarks
Name Required Not available Enter the name on the script canvas.  
Required Settings
Item name Required / Optional Use of Variables Description Remarks
Destination Required Not available Select Global Resources.
Refer to "Global Resource Properties" for global resource settings.
  • [Add]:
    Adds new global resource.
  • [Edit List]:
    Global resource settings can be edited with "Edit Resource list".
  
Message type Required Not available Select the type of message to be received.
  • [Any Message]: (default)
    Get message of all types.
  • [XML Message]:
    Get the text data as XML documents.
  • [Text Message]:
    Get the text data.
  • [Map Message]:
    Gets the message with key and map of values (corresponding).
  • [Object Message]:
    Gets the object.It is encoded as BASE64 when written.
  • [Stream Message]:
    Get the data stream defined by the user application.
  • [Bytes Message]:
    Gets a byte array.
  • If you specify message type other than [Any Message] , You cannot get message that does not match the type specified.
Byte message setting Optional - Specify the data and the number of occurrences.

Each column can be operated with the following buttons.
  • [Add]:
    Add a column.
  • [Up]:
    Move the order of the selected column upwards by one.
  • [Down]:
    Move the order of the selected column downwards by one.
  • [Delete]:
    Delete the column.
  • Enables if you Select [Bytes Message] at [Message type].
  • If omitted, the data byte[] is read.
Byte message setting / Data type Required Not available Select the data type.
  • [double]: (default)
  • [long]:
  • [float]:
  • [int]:
  • [short]:
  • [boolean]:
  • [char]:
  • [byte]:
  • [UTF]:
  • [unsigned short]:
  • [unsigned byte]:
  • [UTF] is string type decoded by UTF-8.
Byte message setting / Occurrence count Required Available Enter the number of occurrences of the type specified at [Data type].
  • If omitted, "1" is set.
Subscription settings
Item name Required / Optional Use of Variables Description Remarks
Expiration (ms) Optional Available Enter a expiration of message when you subscribe message.

Message is deleted when expiration time has passed or when message is subscribed to all subscriptor.
  • Enables if you specify topic connection at [Destination].
  • The default value is "1000", if omitted, "1000" is set.
  • Available value is "1" to "2147483646".
Comment
Item name Required / Optional Use of Variables Description Remarks
Comment Optional Not available You can write a short description of this adapter.
The description will be reflected in the specifications.		  

Schema

Input Schema

None.

Output Schema

Depends on the setting of [Message type].
For any details, please refer to the "Schema".

Loading schema in Mapper

Schema is loaded automatically.
For any details, please refer to the "Editing Schema".

Transaction

Transaction is supported.
For JMS Adapter's transaction settings, please refer to the [Transaction] of "Global Resource Properties".

Mass data processing

Mass data processing is not supported.

PSP Usage

PSP is not supported.

Specification Limits

None.

Main exceptions

Exception name Causes Solution
ResourceNotFoundException
Resource definition could not be found.Name: []		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition could not be found.Name: [<name of Global Resources>]		 Resource definition selected in [Destination] is not found. Check the global resource specified in [Destination].
InvalidPropertyConfigurationException
Are not given the resources required fields. : <Property name>		 [Destination] that is selected in the resource definition [<property name>] is not specified. [Destination] definition of the selected resources in the [<property name>] Please specify.
javax.jms.JMSException JMS provider is not running, or the connection settings are incorrect. Check whether JMS provider is running, or check the contents of connections setting.