Sign in
< Back to User Guide Top

MQ host

IBM MQSeries (also known as WebSphere MQ or IBM MQ) is a widely used means of guaranteed message delivery.

It uses Queue Managers containing local (and sometimes remote) message queues to send and receive message data. MQSeries uses a store-and-forward mechanism to transport the message data. If the remote Queue Manager is not available, the local Queue Manager retains the message until the remote Queue Manager is ready to receive it. Messages that cannot be delivered can eventually be stored in a dead letter queue.

Messages are put on queues and are generally retrieved on a First-In-First-Out (FIFO) basis. MQSeries also allows the use of a message-priority field (per-message) to put higher-priority messages at the front of the queue. User authentication and message security can also be applied to the sending and receiving channels.

IBM MQSeries includes a Java client API that allows an application (such as the VersaLex application) to programamtically connect to a Queue Manager using server-connection channels to PUT, GET and LIST messages on queues from either a local or remote Queue Manager. These Java client API files are included as part of the VersaLex installation.

There are two ways to access a partner's queues:

  1. Queue Manager to Queue Manager: Messages are written to a remote queue (QR) on the user's local Queue Manager (QMGR1) that maps to a local queue (QL) on the remote Queue Manager (QMGR2). Messages are transported over the internet via uni-directional sender (SDR) and receiver (RCVR) channels. If required, MQSeries automatically converts the data to the target queue manager's understood data format. If the remote queue manager (QMGR2) is unavailable, the sender channel is not running, or the message cannot be delivered for any other reason, the message is retained in either the transmission queue (XMIT) or the dead-letter queue (DLQ) on the local Queue Manager (QMGR1).  The user must implement additional monitoring to periodically check the depth of these queues and take the appropriate action.  

  2. Direct Connection to the Queue Manager: Messages are sent to and received from local queues (QL) on a Queue Manager (QMGR1) using bi-directional server-connection channels (SVRCONN). User authentication and message encryption security (SSL) can be applied to server-connection channels, if desired. This access method does not take advantage of the store-and-forward mechanism; however, if the Queue Manager is not available, an error will occur in the client and the message transport will be re-tried at a later time.  Additionally, if required, the Java MQ client API allows for automatic conversion of the data to the target Queue Manager's understood data format. 

Either of these methods can be used with VersaLex. Using this section, decide which method fits your requirements and configure your Queue Manager(s) and MQ Host appropriately.  

MQ Configuration

Configure an MQ host starting with the generic MQ pre-configured host.

Activate the generic MQ pre-configured host. 
  1. Click the Templates tab in the tree pane.
  2. If necessary, expand the Hosts tree in the Templates tab to find the host you want to use.
  3. Right-click the host and select Clone and Activate. 
    The entire pre-configured host branch (including a mailbox and actions) is copied and activated, the Active tab is selected in the tree pane, and the new active host is selected in the tree.  If necessary, you can append the new active host alias with a number to make it unique. 
    Note: The original pre-configured host remains in the pre-configured tree.
  4. Enter host-level configuration information.
    1. Click the new host in the tree pane.
    2. Enter host-level configuration information on the tabs in the content pane. See MQ Host.
    3. Click Apply to save your work.
  5. Enter mailbox-level configuration information.
    1. Click the mailbox under your host in the tree pane.
    2. Enter mailbox-level configuration information on the tabs in the content pane. See MQ Mailbox.
      Note: By default, the MQ host mailbox is configured to use the same Security settings for Sender and Receiver. To use different settings for Receiver, clear the Use Same Channel for Sender and Receiver check box on the Mailbox > MQSeries tab, and clear the Use Sender's Security Definition check box on the Mailbox > Security > Receiver tab. This enables the fields on the Mailbox > Security > Receiver. See MQ Mailbox: MQSeries Tab and MQ Mailbox: Security Tab.
    3. Click Apply to save your work.
  6. Enter action-level configuration information.
    1. Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and select New Action.
    2. Edit action information on the tabs in the content pane. See MQ Action .
    3. Click Apply to save your work.
  7. Click Apply to save your work.
