Receive Message

Operation name

Receive Message

Function overview

Receives messages from Amazon SQS.

Data model

The data model of this component is XML type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Queue name	Required	Available	Specify a queue to receive messages from. Enter directly or select from the list.

Item name

Required/Optional

Use of variables

Description

Remarks

Destination

Required

Not available

Select a connection resource.

Add: A new connection resource can be added.
Edit list: Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Queue name

Required

Available

Specify a queue to receive messages from.

Enter directly or select from the list.

Option

Item name	Required/Optional	Use of variables	Description	Remarks
Maximum number of messages to receive	Optional	Available	Specify the maximum number of messages to receive from Amazon SQS.	Specify between 1 and 10. When omitted, the setting of Amazon SQS will be reflected.
Visibility timeout (seconds) for receiving message	Optional	Available	Specify the time (seconds) in which received messages will be invisible.	Specify between 0 and 43200. When omitted, the setting of Amazon SQS will be reflected.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

<?xml version="1.0"?>
<message_results>
  <message_result md5_message_body="" message_body="" message_id=""  receipt_handle="" >
    <attribute approximate_first_receive_timestamp="" receive_count="" sender_id="" sent_timestamp="" />
  </message_result>
</message_results>

Element name	Attribute name	Description	Remarks
message_results	-
message_result	-	Appears once for each received message.
	md5_message_body	The value of the message body encoded with MD5.	The value of "MD5OfMessageBody" element included in the response from Amazon SQS.
	message_body	The value of the message body.	The value of "MessageBody" element included in the response from Amazon SQS.
	message_id	The message ID of the received data.	The value of "MessageId" element included in the response from Amazon SQS.
	receipt_handle	The identifier (Receipt Handle) used in message deletion request.	The value of "ReceiptHandle" element included in the response from Amazon SQS.
	attribute	The element that contains message attribute.	The value of "Attributes" element included in the response from Amazon SQS.
attribute	-	Appears once for each message_result element.
	approximate_first_receive_timestamp	The timestamp of when the message is received for the first time.	Represented in the UNIX Time format.
	receive_count	The number of times of receiving the messages.	When the message is received for the first time, the value will be [1].
	sender_id	The message sender ID.
	sent_timestamp	The timestamp of when the message is sent.	Represented in the UNIX Time format.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of the received messages is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Amazon SQS connector