Get Messages In Queue operation


The Get Messages In Queue wrapper retrieves the properties of all the messages in the queue, (for example, sender, recipient, subject, size and so on).

The following table describes the input parameters for the Get Messages In Queue wrapper.

 Input parameters for the Get Messages In Queue wrapper

The following figure shows a sample of an adapter request for the Get Messages In Queue wrapper.

XML sample of an adapter request for the Get Message In Queue wrapper


<microsoft-exchange-request>
 <command>
  <command-name>Get-AllMessagesInQueue</command-name>
   <parameters>
     <parameter>
       <name>QueueId</name>
       <value>{0F5C33F2-B83A-41FA-9BE3-69C6D1314E13}/63328132/63328136</value>
    </parameter>
    <parameter>
       <name>QueueName</name>
       <value>CurrentlyUnreachableLink</value>
    </parameter>
    <parameter>
       <name>ProtocolName</name>
       <value>SMTP</value>
    </parameter>
   </parameters>
  </command>
</microsoft-exchange-request>


The following figure illustrates the adapter response for the Get Messages In Queue wrapper.

XML sample of the adapter response for the Get Messages In Queue wrapper

<microsoft-exchange-response>
<metadata>
<status>success</status>
</metadata>
 <commands-output>
  <command-output>
 <metadata>
 <command>cscript "C:\Program Files\BMC Software\AO\CDP_75FCS\server\grids
   \KGrid\library\adapters\bmc-adapter-microsoft-exchange-v2003
  -actor_7.6.00-SNAPSHOT\scripts\getAllMessagesInQueue.vbs"  
  "CurrentlyUnreachableLink" "SMTP" "{0F5C33F2-B83A-41FA-9BE3-69C6D1314E13}
  /63328132/63328136"</command>
   <line-count>49</line-count>
   <execution-milliseconds>4406</execution-milliseconds>
   <exit-code>0</exit-code>
   <status>success</status>
 </metadata>
 <output>
   <line index = "1">Attempting to connect to remote host...</line>
   <line index = "2">Initialising rctrlx server component...</line>
   <line index = "3">Executing remote application: cmd /c cscript
 "%windir%\getAllMessagesInQueue.vbs" "CurrentlyUnreachableLink"
"SMTP" "{0F5C33F2-B83A-41FA-9BE3-69C6D1314E13}/63328132/63328136"</line>
   <line index = "4">Remote application process ID: 2304</line>
   <line index = "5">Microsoft (R) Windows Script Host Version 5.6</line>
   <line index = "6">Copyright (C) Microsoft Corporation 1996-2001.
All rights reserved.</line>
   <line index = "7">--------------------------------------</line>
   <line index = "8">MessageId: &lt;B9222068CB53B342A1D5CA7BB4D4353559D5@s
-17125&gt;</line>
   <line index = "9">Sender: Administrator@BMCDEV1.com</line>
   <line index = "10">Recipients: Envelope Recipients:</line>
   <line index = "11">SMTP:sdvcsZ@jfnv.vomk;</line>
   <line index = "12">Subject: ffffffffffff</line>
   <line index = "13">Size: 481</line>
   <line index = "14">Time Submitted: 20090713062003.000671+***</line>
   <line index = "15">Time Received by Server:
20090713062003.000671+***</line>
   <line index = "16">Time Expires:20090715062003.000671+***</line>
   <line index = "17">--------------------------------------</line>
   <line index = "18">MessageId: &lt;B9222068CB53B342A1D5CA7BB4D4353559D6@s
-17125&gt;</line>
   <line index = "19">Sender: Administrator@BMCDEV1.com</line>
   <line index = "20">Recipients: Envelope Recipients:</line>
   <line index = "21">SMTP:sdvcsZ@jfnv.vomk;</line>
   <line index = "22">Subject: vvvvvvvvvvvvvvvvvvvvvvv</line>
   <line index = "23">Size: 494</line>
   <line index = "24">Time Submitted: 20090713062026.000375+***</line>
   <line index = "25">Time Received by Server: 20090713062026.000375+***</line>
   <line index = "26">Time Expires:20090715062026.000375+***</line>
   <line index = "27">--------------------------------------</line>
   <line index = "28">MessageId: &lt;B9222068CB53B342A1D5CA7BB4D4353559D6@s
-17125&gt;</line>
   <line index = "29">Sender: Administrator@BMCDEV1.com</line>
   <line index = "30">Recipients: Envelope Recipients:</line>
   <line index = "31">SMTP:sdvcsZ@jfnv.vomk;</line>
   <line index = "32">Subject: vvvvvvvvvvvvvvvvvvvvvvv</line>
   <line index = "33">Size: 494</line>
   <line index = "34">Time Submitted: 20090713062026.000375+***</line>
   <line index = "35">Time Received by Server:
20090713062026.000375+***</line>
   <line index = "36">Time Expires:20090715062026.000375+***</line>
   <line index = "37">--------------------------------------</line>
   <line index = "38">MessageId: &lt;B9222068CB53B342A1D5CA7BB4D4353559D5@s
-17125&gt;</line>
   <line index = "39">Sender: Administrator@BMCDEV1.com</line>
   <line index = "40">Recipients: Envelope Recipients:</line>
   <line index = "41">SMTP:sdvcsZ@jfnv.vomk;</line>
   <line index = "42">Subject: ffffffffffff</line>
   <line index = "43">Size: 481</line>
   <line index = "44">Time Submitted: 20090713062003.000671
+***</line>
   <line index = "45">Time Received by Server: 20090713062003.000671
+***</line>
   <line index = "46">Time Expires:20090715062003.000671+***</line>
   <line index = "47">---------------------------</line>
   <line index = "48">Total 4 messages found on Queue:
CurrentlyUnreachableLink</line>
   <line index = "49">Remote application exited with code: 0</line>
 </output>
</command-output>
</commands-output>
</microsoft-exchange-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 20.18.01