Configure the host tree, starting with the host, then a mailbox, and finally an action. See MQ Host, MQ Mailbox, and MQ Action.

MQ Host

A host's parameters specify its location and how it is reached.

MQ Host: General Tab

Server Address
Either a fully qualified name (recommended) or an IP address.
This is the address of the server where the MQSeries Queue Manager is installed and running.
Port
The port on the server where your trading partner will receive your messages. If no port number is included in your trading partner's URL, default values are assumed.
Possible values: Either a specific port number or -1 to indicate the default port for the MQSeries Queue Manager (1414)
Default value: 1414
Connection Type
The kind of connection you want to use for this host.
Possible values:
  • System Default - See for information about setting the system default.
  • Direct Internet Access or VPN - Use either a direct connection to the internet or a VPN.
Default value: System Default
Forward Proxy
The address of the forward proxy you want to use for this host.
Select the System Default check box to use the default proxy. See Configuring for a proxy for information about specifying a default proxy.
Default Directories
Modify the default directories, if necessary.  You can use macro variables from the drop-down lists.  See Using Macro Variables for a list of the applicable macros (Default Host Directory context) and example usage.  For the Cleo VLTrader and Cleo Harmony applications, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and Outbox.  See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Note: If the host is has an external association, the default directories might be managed outside of the VersaLex application and not shown here.
Inbox
Default directory for incoming files. Enter a value directly or click … to navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: inbox\
Outbox
Default directory for outgoing files. Enter a value directly or click … to navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: outbox\
Sentbox
If specified, default directory for retaining sent files.  Files are a copy of the original source file; any file manipulations performed as part of the send are not reflected in the sentbox copies. Enter a value directly or click … to navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
Receivedbox
If specified, default directory for retaining received files.  Files are a copy of the final destination file; any file manipulations performed as part of the receive are reflected in the receivedbox copies. Enter a value directly or click … to navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.

MQ Host: MQSeries Tab

Queue Manager
The name of the MQSeries Queue Manager to which you are connecting. This name is case-sensitive and must be entered exactly as it was defined.

MQ Host: Advanced Tab

See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for MQSeries include:

Add Mailbox Alias Directory to Inbox
Appends a subdirectory at the end of the host's configured inbox directory.  This allows files received through different  mailboxes to be kept separate.
Possible values: On or Off
Default value: Off
Add Mailbox Alias Directory to Receivedbox
Appends a subdirectory at the end of the host's configured receivedbox directory.  This allows files that have been sent through different mailboxes to be kept separate.
Possible values: On or Off
Default value: Off
Add Mailbox Alias Directory to Sentbox
Appends a subdirectory at the end of the host's configured sentbox directory.  This allows files that have been sent through different mailboxes to be kept separate.
Possible values: On or Off
Default value: Off
Allow Actions To Run Concurrently
Normally, actions and host actions within the same host are allowed to run concurrently. You can use this property to not allow actions and host actions to run concurrently.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: On or Off
Default value: On
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note: Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values: 0 - n
Default value: 0
Connection Timeout
The amount of time allowed for each read operation.
Possible values: 0 - n seconds

0 indicates no timeout

