Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [MQSeries] >  [OutboundAdapter]
Private  Storage   

class EnsLib.MQSeries.OutboundAdapter extends Ens.OutboundAdapter

This adapter is for connecting to IBM WebSphere MQ.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 8 4


Summary

Properties
%CredentialsObj %WarnedLatest %initQueueNeeded %tempStream
BusinessHost Channel CharSet Credentials
ErrorFile KeepaliveInterval QueueManager QueueName
RegistryID

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AssignOneSetting ClearAllAppData ClearRuntimeAppData ClearStaticAppData
CredentialsSet EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch
GetSettings InitQueue OnInit OnKeepalive
OnTearDown SendMessage


Parameters

• parameter SETTINGS = "QueueManager:Basic,Channel:Basic,QueueName:Basic,CharSet,ErrorFile:Dev";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property %initQueueNeeded as %Boolean [ InitialExpression = 0 ];
This is set if the queue needs to be initialized again after the job has started. Default is 0 since OnInit() calls initialize and the job will not start if not successful.
• property %tempStream as %Stream.FileCharacter;
Temp storage for %PutStream
• property Channel as %String(MAXLEN=256);
The specification for the channel, in the following form: "channel_name/transport/host_name(port)". Transport can be one of the following: TCP, LU62, NETBIOS, SPX

If you omit this setting, the system uses the default channel specification, as configured in IBM WebSphere MQ. Or, if the system has been the configured so that the channel is determined by the queue name, the system uses the channel that is appropriate for the given queue name.

• property CharSet as %Integer;
This setting specifies the IBM Coded Character Set Id that the messages are already in; no conversion is done based on this selection
• property ErrorFile as %String(MAXLEN=1023);
Specifies the log file to write error messages to.

If you omit this setting, no logging occurs.

• property QueueManager as %String(MAXLEN=256);
If you omit this setting, the system uses the default queue manager, as configured in IBM WebSphere MQ. Or, if IBM WebSphere MQ has been the configured so that the queue manager is determined by the queue name, the system uses the queue manager that is appropriate for the given queue name.
• property QueueName as %String(MAXLEN=256);
(Required) Specifies the queue name; this should be a valid queue for the specified queue manager. Also, you must have permission to use this queue.

Methods

• method InitQueue() as %Status
This user callback method is called before first message is sent and after if reconnect is needed
• method OnInit() as %Status
This user callback method is called just after %OnNew()
• method OnTearDown() as %Status
This user callback method is called just before %OnClose()
• method SendMessage(pBody As %String, pMsgId As %String = "") as %Status
Sends an MQ Series message. Note that pBody can be either a simple datatype (string) or a character stream


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.