Receive Message

Operation Name

Receive Message

Function Overview

Receive messages from Azure Queue Storage.

Data Model

XML type.

Properties

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 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]:
    Add a new global resource.
  • [Edit list]:
    Global resource settings can be edited in “Edit resource list” screen.
  
Queue name Required Available Specify a queue to receive messages from.
  • Enter directly or select from the list.
  
Property actions
Item name Description Remarks
Get queue names Get queue names from Azure Queue Storage.
  • Disabled when [Destination] is not specified.
Receive settings
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 Azure Queue Storage.
  • Specify between 1-32.
  • When omitted, it will be 1.
Visibility timeout (second) for receiving message Optional Available Specify the time (seconds) in which received messages will be invisible.
  • Specify between 1-604800.
  • When omitted, it will be 30.
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"?>
<queue client_request_id="" >
  <message id="" pop_receipt="" message_content="" >
  </message>
</queue>
Element name Attribute name Description Remarks
queue -    
client_request_id The ID issued in the client side of Azure Queue Storage.  
message - Appears for each received message.  
id The identifier (Message Id) got when receiving the message from Azure Queue Storage.  
pop_receipt The POPReceipt value got when receiving the message from Azure Queue Storage.  
message_content The message text got when receiving the message from Azure Queue Storage.  

Loading schema in Mapper

Schema is loaded automatically.
For more 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 The number of the received messages is stored.
  • Default value is null.
message_category When an error occurs, category of the corresponding message code is stored.
  • Default value is null.
message_code When an error occurs, code of the corresponding message code is stored.
  • Default value is null.
message_level When an error occurs, severity of the corresponding message code is stored.
  • Default value is null.
error_type When an error occurs, the error type is stored.
  • Default value is null.
  • The error type would be in the following format.
    Example: “java.io.FileNotFoundException”
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_message When an error occurs, the error message is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace When an error occurs, trace information of the error is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

Specification Limits

Major Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition is not found. Name: []		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition is not found. Name: [<global resource name>]		 The resource definition selected in [Destination] is not found. Check the global resource specified in [Destination].
InvalidPropertyConfigurationException
Maximum number of messages to receive		 The value of [Maximum number of messages to receive] is out of the available range. Specify an integer between 1 and 32 for [Maximum number of receiving messages].
InvalidPropertyConfigurationException
Visibility timeout (second) for receiving message		 The value of [Visibility timeout (second) of receiving message] is out of the available range. Specify an integer between 1 and 604800 in [Visibility timeout (seconds) of receiving messages].
java.security.InvalidKeyException
Storage Key is not a valid base64 encoded string.
 There is something wrong with [Access key] of the global resource specified in [Destination]. Check the [Access key] settings of the global resource specified in [Destination].
com.microsoft.azure.storage.StorageException
Empty key 		There is something wrong with [Access key] of the global resource specified in [Destination]. Check the [Access key] settings of the global resource specified in [Destination].
com.microsoft.azure.storage.StorageException
Server failed to authenticate the request. Make sure the value of Authorization header is formed correctly including the signature. 		There is something wrong with [Account] or [Access key] of the global resource specified in [Destination]. Check the [Account] or [Access key] settings of the global resource specified in [Destination].
com.microsoft.azure.storage.StorageException
The server encountered an unknown failure: 		Failed to request receive message. Check [Queue name] or the [Account] and [Access key] settings of the global resource specified in [Destination].

Notes