Default value: 150 seconds
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values: On or Off
Default value: Off
Do Not Send Zero Length Files
Indicates whether zero length files to be sent to the server should be ignored rather than processed. If the -DEL option is being used, any zero length file ignored will also be deleted.
Possible values: On or Off
Default value: Off
Email On Check Conditions Met
Send an email notification after running a CHECK command where the overall conditions of the check are met.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Check Conditions Not Met
Send an email notification after running a CHECK command where the overall conditions of the check are not met. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Fail
If an error occurs during a command, email the error condition.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Flag
If a flagged event occurs, email the event. See Configuring email or execute based on results.
Email addresses separated by commas (,), semicolons (;) or colons (:). The first address should be an internal email address.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Repetitive Action Failures
When "Email On Fail" is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses emailing of the same alert multiple times.  If the same email alert continues to be suppressed after 24 hours, the suppressed email alert will be sent every 24 hours and after every system restart if the failure occurs again. When the failure is resolved an email alert will be sent.
Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values: On or Off
Default value: On
Email On Successful Copy
Send an email notification after copying a file using LCOPY.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Successful Receive
Send an email notification after successfully receiving a file.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Successful Send
Send an email notification after successfully sending a file.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Execute On Check Conditions Met
After executing a CHECK command where the overall conditions are met, run a system command.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Note: Note that if multiple files contribute to the conditions being met, and one of the file macros is in the command (e.g., %file%),  the system command will be executed repeatedly - once for each file.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Check Conditions Not Met
After executing a CHECK command where the overall conditions are not met, run a system command.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Fail
If an error occurs during a command, run a system command.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Repetitive Action Failures

When Execute On Fail is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of the Execute On Fail command.  If suppression of execution of the command for this failure continues after 24 hours, the suppressed Execute On Fail command will be executed every 24 hours and after a system restart if the failure occurs again.  When the failure is resolved, the Execute On Fail command will be executed again.  Users must account for this by including the %status% macro variable for the Execute On Fail command (see Using macro variables) and then checking for a success or failure.    

Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row.  Suppression is not maintained across synchronized hosts.
Possible values: On or Off
Default value: On
Execute On Successful Copy
After successfully copying  a file using LCOPY, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Successful Receive
After successfully receiving a file, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Successful Send
After successfully sending a file, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values: 0 to n characters. 
Special character sequences:
  • \r - carriage return
  • \n - new line (linefeed)
  • \f - form feed
  • \t - horizontal tab
  • \0 - null
  • \\ - backslash
Fixed Record Incoming Delete EOL
If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to look for and delete EOL characters while receiving a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
Possible values: On or Off
Default value: Off
Fixed Record Incoming Insert EOL
If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while receiving a file.

Fixed Record Incoming Delete EOL and Fixed Record Incoming Insert EOL are mutually exclusive properties.

