Introduction

Enzo Server
  Installation
  Quick Start

  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views

  Advanced Capabilities
    Change Data Capture

  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  Adapters
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Couchbase
    CSV
    DB (RDBMS)
    Files
    Flight Aware
    FTP
    Geonames
    Insteon
    Loggly
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    SQL Server
    Threading
    Twilio
    Twitter
    VellemanDMX
    Weather (Underground)
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/msmq




MSMQ


The MSMQ adapter allows you to connect to and manage Microsoft MSMQ.


Configuration Settings



This adapter does not use configuration settings.



Handlers



CreateQueue Creates a new private queue details 

Arguments

Name Description Default
queueName R Name of the queue
machine Target machine .
isPrivate Is a private queue True

SQL Call

exec msmq.CreateQueue 'myqueuename'


Http Call

/bsc/msmq/createqueue

Output Columns

Boolean ResultTrue/false indicator if queue was created successfully.
DeleteQueue Deletes a private queue details 

Arguments

Name Description Default
queueName R Name of the queue
machine Target machine .
isPrivate Is a private queue True

SQL Call

exec msmq.DeleteQueue 'myqueuename'


Http Call

/bsc/msmq/deletequeue

Output Columns

Boolean ResultTrue/false indicator if queue was deleted successfully.
IsEmpty Checks for the existence of awaiting messages details 

Arguments

Name Description Default
queueName R Name of the queue
label Optional label to use when checking the queue
machine Target machine .
isPrivate Is a private queue True

SQL Call

exec msmq.IsEmpty 'myqueuename'


Http Call

/bsc/msmq/isempty

Output Columns

Boolean IsEmptyTrue/false indicating if a message is available for reading
ListQueues Returns a list of private queues on a machine details 

Arguments

Name Description Default
machine Target machine .
type "Public", "Private", or "All". All
label Only queues with this label
category An optional Guid that represents the queue category (Message Queuing type identifier), which allows an application to categorize its queues.

SQL Call

exec msmq.ListQueues
SELECT * FROM msmq.Queues WHERE type = 'private'


Http Call

/bsc/msmq/listqueues

Output Columns

Object IdQueue identifier
String MachineNameThe name of the machine on which queue is defined.
String QueueNameThe name that identifies the queue referenced.
String PathThe path on the machine of the queue.
String LabelThe label for the message queue.
String CategoryThe category assigned to the queue.
Int64 MaxQueueSizeThe maximum size, in kilobytes, of the queue. The Message Queuing default specifies that no limit exists.
Int64 MaximumJournalSizeThe maximum size, in kilobytes, of the journal queue. The Message Queuing default specifies that no limit exists.
String MulticastAddressThe multicast address of the queue.
Boolean CanReadtrue (1) if the MessageQueue exists and the application can read from it; otherwise, false (0).
Boolean CanWritetrue (1) if the MessageQueue exists and the application can write to it; otherwise, false (0).
Boolean Transactionaltrue (1) if the queue accepts only messages sent as part of a transaction; otherwise, false (0).
DateTime CreateTimeThe date and time at which the queue was created.
DateTime LastModifyTimeIndicates when the queue properties were last modified.
PeekMessage Peeks the next message from the queue details 

Arguments

Name Description Default
queueName R Name of the queue
timeout Number of seconds to wait before returning 5
label Optional label to use when reading the queue
machine Target machine .
isPrivate Is a private queue True

SQL Call

exec msmq.PeekMessage 'myqueuename'
SELECT * FROM msmq.PeekMessage WHERE queuename = 'myqueuename'


Http Call

/bsc/msmq/peekmessage

Output Columns

String Label
DateTime ArrivedOn
String Id
String CorrelationId
String MessageType
String Priority
String ResponseQueue
DateTime SentTime
String Body
Object Extension
QueueExists Returns true if a queue exists details 

Arguments

Name Description Default
queueName R Name of the queue
machine Target machine .
isPrivate Is a private queue True

SQL Call

exec msmq.QueueExists 'myqueuename'


Http Call

/bsc/msmq/queueexists

Output Columns

Boolean ResultTrue/false indicator of queue existence
ReadMessage Read an awaiting message from the queue details 

Arguments

Name Description Default
queueName R Name of the queue
label Optional label to use when reading the queue
timeout Number of seconds to wait before returning 5
machine Target machine .
isPrivate Is a private queue True

SQL Call

exec msmq.ReadMessage 'myqueuename'
SELECT * FROM msmq.nextmessage WHERE queuename = 'myqueuename'


Http Call

/bsc/msmq/readmessage

Output Columns

String Label
DateTime ArrivedOn
String Id
String CorrelationId
String MessageType
String Priority
String ResponseQueue
DateTime SentTime
String Body
Object Extension
WriteMessage Writes a string message to the queue details 

Arguments

Name Description Default
queueName R Name of the queue
label Optional label to use when writing the message
message R String content to write to the queue
machine Target machine .
isPrivate Is a private queue True

SQL Call

exec msmq.WriteMessage 'myqueuename', null, 'This is a test'


Http Call

/bsc/msmq/writemessage

Output Columns

This call does not return data.