Receive Message

Operation Name

Receive Message

Function Overview

Receives message from Amazon SQS.

Data Model

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 to show on the script canvas.  
Required settings
Item name Required/Optional Use of Variables Description Remarks
Destination Required Not Available Select a global resource.
  • [Add]:
    Adds a new global resource.
  • [Edit list]:
    Enables to edit the global resource settings in the "Edit resource list".
 
Queue name Required Available Specify the targeted queue of receiving message.
  • Directly enter, or select from the list.
 
Option
Item name Required/Optional Use of Variables Description Remarks
Maximum number of receiving message Optional Available Specify maximum number of receiving message from Amazon SQS.
  • Specify between 1-10.
  • If you omit, setting of Amazon SQS side will be reflected.
Visibility timeout(second) of receiving message Optional Available Specify the time (second) of receiving message being invisible.
  • Specify between 0-43200.
  • If you omit, setting of Amazon SQS side 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 adapter.
The description will be reflected in the specifications.
 

Schema

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 accordingly to the sent message.  
md5_message_body Value of the MD5 encoded message body.
  • Value of the "MD5OfMessageBody" element included in the response from Amazon SQS.
message_body Value of message body.
  • Value of the "MessageBody" element included in the response from Amazon SQS.
message_id ID of the received message.
  • Value of the "MessageId" element included in the response from Amazon SQS.
receipt_handle Identifier (Receipt Handle) used when requesting message deletion.
  • Value of the "ReceiptHandle" element included in the response from Amazon SQS.
attribute Element including message attribute.
  • Value of the "Attributes" element included in the response from Amazon SQS.
attribute - Appears accordingly to message_result element.  
approximate_first_receive_timestamp Time of receiving first message.
  • Showed in UNIX Time format.
receive_count Number of times that message was received.
  • If you receive this message for the first time, the value will be [1]./
sender_id ID of the message sender.  
sent_timestamp Time of sending message.
  • Showed in UNIX Time format.

Loading Schema on Mapper

Schema is loaded automatically.
For details, refer to "Edit Schema".

Mass Data Processing

Mass Data Processing is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
count Stores the number of received message.
  • Default value is null.
message_category Stores the category of message code corresponding to the occured error.
  • Default value is null.
message_code Stores the code of message code corresponding to the occured error.
  • Default value is null.
message_level Stores the severity of message code corresponding to the occured error.
  • Default value is null.
error_type Returns the error type when error occurred.
  • Default value is null.
  • Error is represented in the format depicted below.
    Example:java.io.FileNotFoundException
  • The message may vary depending on the DataSpider Servista version.
error_message Returns the error message when error occurred.
  • Default value is null.
  • The message may vary depending on the DataSpider Servista version.
error_trace Returns the trace information when error occurred.
  • Default value is null.
  • The message may vary depending on the DataSpider Servista version or the client application used.

Specification Limits

Main Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition could not be found.Name:[]
[Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition could not be found.Name:[<Global Resource Name>]
Resource definition selected in [Destination] is not found. Check the global resource specified in [Destination].
InvalidPropertyConfigurationException
Specify the maximum number of receiving message as a whole number from 1 to 10.
[Maximum number of receiving message] is not whole number, or is beyond the specifying value. Specify the whole number from 1 to 10 in [Maximum number of receiving message].
InvalidPropertyConfigurationException
Specify the whole number from 0 to 43200 in Receiving message visible timeout (second).
[Receiving message visible timeout (second)] is not whole number, or is beyond the specifying value. Specify the whole number from 0 to 43200 in [Receiving message visible timeout (second)].
The specified queue does not exist for this wsdl version. (Service: AmazonSQS; Status Code: 400; Error Code: AWS.SimpleQueueService.NonExistentQueue; Request ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX) Queue that does not exist in [Queue name] is specified. Check the setting of [Region] in the global resource specified in [Queue name] or [Destination].
The security token included in the request is invalid. (Service: AmazonSQS; Status Code: 403; Error Code: InvalidClientTokenId; Request ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX) [Access Key ID] of the global resource specified in [Destination] includes failure. Check the setting of global resource specified in [Destination].
The request signature we calculated does not match the signature you provided. Check your AWS Secret Access Key and signing method. [Secret Access Key] of the global resource specified in [Destination] includes failure. Check the setting of global resource specified in [Destination].

Notes