Possible values: On or Off
Default value: Off
Fixed Record Length
The fixed record length after which end-of-line characters need to be inserted and/or deleted.
Possible values: 0 - n
Default value: 0
Fixed Record Outgoing Insert EOL
If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while sending a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
Possible values: On or Off
Default value: Off
High Priority
Indicates whether incoming and/or outgoing transfers through the host should be treated as high priority. When both high priority and regular priority transfers are active, the high priority transfers get a larger portion of the available bandwidth. Go to Configure > Options > Other to set the High Priority Transfers Percentage Available Bandwidth (defaults to 75). See Other system options for more information.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Warning: If the trading partner’s bandwidth (and not Cleo Harmony's or Cleo VLTrader’s) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down other Cleo Harmony or Cleo VLTrader transfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance of Cleo Harmony or Cleo VLTrader is both the client and server (for example, a local looptest).
Possible values:
  • Incoming
  • Outgoing
  • Both
Include Failure In Subject Of Email
When specified, the exception message will be included in the email that is generated on failure.
Note: If the exception message exceeds 256 characters, it will be truncated.
Possible values: On or Off
Default value: The value specified for this property on the Options > Advanced panel
LCOPY Archive
If specified, contains the directory for archiving LCOPY source files.
Possible values: Any local or shared directory. Macros can be used.  See Using macro variables (LCOPY Archive context).
Default value: The value specified for this property on the Options > Advanced panel, if any.
Log Individual LCOPY Results To Transfer Logging
When this option is enabled, a <send> and <receive> result is logged to the transfer log for each file copied.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: On or Off
Default value: Off
Macro Date Format
Specifies the date format to be used when the %date% macro is used.
Possible values: See Using macro variables for information about usage and possible date/time formats.
Default value: The value specified for this property on the Options > Advanced panel, if any.
Macro Time Format
Specifies the time format to be used when the %time% macro is used.
Possible values: See Using macro variables for information about usage and possible date/time formats.
Default value: The value specified for this property on the Options > Advanced panel, if any.
Maximum Incoming Transfer Rate (kbytes/s)
Sets the maximum incoming transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of 0 does not limit the transfer rate. The Maximum Incoming Transfer Rate system setting might also limit the transfer rates. The system Maximum Incoming Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers also affects individual transfer rates. See Advanced system options.
Possible values: 0 - n
Default value: 0
Maximum Outgoing Transfer Rate (kbytes/s)
Sets the maximum outgoing transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of 0 does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate.
Possible values: 0 - n
Default value: 0
MQ Client CCSID

The CCSID (Coded Character Set Identifier) defines the character set of the data written to and read from the MQSeries queues. When the default CCSID of the environment differs from the Queue Manager's native CCSID (for example, when sending from the iSeries IFS where the native CCSID is 37), this setting can be used to convert to and from the desired character formats.

Errors or unexpected results could occur if this value is not set correctly.

Possible values: Any valid CCSID that allows for the correct character encoding of the sent or received message.

The Queue Manager must have a valid conversion table installed to allow encoding to the CCSID. 

When set to either 0 or -1, the native CCSID of the local environment is used.

Default value: 819
Only Retrieve Next Available Message
Indicates a GET * should only retrieve the next available message from the queue.
Possible values: On or Off
Default value: Off
Outbox Sort
Controls the order in which multiple files are transferred for a PUT command.  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.  For Alphabetical ordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique.
Possible values:
  • System Default
  • Alphabetical
  • Date/Time Modified
Default value: System Default
Outgoing Insert EOL Between Interchanges
If Fixed Record Outgoing Insert EOL is active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values: On or Off
Default value: Off
Partner Email Address
The email address of the trading partner for this trading relationship.  When set, this address is automatically used to send your local profile information and/or certificates to your trading partner. See Emailing a profile to your trading partner.
Possible values: Email address(es) separated by commas (,), semicolons (;) or colons ( : ). 
Note: This is a Cleo LexiCom only option. For Cleo Harmony and Cleo VLTrader, this information is stored in the trading partner management table. See Managing Trading Partners.
PGP Compression Algorithm
Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab is in effect.
Possible values:
  • System Default
  • ZIP
  • ZLIB
Default value: System Default
PGP Encryption Algorithm
Encryption method used when OpenPGP packaging (with encryption) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.
Possible values:
  • System Default
  • TripleDES
  • Blowfish
  • CAST5
  • DES
  • AES-128
  • AES-192
  • AES-256
  • Twofish
Default value: System Default
PGP Hash Algorithm
Signing method used when OpenPGP packaging (with signing) is requested through the Configuring mailbox packaging.  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.
Possible values:
  • System Default
  • MD2
  • MD5
  • RIPE-MD-160
  • SHA-1
  • SHA-256
  • SHA-384
  • SHA-512
Default value: System Default
PGP Integrity Check
When OpenPGP encrypting (see Configuring mailbox packaging), include an integrity check on encrypted data. Can be disabled for compatibility with certain OpenPGP implementation.
Possible values: On or Off
Default value: On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values: On or Off
Default value: On
PGP V3 Signature
Retry Delay
The amount of time (in seconds) before a retry should be attempted.
Possible values: Any value greater than zero.
Default value: 60 seconds
Save MQ Trace Info
Specifies that an MQ Series Trace file (logs\MQTrace.dbg) should be generated with each connection to the Queue Manager. This can be useful for debugging purposes.
Possible values: On or Off
Default value: Off
Set Identity Context on Put
Specifies whether the Identity Context should be set for an MQ PUT command. This setting is required for the file name associated with the message to be set in the message's Application identity data field.
Possible values: On or Off
Default value: On
 
Terminate On Fail
If an error occurs during a command, stop the action. 
Note:

Regarding non-CHECK commands:  When Terminate On Fail is on, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and then the action stops.  When Terminate On Fail is off, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and the action continues.

Regarding CHECK commands:  Terminate On Fail is only honored if the ConditionsMet parameter is set and the result of the CHECK is classified as Error. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications.

Possible values: On or Off
Default value: On
Queue Access On Get
Indicates whether multiple actions are allowed to access entries on the queue at the same time or should be blocked from simultaneously accessing the queue.
Possible values: Exclusive or Shared
Default value: Exclusive
Unzip Use Path
Indicates whether or not zip entry paths should be used for LCOPY -UNZIP operations.  When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path. 
Possible values: On or Off
Default value: On
Wait For Execute On
Indicates whether execution should wait for processing to complete within an Execute On Fail, Execute On Successful Copy,Execute On Successful Receive, or Execute On Successful Send command.  Note that this option does not apply to native AS400 execution.
Possible values: On or Off
Default value: On
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging .  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence. 
Possible values:
  • System Default
  • TripleDES
  • AES-128
  • AES-192
  • AES-256
Default value: System Default
Zip Comment
Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
Default value: The value specified for this property on the Options > Advanced panel, if set.
Zip Compression Level
Controls the level of compression for LCOPY -ZIP operations. If System Default is specified, the value set on the Configure > Options > Advanced takes precedence 
Possible values:
  • System Default
  • 9 - (Best Compression)
  • 8
  • 7
  • 6
  • 5
  • 4
  • 3
  • 2
  • 1
  • 0 - (No Compression)
Default value: System Default
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled for LCOPY –ZIP –REC operations.  When enabled, each first-level subdirectory (and all of its descendents) will be bundled together into an individual zip file.  The name of this zip file may optionally reflect the subdirectory name if an asterisk (*) is placed in the destination path.  Any files that are directly off the source root directory will not be copied. 
Possible values: On or Off
Default value: On

MQ Mailbox

A mailbox's parameters allow you access to the host system. Create a new mailbox under the host.

  1. Right-click the MQ host in the active tree pane.
  2. Select New Mailbox to create a new lower branch.
  3. Optionally, type a new alias in the content pane panel.
  4. Click Apply.

MQ Mailbox: MQSeries Tab

Use Same Channel for Sender and Receiver
Select the check box to indicate the same Server-Connection channel is being used for sending and receiving messages from queues on the Queue Manager.
Force Upper Case on Queues and Channels
Select the check box to automatically convert all queue and channel names to upper case. Queue and channel names are case-sensitive and must be entered exactly as they have been defined in the Queue Manager.
Sender
Queue
The name of the queue from which you will send messages. 
Channel
The name of the channel used to connect to the Queue Manager. This channel must be a Server-Connection channel in order to successfully connect to the Queue Manager from the VersaLex application. If you selected Use Same Channel for Sender and Receiver, the same channel name is used for both sending and receiving.
User Name
Password
Optional. These values can be provided to you by the administrator of MQSeries Queue Manager.
Receiver
Queue
The name of the queue where you will receive messages.
Channel
The name of the channel used to connect to the Queue Manager. This channel must be a Server-Connection channel in order to successfully connect to the Queue Manager from the VersaLex application. If you selected Use Same Channel for Sender and Receiver, the same channel name is used for both sending and receiving.
Message Priority
The message priority to be applied when you PUT a message on a queue. By default, the message priority is 0 and all messages are written to the queue in a first in first out (FIFO) order. However, messages with a higher priority are placed ahead of lower priority messages in the queue.
Populate ReplyToQ Field
Select the check box to set the specified queue name (either the Receiver Queue name or any other queue name) in theReplyToQ field of the message descriptor of messages sent by the VersaLex application. Since the application only sends datagram messages, typically this field is used to notify your trading partner of your configured Receiver Queue and is not intended for receipt of report messages. The application does not monitor this field and will not issue report or reply messages. 
Note: The VersaLex application always leaves the ReplyToQMgr field in the message descriptor blank. When this occurs the queue manager will set the contents of the following fields in the message descriptor on the queue:
  • ReplyToQ - If the queue is a local definition of a remote queue, the ReplyToQ field is set to the name of the remote queue; otherwise this field is not changed.
  • ReplyToQMgr - If value in the ReplyToQ field is a local definition of a remote queue, the ReplyToQMgr field is set to the name of the queue manager that owns the remote queue; otherwise the ReplyToQMgr field is set to the name of the queue manager to which the VersaLex application is connected.

MQ Mailbox: Security Tab

The Security tab contains two sub tabs: Sender and Receiver. While both tabs contain the same fields, the fields on the Receiver tab are not editable by default.

Use Sender’s Security Definition
Note: This field is available only on the Receiver tab and is activated only when you clear the Use Same Channel for Sender and Receiver check box on the mailbox MQSeries panel .
Select the Use Sender’s Security Definition check box to use the same settings as on the Sender tab. Clear the check box to enable the rest of the fields on the Security > Receiver tab, where you can specify security setting for the Receiver.
Enable Secure Connection
Enables the rest of the fields in the tab. Select the check box if the server-connection channel is using SSL message encryption. If you are provided with a server certificate for the MQSeries Queue Manager, copy it to the certs subdirectory of the VersaLexproduct. If this is not provided, a dialog box is displayed when you connect to the Queue Manager to allow you to trust the server certificate provided by the Queue Manager per connection session or permanently.
MQ SSL Cipher Spec
Select the spec provided to you by the MQSeries Queue Manager administrator. The list of available cipher specs supported by the VersaLex application requires that the Queue Manager be running with the latest IBM PTF. It is not guaranteed, however, that all cipher specs in the list will be supported by the version of the Queue Manager to which you are connecting.
Authenticate Client
Enables the Client Certificate fields. Select the check box if the server-connection channel used to transport your messages requires client authentication. In this case, you must also provide a client certificate that will be installed in the Queue Manager's key repository to authenticate your connection. 
Certificate Alias
Password
Alias and password for the certificate you created for this server-connection channel. See Certificate management for more information on creating a client certificate.

MQ Action

An action's parameters capture a repeatable transaction for your mailbox on the host system. Create a new  action under the  mailbox.

MQ Command Reference

CHECK

See CHECK Command for information about this command.

CLEAR

Clear an action property string value. The cleared value only affects the commands that follow the CLEAR.

CLEAR property
property
Action property name with no embedded spaces.

Comment

# text...

Lines in the action starting with a # character are considered comments and will be ignored when the action executes. Lines starting with # are generally used for documentation purposes.

DIR

Get a directory listing of available files from the host.

DIR "source" "destination"
"source"
Identifies the queue from which the messages are to be listed. 
  • This queue must be "GET-enabled" on the target Queue Manager and can only be used to list the contents of queues that are defined as "Local" queues.
  • "Remote" queues cannot be used to obtain directory listings. 
  • If not specified, the default receiver queue applies but may be overridden with the SET command. (Use a * as a place-holder when specifying the default queue and a "destination".)
"destination"
Optional path where the listing of the queue is to be written.
  • If no destination is specified, the listing is logged rather than saved to a file.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

GET

Receive one or more files from the host.

GET -DEL –UNI|-APE "source" "destination"
-DEL
If the command is successful, delete host files. If the DELETE command is not supported on the server, the argument is not applicable and cannot be used. See HTTP Configuration.
-UNI
Ensure the copied filename is unique.
-APE
If local filename exists, append copied file to existing file.
"source"
Remote source path
  • You can specify * to receive all the messages currently on the queue. 
  • You can specify a particular message ID (in hexadecimal form), displayed in the directory listing (with a msgId= tag) to receive a specific message from the queue.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
Note: The source always applies to the receiver queue if not overridden by the SET command. 
"destination"
Local destination path.
  • Path can be to a filename (unless the -DIR option is used) or to a directory.
  • If you specify no path or a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Destination File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LCOPY

Copy one or more files locally.

LCOPY –DEL -REC {–UNI|–APE} {-ZIP|-UNZ} "source" "destination"
-DEL
If the command is successful, delete the local file.
-REC
Recursively search all subdirectories.
You cannot use this option with the -UNZ option.
-UNI
Ensure the copied filename is unique.
-APE
Append copied file to existing destination file.
-ZIP
Zip all the files into one or more ZIP archive files, depending on the destination specified.
  • Specify ZIP comment and compression level through Zip Comment and Zip Compression Level properties. See Setting advanced host properties.
  • The ZIP archive files created through the LCOPY command conform to the standard ZIP file format. Visit http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html. The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the VersaLex application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
  • In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Cryptographic Services.
-UNZ
Unzip the source file(s).
  • All source files must be ZIP archive files.
  • You cannot use this option with the -REC option.
  • Use ZIP entry paths if Unzip Use Path is set. See Setting advanced host properties.
  • The ZIP archive files created through the LCOPY command conform to the standard ZIP file format (reference http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html). The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
  • In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Encryption of Zip Files for more information on this capability.
"source"
Source path
  • Path can be to a filename or to a directory
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
Destination path.
  • Path can be to a filename or to a directory.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
  • You can use a single * within the destination path. In this context, it is not a wildcard. Rather, it is used to substitute a source file name or a source subdirectory name. When * is used in conjunction with both the -REC and -ZIP options, and Zip Subdirectories Into Individual Zip Files is enabled, then * is substituted with each first-level subdirectory name. When* is not used for bundling zipped subdirectories, then it is used as a shortcut for the %sourcefilename% or %srcfilename%macro. Only one * is allowed in the destination path. See Setting advanced host properties.
  • When copying a file without the -APE option, or when copying a file with the -APE option where the destination file does not already exist, a temporary file name is used while the copy operation is taking place. This temporary file is placed in the destination directory. Its name begins with the product name and ends with .tmp. Once the copy completes successfully, the temporary file is renamed to the destination name.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LDELETE

Delete one or more files locally.

LDELETE "source"
"source"
Source path.
  • Path can be a filename or a directory.
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default inbox.
  • Use of macro variables is supported. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LREPLACE

Replace bytes in one or more files locally.

LREPLACE "source" Replace="input bytes" With="output bytes"
"source"
Source path.
  • Path can be to a filename or to a directory.
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"input bytes"
List of bytes to be replaced.
  • Comma separated list of byte values (0-255).
  • All bytes in comma-separated list must be found in the file in listed sequence in order to be replaced.
"output bytes"
List of bytes to be substituted for original input bytes.
  • Comma separated list of byte values (0-255).
  • If With parameter is omitted, then the input bytes are deleted from the file.

PUT

Send one or more files to the host.

PUT -DEL "source"
DEL
If PUT is successful, delete local file.
-DEL option is not applicable to queue-based PUT commands.  If specified for a queue-based PUT, it is ignored.
source

Source path

  • source parameter is not applicable to queue-based PUT commands.  If specified for a queue-based PUT, it is ignored.
  • Path can be to a filename or to a directory.
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default outbox.
  • Use of macro variables is supported. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
Note:

The default sender queue is the destination but can be overridden with a SET command.

All messages are PUT on queues with a persistence of Persistent even if the sender queue was created as Not Persistent.

SCRIPT

See SCRIPT command for information about this command.

SET

Change an action property value. The new value only affects the commands that follow the SET.

SET property=value
property = value
Action property and new value
  • The property name must have no embedded spaces.
  • The value specified remains in effect until it is set again or until the end of action.  
  • To reset property back to default value (host-level or system-level), specify 
    SET property

    or

    SET property=
  • To clear a string property, use the CLEAR command

WAIT

Pause execution.

WAIT seconds
Seconds
Number of seconds to pause.

Related articles

Comments

0 comments

Please sign in to leave a comment.