ConfiguringJavaCAPSProject ComponentsforApplication Adapters · ConfiguringJavaCAPSProject...

Configuring Java CAPS ProjectComponents for ApplicationAdapters

Sun Microsystems, Inc.4150 Network CircleSanta Clara, CA 95054U.S.A.

Part No: 820–4407June 2008

Copyright 2008 Sun Microsystems, Inc. 4150 Network Circle, Santa Clara, CA 95054 U.S.A. All rights reserved.

Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and withoutlimitation, these intellectual property rights may include one or more U.S. patents or pending patent applications in the U.S. and in other countries.

U.S. Government Rights – Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisionsof the FAR and its supplements.

This distribution may include materials developed by third parties.

Parts of the product may be derived from Berkeley BSD systems, licensed from the University of California. UNIX is a registered trademark in the U.S. and othercountries, exclusively licensed through X/Open Company, Ltd.

Sun, Sun Microsystems, the Sun logo, the Solaris logo, the Java Coffee Cup logo, docs.sun.com, Java, and Solaris are trademarks or registered trademarks of SunMicrosystems, Inc. or its subsidiaries in the U.S. and other countries. All SPARC trademarks are used under license and are trademarks or registered trademarks ofSPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.

The OPEN LOOK and SunTM Graphical User Interface was developed by Sun Microsystems, Inc. for its users and licensees. Sun acknowledges the pioneering effortsof Xerox in researching and developing the concept of visual or graphical user interfaces for the computer industry. Sun holds a non-exclusive license from Xerox tothe Xerox Graphical User Interface, which license also covers Sun's licensees who implement OPEN LOOK GUIs and otherwise comply with Sun's written licenseagreements.

Products covered by and information contained in this publication are controlled by U.S. Export Control laws and may be subject to the export or import laws inother countries. Nuclear, missile, chemical or biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Exportor reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and speciallydesignated nationals lists is strictly prohibited.

DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANYIMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TOTHE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

090911@22749

Contents

1 Configuring Java CAPS Project Components for Application Adapters .......................................5Configuring Java CAPS Adapter Connectivity Map Properties .......................................................5

Using the Properties Editor ...........................................................................................................6Configuring the Adapter Connectivity Map Properties .............................................................6

Configuring Oracle Applications Adapter Connectivity Map Properties .......................................7Properties in the Outbound Oracle Applications Adapter ........................................................7

Configuring PeopleSoft Adapter Connectivity Map Properties .......................................................8PeopleSoft Adapter Connectivity Map Properties ......................................................................8Selecting PeopleSoft HTTP Client or PeopleSoft HTTP Server as the ExternalApplication ................................................................................................................................... 11

Configuring SAP BAPI Adapter Connectivity Map Properties ..................................................... 11Configuring the Inbound SAP BAPI Adapter Properties ....................................................... 11Configuring the Outbound SAP BAPI Adapter Properties .................................................... 13

Configuring Siebel EAI Adapter Connectivity Map Properties .................................................... 16Inbound Siebel Adapter Connectivity Map Properties ........................................................... 16Outbound Siebel Adapter Connectivity Map Properties ........................................................ 17

Configuring SWIFT Alliance Gateway Adapter Connectivity Map Properties .......................... 19SWIFT Alliance Gateway Adapter Connectivity Map Properties ......................................... 19Selecting SWIFT Alliance Gateway as the External Application ............................................ 32

WebSphere MQ Adapter Connectivity Map Properties ................................................................. 33Inbound WebSphere MQ Adapter Connectivity Map Properties ......................................... 33Outbound WebSphere MQ Adapter XA Connectivity Map Properties ............................... 41Outbound WebSphere MQ Adapter Connectivity Map Properties ...................................... 47

3

Configuring Java CAPS Project Components forApplication Adapters

The following topics provide instructions on how to configure Java CAPS project componentsfor application adapters:

■ “Configuring Java CAPS Adapter Connectivity Map Properties” on page 5.■ “Configuring Oracle Applications Adapter Connectivity Map Properties” on page 7.■ “Configuring PeopleSoft Adapter Connectivity Map Properties” on page 8.■ “Configuring SAP BAPI Adapter Connectivity Map Properties” on page 11.■ “Configuring Siebel EAI Adapter Connectivity Map Properties” on page 16.■ “Configuring SWIFT Alliance Gateway Adapter Connectivity Map Properties” on page 19.■ “WebSphere MQ Adapter Connectivity Map Properties” on page 33.

Configuring Java CAPS Adapter Connectivity Map PropertiesThis topic describes how to set the connectivity map properties for Java CAPS Adapters.

All adapters contain a unique set of default configuration parameters. After the adapters areestablished and an External System is created in the Project’s Environment, the adapterparameters are modified for your specific system. Adapter configuration parameters aremodified from the following locations:

■ Connectivity Map: These parameters most commonly apply to a specific componentadapter, and may vary from other adapters (of the same type) in the Project.

■ Environment Explorer: These parameters are commonly global, applying to all adapters (ofthe same type) in the Project. The saved properties are shared by all adapters in the ExternalSystem window.

■ Collaboration or Business Process: Adapter properties may also be set from yourCollaboration or Business Process, in which case the settings will override thecorresponding properties in the adapter’s Connectivity Map configuration. Any propertiesthat are not overridden retain their configured default settings.

1C H A P T E R 1

5

Using the Properties EditorYou can modify the current adapter configuration properties from the Adapter PropertiesEditor.

To modify the adapter properties, perform the following:

1. Open the Properties Editor for the adapter you want to edit. An Adapter has two sets ofparameters: those specific to that particular adapter (accessed from the Connectivity Map),and those that are common to all adapters of this type (accessed from the EnvironmentExplorer tree).

2. From the upper-left pane of the Properties Editor, select a properties directory from theConfiguration tree. The parameters contained in that directory are now displayed in theright pane of the Properties Editor. For example, from the outbound adapter ConnectivityMap Properties, click on Transport to display this section’s editable parameters in the rightpane.

3. Click on any property field to make it editable. For example, click on the Read From RACFG File parameter to edit the Read From RA CFG File value. If a parameter’s value is trueor false or multiple choice, the field, when selected, reveals a submenu of property options. Ifa parameter requires you to type in a value, such as a name or password, the property fieldprovides space to type in the value and an ellipsis (. . .) button.

4. Click on the ellipsis (. . .) in the properties field to open a separate configuration dialog box.This is helpful for entering large values that cannot be fully displayed in the parameter’sproperty field.

5. Enter the property value in the dialog box and click OK. The value is now displayed in theproperty field.A description of each parameter is displayed in the Description pane when that parameter isselected, providing an explanation of any required settings or options.

6. The Comments pane provides an area for recording notes and information regarding thecurrently selected parameter. This is saved for future reference.

7. After modifying the configuration properties, click OK to close the Properties Editor andsave the changes.

Configuring the Adapter Connectivity Map PropertiesWhen you connect an External Application to a Collaboration, Netbeans IDE automaticallyassigns the appropriate adapter to the link. Each adapter is supplied with a template containingdefault configuration properties that are accessible on the Connectivity Map.

Adapters can be configured for inbound and/or outbound modes in a Connectivity Map.

Configuring Java CAPS Adapter Connectivity Map Properties

Configuring Java CAPS Project Components for Application Adapters • June 20086

▼ To Configure the Inbound Adapter Properties

On the Java CAPS IDE’s Connectivity Map, double-click the Adapter icon.The adapter Properties window appears, displaying the default properties for the Inboundadapter. The properties default to the correct adapter direction.

▼ To Configure the Outbound Adapter Properties

On the Connectivity Map, double-click the Adapter icon.The adapter Properties window appears, displaying the default properties for the Outboundadapter. The properties default to the correct adapter direction.

Configuring Oracle Applications Adapter Connectivity MapProperties

The following section provides information on configuring Oracle Applications Adaptercomponents, “Properties in the Outbound Oracle Applications Adapter” on page 7.

Properties in the Outbound Oracle ApplicationsAdapterThe JDBC Connector Settings section of the Oracle Applications Connectivity Map propertiescontains the top-level parameters displayed in the following table.

TABLE 1–1 Outbound Connectivity Map JDBC Connector Settings

Name Description Required Value

Description Specifies the description for the database. A valid string.

The default is Oracle thin driverConnection Pool Datasource.

ClassName Specifies the Java class in the JDBC driverthat is used to implement theConnectionPoolDataSource interface.

A valid class name.

The default value isoracle.jdbc.pool.OracleConnectionPoolDataSource.

Properties in the Outbound Adapter with XA SupportThe JDBC Connector Settings section of the Oracle Applications Connectivity Map propertiescontains the top-level parameters displayed in the following table.

●

●

Configuring Oracle Applications Adapter Connectivity Map Properties

Chapter 1 • Configuring Java CAPS Project Components for Application Adapters 7

TABLE 1–2 Outbound with XA Support JDBC Connector Settings


Description Specifies the description for the database. A valid string.

The default is Oracle thin driver XADatasource.

ClassName Specifies the Java class in the JDBC driverthat is used to implement theConnectionPoolDataSource interface.

A valid class name.

The default value isoracle.jdbc.xa.client.OracleXADataSource.

Configuring PeopleSoft Adapter Connectivity Map PropertiesThis topic describes how to set the PeopleSoft connectivity map properties and select thePeopleSoft HTTP Client or PeopleSoft HTTP Server as the External Application.

■ “PeopleSoft Adapter Connectivity Map Properties” on page 8.■ “Selecting PeopleSoft HTTP Client or PeopleSoft HTTP Server as the External Application”

on page 11.

PeopleSoft Adapter Connectivity Map PropertiesThe PeopleSoft Adapter includes two component adapters:

■ “PeopleSoft HTTP Client Connectivity Map Properties” on page 8 — The PeopleSoftHTTP Client Adapter includes both Connectivity Map and Environment properties andmust be configured from both locations.

■ “PeopleSoft HTTP Server Connectivity Map Properties” on page 9 — The PeopleSoftHTTP Server Adapter includes only Connectivity Map properties. There are noEnvironment properties.

Once a component adapter and the Environment (with the external systems) have been created,the properties can be modified for your specific system.

PeopleSoft HTTP Client Connectivity Map PropertiesThe PeopleSoft HTTP Client Adapter properties, accessed from the Connectivity Map, areorganized into the following section, “HTTP Settings” on page 9.

Note – SSL and proxy configurations (HTTPS) are not supported in this release.

Configuring PeopleSoft Adapter Connectivity Map Properties


HTTP Settings

The HTTP Settings section of the PeopleSoft HTTP Client Adapter Connectivity Mapproperties contains the top-level parameters displayed in the following table.

TABLE 1–3 Connectivity Map - HTTP Settings


Allow cookies Specifies whether cookies sent fromservers are allowed to be stored andsent on subsequent requests. Ifcookies are not allowed, sessions arenot supported.

True or False.■ True indicates that cookies

sent from the server areallowed.

■ False indicates that Cookiesare not accepted.

The configured default is True.

Accept type Specifies the default Accept-Typeheader value included when a requestis sent to the server; for example,text/html, text/plain, text/xml.

An Accept-type header value.

The configured default is text/xml.

Caution – Calling the clear() method in the Collaboration Editor clears all HTTP properties.Once the properties have been cleared, you must manually rebuild the header and payloadsections of the Request message in the Transformation Designer.

PeopleSoft HTTP Server Connectivity Map PropertiesThe PeopleSoft HTTP Server Adapter properties, accessed from the Connectivity Map, areorganized into the following section, “HTTP Server External Configuration” on page 9.

Note – The PeopleSoft HTTP Server Adapter does not possess Environment properties.

HTTP Server External Configuration

The HTTP Server External Configuration section of the PeopleSoft HTTP Server AdapterConnectivity Map properties contains the top-level parameters displayed in the following table.



TABLE 1–4 Connectivity Map - HTTP Server External Configuration


servlet-url Specifies the last path component of theHTTP server servlet URL. This URL is theone the client uses to access the server. Theproperty value must be the servlet name, forexample, HttpServerServlet. The total URLis made up of several components, includingthe Project deployment name and the valueentered for this property.

The servlet name must match the PrimaryURL property on the PeopleSoft server.

For example, a complete servlet URLappears as follows:

http://<yourmachinename>:18001/<yourdeploymentname>_servlet_<servletname><servletname>

Where,■ yourmachinename is the name of the

machine where your currentApplication Server is running.

■ 18001 is the port number specified asthe connector port in the IntegrationServer properties (IS Configurations—> Sections —> Web ContainerConfiguration —> Web ServerConfigurations —> Default WebServer —> Connector Port).

■ yourdeploymentname is the name ofyour current Project’s DeploymentProfile concatenated with _servlet.

■ servletname is the name of thePeopleSoft servlet. This is the valueneeded for this property.

Note – The servlet-url parameter does notsupport LDAP values.

Enter the name of the PeopleSoftServlet. This is the last path componentof the HTTP server servlet URL.



Selecting PeopleSoft HTTP Client or PeopleSoft HTTPServer as the External ApplicationTo create a PeopleSoft HTTP Client Adapter you must first create a PeopleSoft HTTP ClientExternal Application in your Connectivity Map. PeopleSoft HTTP Client adapters are locatedbetween a PeopleSoft HTTP Client External Application and a Service. Services are containersfor Java Collaborations, Business Processes, and so forth.

▼ To Create a PeopleSoft External Application

From the Connectivity Map toolbar, click the External Applications icon.

Select the PeopleSoft HTTP Client External Application from the menu. The selected PeopleSoftHTTP Client External Application icon appears on the Connectivity Map toolbar.

Note – The PeopleSoft HTTP Server External Application is similarly created.

Configuring SAP BAPI Adapter Connectivity Map PropertiesWhen you connect an External Application to a Collaboration, Java CAPS IDE automaticallyassigns the appropriate Adapter to the link. Each Adapter is supplied with a template containingdefault configuration properties that are accessible on the Connectivity Map. The followingsections provide information on configuring SAP BAPI Adapter components:

■ “Configuring the Inbound SAP BAPI Adapter Properties” on page 11.■ “Configuring the Outbound SAP BAPI Adapter Properties” on page 13.

Configuring the Inbound SAP BAPI Adapter PropertiesThe Inbound Adapter Properties include parameters required to receive data from SAP R/3into Java CAPS. The following server connection settings are configured in the InboundAdapter Properties window.

1

2

Configuring SAP BAPI Adapter Connectivity Map Properties


Server Connection SettingsThe following Server Connection Settings are used by the external database.

TABLE 1–5 Inbound Adapter—Server Connection Settings


Enable RFC Trace You enable RFC tracing with the EnableRFC Trace property. The trace file containsRFC API calls, and data sent to and receivedfrom the SAP R/3 host. The trace file isrfcnumber.trc.

For example, rfc00310_0156.trc

Yes or No.

The default mode is No; the RFC tracingis disabled.

If the Enable RFC Trace parameter is setto Yes, then it creates both the JCo andRFC Trace logs. Both are created in thesame location under:

appserver\domains\domain1\

config

The JCoTrace log provides JavaRuntime, version, and pathinformation. It also provides a manifest.

If Enable RFC Trace parameter is set toNo, then no trace file is generated.

RFC Trace Level Trace level specifies the complexity of theinformation in the trace file. 0 providesminimal trace logging and 5 provides themaximum trace logging of diagnosticinformation in the trace file.

Integer value from 0 (min) to 5 (max).

The default number is 0.

The Enable RFC Trace level only affectsthe JCo trace level. It has no effect on theRFC trace level.

Number of RFCServers to create

Specify the number of RFC servers to create.The created RFC servers facilitate parallelprocessing when receiving multiple requestsfrom SAP R/3.

A valid integer value.


Transaction Mode Specifies the transaction mode. Thetransaction mode specifies whether tRFC isenforced. With RFC, transactions haveunique TIDs and are processed only once bythis Adapter.

A transaction mode ofNon-Transactional or TransactionalRFC(tRFC).

The default mode isNon-Transactional.



TABLE 1–5 Inbound Adapter—Server Connection Settings (Continued)Name Description Required Value

Transaction IDVerificationDatabase

Specifies the location of the Transaction IDVerification database.

Specify the name of the file-based databasewhich persists the TIDs. Provide the path tothe database file that records the dispositionof all transactions outgoing from thisAdapter. The database records whethertransactions are:■ C (committed)■ U (unprocessed or rolled-back)■ R (reserved or pending)

A valid path to the database file.

For example, the default location is:

C:\JavaCAPS6\data\SapTRFC.TIDdb

Configuring the Outbound SAP BAPI AdapterPropertiesThe Outbound Adapter Properties include parameters required to communicate from JavaCAPS to SAP/R3. The following server connection settings are configured in the OutboundAdapter Properties window.

Client Connection SettingsThe following Client Connection Settings are used by the outbound adapter:

TABLE 1–6 Outbound Adapter—Client Connection Settings


Client ConnectionMode

Determines the type of client connection touse when logging onto SAP R/3.

Automatic or Manual.

The default mode is Automatic.



TABLE 1–6 Outbound Adapter—Client Connection Settings (Continued)Name Description Required Value

Enable RFCTrace

You enable RFC tracing with the Enable RFCTrace property. The trace file isrfcnumber.trc.

For example, rfc00310_0156.trc

Yes or No.

The default mode is No; the RFCtracing is disabled.

Setting the Enable RFC Traceparameter to Yes creates both the JCoand RFC Trace logs. Both are createdin the same location under:

appserver\domains\domain1\

config

The JCoTrace log provides JavaRuntime, version, and pathinformation. It also provides amanifest.

If Enable RFC Trace is set to No, thenno trace file is generated.

RFC TraceLevel

Trace level specifies the complexity of theinformation in the trace file. 0 providesminimal trace logging and 5 provides themaximum trace logging of diagnosticinformation in the trace file.

Integer value from 0 to 5.


The Enable RFC Trace level onlyaffects the JCo trace level. It has noeffect on the RFC trace level.




Transaction Mode Specifies the transaction mode.■ Non-Transactional

■ Actions performed by BAPI call arecommitted immediately andautomatically by SAP R/3 (autocommit). In this mode, use theexecute() method in the OTD.

■ Transactional RFC (tRFC)

■ Adapter communicates with SAP R/3using unique transaction IDs (TID) toavoid message repeats. Use theexecuteAsynchronous(eid) methodin the OTD in this mode.

■ VIA COMMIT/ROLLBACK BAPI

■ Performs a single phase commit,where actions performed by BAPIcalls are committed or rolled back bycallingBAPI_TRANSACTION_COMMITorBAPI_TRANSACTION_ROLLBACK.In this mode you must use the commitand rollback methods on theBAPI/RFC OTD.

A transaction mode ofNon-Transactional or TransactionalRFC(tRFC) or VIACOMMIT/ROLLBACK BAPI.

The default mode isNon-Transactional.

Transaction IDVerificationDatabase

Specifies the location of the Transaction IDVerification database.

Specify the name of the file-based databasewhich persists the TIDs. Provide the path tothe database file that records the disposition ofall transactions outgoing from this Adapter.The database records whether transactions are:■ C (committed)■ U (unprocessed or rolled-back)■ R (reserved or pending)

A valid path to the database file.

For example, the default locationcould be:

C:\JavaCAPS6\data\SapTRFC.TIDdb




Maximum TIDDatabase Rows

Specifies the maximum amount of rows for theTransaction ID (TID) database for outboundadapters.

Set this property only if tRFC is used. Thisproperty specifies the maximum number ofrows in the outbound TID database that arekept before the oldest rows are purged andtheir corresponding TIDs confirmed on SAPR/3. Confirmation allows SAP R/3 to removethose TIDs from its TID tracking database andreduce resource consumption.

At least a single row.

The default is 200 rows.

Enable ABAPDebug Window

Enables the ABAP debugging window.

Enabling the Enable ABAP Debug Windowproperty opens the ABAP debugging windowon the Application Server. The window showsthe debug information for the RFC-enabledABAP application that is called by SAP R/3.

This property only works if the SAPGUIsoftware is installed on the Application Server.

Yes or No.

The default mode is No; the ABAPDebug window is disabled.

Use LoadBalancing

Enables load balancing for outbound adapters.

This property allows you to take advantage ofthe workload balancing provided by SAP R/3.SAP R/3 provides workload balancing toautomatically route requests to the SAPapplication server within a group of serversthat has the best response time determined atthat moment by an SAP message server.

If you disable load balancing, use the Systemnumber property.

Yes or No.

The default mode is No; loadbalancing is disabled by default.

Configuring Siebel EAI Adapter Connectivity Map PropertiesThis task describes how to set the connectivity map properties of the Siebel EAI Adapter.

Inbound Siebel Adapter Connectivity Map PropertiesDetails for Siebel servlet configuration are listed in the table.

Configuring Siebel EAI Adapter Connectivity Map Properties


TABLE 1–7 Outbound Adapter—Siebel Servlet Configuration


eWay URL Mapping A pattern that defines the set of URLs thatthe eWay services.

Note – LDAP values are not supported.

A valid string.

The default is /eaiservice/*.

Request Timeout The maximum time, in milliseconds, that arequest remains incomplete before theAdapter voids the request.

An integer.

To indicate that the Adapter should waitindefinitely for completion, specify 0(zero).

ImmediateAcknowledgment

An indicator of whether the Adapterresponds to a request immediately or if itdelegates that responsibility to the service orCollaboration to which requests are routed.

True or false.

Specify true if the Adapter shouldrespond immediately. Otherwise,specify false.

Outbound Siebel Adapter Connectivity MapPropertiesThe adapter Connectivity Map consists of the following properties categories.

■ “Siebel EAI Settings” on page 17■ “HTTP Settings” on page 18

The adapter property settings define how the properties are used to interact with the Siebelapplication.

Siebel EAI SettingsDetails for Siebel EAI settings are listed in the table.



TABLE 1–8 Outbound Adapter—Siebel EAI Settings


SWEExtSource Specifies the service that the Siebel WebEngine calls.

A valid string.

The default isSEEBEYOND_HTTP_UPDATE.

Other values may include:■ SEEBEYOND_HTTP_DELETE■ SEEBEYOND_HTTP_EXECUTE■ SEEBEYOND_HTTP_QUERY■ SEEBEYOND_HTTP_UPDATE

SWEExtCmd Specifies the external command. A valid entry.

The default is Execute.

HTTP SettingsDetails for HTTP settings are listed in the table.

TABLE 1–9 Outbound Adapter—HTTP Settings


Allow cookies Specifies whether or not cookies sent fromservers is stored and sent on subsequentrequests. If cookies are not allowed, thensessions are not supported.

True or False.

The default is True.

Content type Specifies the default Content-Type headervalue to include when sending a request tothe server.

Accept type Specifies the parameters for the Accept Typerequest header.

Any valid string.

For example,■ text/html■ text/plain■ text/xml

Encoding Specifies the default encoding used whenreading or writing textual data.

ASCII.



Configuring SWIFT Alliance Gateway Adapter ConnectivityMap Properties

This topic describes connectivity map properties of the SWIFT Alliance Gateway adapter andhow to configure the SWIFT Alliance Gateway as an External Application.

■ “SWIFT Alliance Gateway Adapter Connectivity Map Properties” on page 19.■ “Selecting SWIFT Alliance Gateway as the External Application” on page 32.

Note – Modifying individual OTD configuration settings can override the default adapter OTDconfiguration settings.

For more information on SWIFT Alliance Gateway configuration properties in the context ofSWIFT Alliance Gateway, refer to the SWIFT Alliance Gateway and SNL user documentationprovided by SWIFT.

SWIFT Alliance Gateway Adapter Connectivity MapPropertiesThe SWIFT AG Adapter Connectivity Map Properties include the following parametersections:

■ “Envelope” on page 19.■ “Primitive Control” on page 20.■ “RemoteApi Base settings” on page 21.■ “InterAct Client” on page 22.■ “InterAct Client with Store and Forward” on page 24.■ “FileAct Client” on page 25.■ .“FileAct Client with Store and Forward” on page 28.■ .“FileAct Client with Get File” on page 29.■ .“FileAct Client with Put File” on page 30.■ “FileAct Client with SnF Fetch File” on page 31.■ “Connection Establishment” on page 31.

EnvelopeThe Envelope section of the SWIFT AG Adapter Connectivity Map properties contains thetop-level parameters displayed in the table.

Configuring SWIFT Alliance Gateway Adapter Connectivity Map Properties


TABLE 1–10 Connectivity Map - Envelope


Application ID Specifies the name of the ApplicationInterface Message Partner. The MessagePartner basically identifies an applicationthat sends and receives messages on behalfof a user.

The name of the Application InterfaceMessage Partner.

This property is mandatory.

Context ID Specifies the cryptographic mode forRelaxed SNL Protocol:■ Empty (blank) indicates automatic

mode.

■ Advanced: indicates advanced mode.Relaxed SNL Protocol does not supportmanual cryptographic mode.

Advanced or blank indicating theselected Context ID.

The configured default is Advanced.

Msg Format Specifies the format of the current message.Each of the names of the required valuesdenotes a SWIFT Alliance Gateway messageformat.

The default value is Sag:RelaxedSNL.

Note – This property is grayed out toindicate that the property is notconfigurable.

Sender Specifies the name of the SWIFT AllianceGateway Sender. This is an SAG operator.

The name of the sender.

Sender Auth Specifies the password of the SAG operator. The SAG operator password.

Primitive ControlThe Primitive Control section of the SWIFT AG Adapter Connectivity Map properties containsthe top-level parameters displayed in the table.



TABLE 1–11 Connectivity Map - Primitive Control


Include XMLAttributes in SNLPrimitive

Specifies the construction/marshalling ofSNL primitives.

When the SWIFT AG Adapterconstructs/marshals the SNL primitives, thisflag indicates whether the adapter includesthe XML attributes in the primitives. Forexample:■ For element SwInt:Requestor, including

XML attributes, is as follows:

<SwInt:Requestor type="Sw.Gbl.DN"version="4.0.0">o=swift,o=swift</SwInt:Requestor>

■ If you do not include XML attributes, asfollows:

<SwInt:Requestor>o=swift,o=swift

</SwInt:Requestor>

If not include XML attributes.

Note – All XML attributes in SNL

Primitives are defined in SNL

Specification.

True or False.

True indicates that the adapter includesthe XML attributes in the primitives.

The configured default is False.

RemoteApi Base settingsThe RemoteApi Base settings section of the SWIFT AG Adapter Connectivity Map propertiescontains the top-level parameters displayed in the table.

TABLE 1–12 Connectivity Map - RemoteApi Base settings


Client HandleTimeout

Specifies the maximum time (inmilliseconds) allowed between a requestmessage and its corresponding responsemessage.

An integer indicating the maximumtime allowed between a request messageand its corresponding response messagein milliseconds (for example, 300000equals 5 minutes).

The configured default is 300000.



TABLE 1–12 Connectivity Map - RemoteApi Base settings (Continued)Name Description Required Value

Read BlockingTimeout

Specifies the maximum time (inmilliseconds) to block a read operation.

An integer indicating the maximumtime in milliseconds to block a readoperation (for example, 60000 equals 1minute).


InterAct ClientThis section maps to Primitive SwInt:ExchangeRequest. For parameters Sw<parameter name>found within this section, refer to the SNL specification for more detailed descriptions. TheInterAct Client section of the SWIFT AG Adapter Connectivity Map properties contains thetop-level parameters displayed in the table.

TABLE 1–13 Connectivity Map - InterAct Client


User DN Specifies the SwSec_UserDN, fulldistinguished name used to identify andauthenticate the principal.

Size is limited to 100 bytes.

The User DN (distinguished name)ending with o=<BIC8>,o=swift

For example,cn=dandrews,o=bankn14b,o=swift

Requestor DN Specifies the SwInt_Requestor, used toidentify the Application entity name.


The Requestor DN (distinguishedname) ending with o=<SWIFTNetinstitution BIC-8>,o=swift

For example,ou=management,o=bankn14b,o=swift

Responder DN Specifies the SwInt_Responder, used toidentify the intended responder.


The Responder DN (distinguishedname) ending with o=<SWIFTNetinstitution BIC-8>,o=swift

For example,cn=management,o=swift,o=swift

Service Name Specifies the SwInt_Service, the ServiceName containing the SWIFTNet serviceused.


The Service Name.

For example, swift.cte,swift.generic.ia!x, swift.generic.iast!x,and so forth.

Request Type Specifies the SwInt_RequestType, used toidentify the message type of the XMLmessage using the standard message code.


The Request Type.

For example, camt.005.001.02(GetTransaction)



TABLE 1–13 Connectivity Map - InterAct Client (Continued)Name Description Required Value

User Reference Specifies the SwInt_RequestRef. This isused to associate a request message withsubsequent response or error messages.


A user reference of 30 bytes or less.

Signed Specifies whether the request containsCrypto operations to be performed. Only thelast Crypto block is analyzed.SwInt_RequestCrypto (digital signature).

True or False.

True indicates that the request containsCrypto operations to be performed.


Priority Specifies the SwInt_Priority. The priority ofdelivery. In the future, SWIFTNet mayimplement this priority through schemessuch as top-queuing, dedicated serverprocesses, network transport priority. In thecurrent implementation, differentiation onpriority may be used for store-and-forwarddelivery.

Normal or Urgent.

The configured default is Normal.

Non-Repudiation Specifies whether SwInt_NRIndicator,non-repudiation support is being requested.

True or False.

True indicates that non-repudiation isrequested.


DeliveryNotification QueueName

Specifies the SwInt_NotifQueue,store-and-forward delivery mode. When avalue is present, it indicates SnF deliverymode and the queue where SnF deliverynotifications are received.

In the case of non-delivery (Rejected orFailed message), an SnF failed notification isalways generated in this notification queue.

In the case of delivery (Accepted orDuplicated message) an SnF deliverynotification is optionally generated in thisqueue.

For store-and-forward delivery mode,enter the name of the deliverynotification queue.


For example, ptsauszz_generic!x. (seeSw:DeliveryNotif)

Ask PositiveDeliveryNotification

Specifies Sw_DeliveryNotif, deliverynotification. This is for store-and-forwarddelivery mode only. Indicates whether adelivery notification is required in case ofsuccessful delivery (Accepted orDuplicated).

True or False.

True indicates that a deliverynotification is required.




InterAct Client with Store and ForwardThis section maps to the parameter Sw:AcquireSnFRequest of the PrimitiveSw:ExchangeSnFRequest. For parameters Sw<parameter name> found within this section,refer to the SNL specification for more detailed descriptions. The InterAct Client with Store andForward section of the SWIFT AG Adapter Connectivity Map properties contains the top-levelparameters displayed in the table.

Note – For more information on SWIFT Alliance Gateway configuration properties in thecontext of SWIFT Alliance Gateway, refer to the SWIFT Alliance Gateway and SNL userdocumentation provided by SWIFT.

TABLE 1–14 Connectivity Map - InterAct Client with Store and Forward


Queue Name ToAcquire

Specifies the name of the queue(SwInt_Queue).

The User SwInt_Queue.

For example, ptsauszz_generic!x


Force Acquire Specifies the Sw_ForceAcquire. Indicateswhether an acquisition request must beaccepted in case the queue is alreadyacquired.

True or False.

True indicates that an acquisitionrequest must be accepted.


Session Mode Specifies the usage mode of the queue.

This property is purposely disabled.

The default setting is Pull.

Pull is the correct setting for clientmode.

Note – This property is purposelydisabled.

Order By Specifies the Sw_OrderBy. Indicates theorder priority in which the messages areretrieved on the queue. The options are:■ InterAct■ Blank, indicates FIFO (first in, first out)■ FileAct■ Urgent

InterAct, blank, FileAct, or Urgent.

The configured default is InterAct.

Recovery Mode Specifies the Sw_RecoveryMode. Indicateswhether the session must be opened inrecovery mode. Messages that already havean output sequence number are sent first,before considering the selected order.

True or False.

True indicates that the session must beopened in recovery mode.




FileAct ClientThis section maps to the Primitive Sw:ExchangeFileRequest. For parameters Sw<parametername> found within this section, refer to the SNL specification for more detailed descriptions.The FileAct Client section of the SWIFT AG Adapter Connectivity Map properties contains thetop-level parameters displayed in the table.

TABLE 1–15 Connectivity Map - FileAct Client


User DN Specifies the SwSec_UserDN. Used toidentify and authenticate the principal. Sizeis limited to 100 bytes.

The User DN (distinguished name)ending with o=<BIC8>,o=swift

For example,cn=dandrews,o=bankn14b,o=swift

Requestor DN Specifies the SwInt_Requestor, theApplication entity name. Size is limited to100 bytes.

The Requestor DN (distinguishedname) ending with o=<SWIFTNetinstitution BIC-8>,o=swift

For example,ou=management,o=bankn14b,o=swift

Responder DN Specifies the SwInt_Responder, the name ofthe intended responder. Size is limited to100 bytes.

The Responder DN (distinguishedname) ending with o=<SWIFTNetinstitution BIC-8>,o=swift

For example,cn=management,o=swift,o=swift

Service Name Specifies the SwInt_Service, the ServiceName containing the SWIFTNet serviceused. Size is limited to 30 bytes.

The Service Name.

For example, swift.cte,swift.generic.fa!x, swift.generic.fast!x,and so forth.

Request Type Specifies the SwInt_RequestType, used toidentify the message type of the XMLmessage using the standard message code.Size is limited to 30 bytes.

The Request Type.

For example, camt.005.001.02(GetTransaction)

User Reference Specifies the SwInt_RequestRef. This isused to associate a request message withsubsequent response or error messages. Sizeis limited to 30 bytes.

A user reference of 30 bytes or less.

Signed Specifies whether the request containsCrypto operations to be performed. Only thelast Crypto block is analyzed.SwInt_RequestCrypto (digital signature).

True or False.

True indicates that the request containsCrypto operations to be performed.




TABLE 1–15 Connectivity Map - FileAct Client (Continued)Name Description Required Value

Priority Specifies the SwInt_Priority. The priority ofdelivery. In the future, SWIFTNet mayimplement this priority through schemessuch as top-queuing, dedicated serverprocesses, network transport priority. In thecurrent implementation, differentiation onpriority may be used for store-and-forwarddelivery.

Normal or Urgent.

The configured default is Normal.

Non-Repudiation Specifies whether SwInt_NRIndicator,non-repudiation support is being requested.

True or False.

True indicates that non-repudiation isrequested.


DeliveryNotification QueueName

Specifies the SwInt_NotifQueue,store-and-forward delivery mode. When avalue is present, it indicates SnF deliverymode and the queue where SnF deliverynotifications are received.

In the case of non-delivery (Rejected orFailed message), an SnF failed notification isalways generated in this notification queue.

In the case of delivery (Accepted orDuplicated message) an SnF deliverynotification is optionally generated in thisqueue.

For store-and-forward delivery mode,enter the name of the deliverynotification queue.


For example, ptsauszz_generic!x. (seeSw:DeliveryNotif).

Ask PositiveDeliveryNotification

Specifies Sw_DeliveryNotif, deliverynotification. This is for store-and-forwarddelivery mode only. Indicates whether adelivery notification is required in case ofsuccessful delivery (Accepted orDuplicated).

True or False.

True indicates that a deliverynotification is required.





Remote File HandlerTransferEP

Specifies the Sw_TransferEP, the TransferEndPoint name used for the remote filehandler. Value options:■ Blank value: indicates that the file

transfer does not use the remote filehandler.

■ Transfer EndPoint name: When thisvalue is present, the file transfer uses theremote file handler.Before the file transfer starts you need tostart the remote file handler processwith the specified Transfer EndPointname on your system. The command tostart the remote file handler(swfa_handler) requires thecommand-line arguments:swfa_handler<HostName>:<PortNumber>[:ssl]<TransferEndpoint> [<Process ID>]Here are some examples:

1. swfa_handler snlhost:48003:sslMyUniqueEndpoint 23450

2. swfa_handler snlhost:48003MyUniqueEndpoint 23450

3. swfa_handler snlhost:48003MyUniqueEndpoint

As for the syntax details and operationalguidelines of remote file handler, refer tothe SWIFTNet Service Design Guide orcontact the system administrator.

The Transfer EndPoint name used forthe remote file handler.





Block File Transfer Specifies BlockFileTransfer. This indicateswhether the function call will finish when afinal file status is returned.

This may be useful for the large file transfers.

The final status values for file transfer are,■ Completed■ Duplicated■ Aborted■ Failed■ Rejected■ Unknown

True or False.

True indicates that the function call willfinish when a final file status is returned.


FileAct Client with Store and ForwardThis section maps to parameter Sw:AcquireSnFRequest of PrimitiveSw:ExchangeSnFRequest. For parameters Sw<parameter name> found within this section,refer to the SNL specification for more detailed descriptions. The InterAct Client with Store andForward section of the SWIFT AG Adapter Connectivity Map properties contains the top-levelparameters displayed in the table.

TABLE 1–16 Connectivity Map - FileAct Client with Store and Forward


Queue Name ToAcquire

Specifies the SwInt_Queue.

For example, ptsauszz_generic!x. Size islimited to 30 bytes.

The User SwInt_Queue.

For example, ptsauszz_generic!x

Force Acquire Specifies the Sw_ForceAcquire.

Indicates whether an acquisition requestmust be accepted if a queue is alreadyacquired.

True or False.

True indicates that an acquisitionrequest must be accepted.


Session Mode Specifies the usage mode of the queue.

This property is purposely disabled.

The default setting is Pull. Pull is thecorrect setting for client mode.

Note – This property is purposelydisabled.



TABLE 1–16 Connectivity Map - FileAct Client with Store and Forward (Continued)Name Description Required Value

Order By Specifies the Sw_OrderBy.

Indicates the order priority in which themessages are retrieved on the queue. Theoptions are:■ InterAct■ Blank: indicates FIFO (first in, first out).■ FileAct■ Urgent

InterAct, blank, FileAct, or Urgent.

The configured default is FileAct.

Recovery Mode Specifies the Sw_RecoveryMode.

Indicates whether the session must beopened in recovery mode. Messages thatalready have an output sequence numberare sent first, before considering the selectedorder.

True or False.

True indicates that the session must beopened in recovery mode.


FileAct Client with Get FileThis section maps to the parameter Sw:GetFileRequest of the PrimitiveSw:ExchangeFileRequest. For parameters Sw<parameter name> found within this section,refer to the SNL Specification for more detailed descriptions. The FileAct Client with Get Filesection of the SWIFT AG Adapter Connectivity Map properties contains the top-levelparameters displayed in the table.

TABLE 1–17 Connectivity Map - FileAct Client with Get File


TransferDescription

Specifies the Sw_TransferDescription, userinformation about the file transfer. Freetext.


The transfer description.

Transfer Info Specifies the Sw_TransferInfo, userinformation about the file transfer.Structured data that can be analyzed by theserver.


The transfer information.



TABLE 1–17 Connectivity Map - FileAct Client with Get File (Continued)Name Description Required Value

Logical File Name Specifies the Sw_LogicalName, the logicalname of the file to get. This name iscommunicated to the server application. Bydefault, this name is the physical namewithout path.


The logical file name.

Physical File Name Specifies the Sw_PhysicalName, the fullphysical name where the file to get must bestored. If the file already exists it isoverwritten.


The physical file name.

Maximum File Size Specifies the Sw_MaxSize, the maximumaccepted file size. When a value is present,the maximum size is a field that iscommunicated from the client applicationto the server application.

This property is optional. Size range is 0 to250 Megabytes.

The maximum file size.

FileAct Client with Put FileThis section maps to parameter Sw:PutFileRequest of the Primitive Sw:ExchangeFileRequest.For parameters Sw<parameter name> found within this section, refer to the SNL Specificationfor more detailed descriptions. The FileAct Client with Put File section of the SWIFT AGAdapter Connectivity Map properties contains the top-level parameters displayed in the table.

TABLE 1–18 Connectivity Map - FileAct Client with Put File


TransferDescription

Specifies the Sw_TransferDescription,This is information about the file transfer.Free text.


The transfer description.

Transfer Info Specifies the Sw_TransferInfo, informationabout the file transfer. This is structureddata that can be analyzed by the server.


The transfer information.



TABLE 1–18 Connectivity Map - FileAct Client with Put File (Continued)Name Description Required Value

Logical File Name Specifies the Sw_LogicalName, the logicalname of the file to put. This name iscommunicated to the server application. Bydefault, this name is the physical namewithout path.


The logical file name.

Physical File Name Specifies the Sw_PhysicalName, the fullphysical name of the file to put.



File Description Specifies the Sw_FileDescription. This isuser information about the file. Free text.


The file description.

File Info Specifies the Sw_FileInfo, user informationabout the file. This is structured data thatcan be analyzed by the server.


The file information.

FileAct Client with SnF Fetch FileThis section maps to Primitive Sw:FetchFileRequest. For parameters Sw<parameter name>found within this section, refer to the SNL Specification for more detailed descriptions. TheFileAct Client with SnF Fetch File section of the SWIFT AG Adapter Connectivity Mapproperties contains the top-level parameters displayed in the table.

TABLE 1–19 Connectivity Map - FileAct Client with SnF Fetch File


Physical File Name Specifies the Sw_PhysicalName, the fullphysical name where the file is storedlocally.



Connection EstablishmentThe Connection Establishment section of the SWIFT AG Adapter Connectivity Mapproperties defines configuration parameters used to control the connection establishment. Itcontains the top-level parameters displayed in the table.



TABLE 1–20 Connectivity Map - Connection Establishment


Always Create NewConnection

Specifies whether to ALWAYS try to create anew connection for a connectionestablishment request. The options are:■ True: A new connection is always

created without trying to match anexisting connection.

■ False: An attempt to match an existingconnection (managed by container) ismade.

True or False.


Auto DisconnectConnection

Specifies whether the adapter closes theconnection automatically after the work isfinished on the connection.■ True: The connection is not re-used.■ False: The connection is returned to the

pool for reuse.

True or False.


Selecting SWIFT Alliance Gateway as the ExternalApplicationTo create an SWIFT Alliance Gateway adapter, you must first create an SAG (SWIFT AllianceGateway) External Application in your Connectivity Map. SWIFT Alliance Gateway adaptersare located between the SAG External Application and a Service. Services are containers forCollaborations, Business Processes, and so forth.

▼ To Create the SAG External Application

From the Connectivity Map toolbar, click the External Applications icon.

Select the SAG External Application from the menu (see the figure below). The selected SAGExternal Application icon appears on the Connectivity Map toolbar.

1

2



Drag the new SAG External Application from the toolbar onto the Connectivity Map canvas. Thisrepresents an external SWIFT Alliance Gateway system.From the Connectivity Map, you can associate (bind) the External Application with the Serviceto establish an adapter.

When SAG is selected as the External Application, it automatically applies the default SWIFTAlliance Gateway Adapter properties, provided by the OTD, to the adapter that connects it tothe Service. You can then modify these properties for your specific system using the PropertiesEditor.

WebSphere MQ Adapter Connectivity Map PropertiesThe WebSphere MQ Adapter’s Properties are organized as follows:

■ “Inbound WebSphere MQ Adapter Connectivity Map Properties” on page 33.■ “Outbound WebSphere MQ Adapter XA Connectivity Map Properties” on page 41.■ “Outbound WebSphere MQ Adapter Connectivity Map Properties” on page 47.

Note – Creating customized individual OTD configuration settings can override the defaultAdapter OTD configuration settings.

Inbound WebSphere MQ Adapter Connectivity MapPropertiesThe inbound WebSphere MQ Adapter parameters, accessed from the Connectivity Map, areorganized into the following sections:

■ “Inbound WebSphere MQ Adapter Settings” on page 34.■ “Inbound WebSphere MQ Adapter Settings with GetMessageOptions and matchOptions”

on page 35.■ “Inbound WebSphere MQ Adapter Settings with GetMessageOptions and options” on

page 38.

3

WebSphere MQ Adapter Connectivity Map Properties


Inbound WebSphere MQ Adapter SettingsThe Inbound WebSphere MQ Adapter Settings section of the WebSphere MQ AdapterConnectivity Map properties contains the top-level parameters displayed in the following table.

TABLE 1–21 Connectivity Map - Inbound WebSphere MQ Adapter Settings


Queue Name Specifies the name of the queue from whichmessages are picked up (subscribed).

Note – Inbound mode Adapters will notfunction if a non-local queue is specified.Non-local queues include alias queues andlocal queue definitions to remote queues.This limitation applies only applies topolling/receive mode Adapters, notoutbound Adapters used to retrievemessages.

The name of the WebSphere MQqueue.

The configured default is default.

Maximum MessageSize

Specifies the maximum message size thatthe Adapter is able to get from a queue. Avalue of zero (0) instructs the Adapter to usethe MQ-provided default size. If you specifya non-zero value, and a message on thequeue is larger than this value, one of thefollowing will occur:

If theMQC.MQGMO_ACCEPT_TRUNCATED_MSG property is set to True, the Adapterprocesses as much of the message from thequeue as possible, producing a truncatedmessage.

If theMQC.MQGMO_ACCEPT_TRUNCATED_MSG property is set to False, the Adapterleaves the message on the queue and raisesan MQException with a completion code ofMQCC_WARNING, and with a reasoncode ofMQRC_TRUNCATED_MSG_FAILED.

A number indicating the maximummessage size in bytes.

The configured default is 0 (use the MQdefined default size).

Schedule Interval Specifies the polling interval in millisecondsat which the subscribed queue is polled formessages. This is the duration of the pause,in milliseconds, between attempts to getmessages from the queue.

The number of milliseconds at whichthe queue is polled.

The configured default is 5000 (or 5seconds).



TABLE 1–21 Connectivity Map - Inbound WebSphere MQ Adapter Settings (Continued)Name Description Required Value

Security Exit Specifies the optional, package qualifiedname of a user-defined class thatimplements thecom.ibm.mq.MQSecurityExit interface.WebSphere MQ invokes an instance of theclass whenever the Adapter attempts toconnect to the queue manager. The namedclass must include a default constructor.

This parameter is only used for clientconnections. Security Exits are notapplicable to bindings connections.

For more information about Security Exits,see the IBM document, WebSphere MQUsing Java (CSQZAW09) regardingMQSecurityExit.

The name of the user-defined class.This property also requires an assignedvalue for the Security Exit JarClasspath property.

Security Exit JARClasspath

Specifies the absolute path to the JAR filethat contains the named Security Exit. Thisproperty is required if the Security Exit isspecified.

The specified JAR is packaged into theapplication (EAR) file that is generatedduring Project activation. If the specifiedJAR cannot be accessed or found, theactivation will fail.

If this property value is left blank, you mustensure that a JAR file containing theSecurity Exit is made accessible to theruntime Environment prior deploying theProject (for example, by manually copyingthe JAR file into the Integration Server’s libdirectory prior to or during the DeploymentProcess).


The absolute path for the JAR file thatcontains the named Security Exit class.

Inbound WebSphere MQ Adapter Settings with GetMessageOptionsand matchOptionsThe Inbound Adapter Settings with GetMessageOptions and matchOptions section of theWebSphere MQ Adapter Connectivity Map properties contains the top-level parametersdisplayed in the following table.



TABLE 1–22 Connectivity Map - Inbound WebSphere MQ Adapter Settings with GetMessageOptions andmatchOptions


correlationId Specifies the correlation identifier of themessage to be retrieved. Normally the queuemanager returns the first message with amessage identifier and correlation identifierthat matches the identifiers specified.

The correlation identifier of themessage.

groupId Specifies the byte string that identifies themessage group to which the physicalmessage belongs.

A byte string that indicates the messagegroup.

messageId For an MQGET call, this field specifies themessage identifier of the message to beretrieved. Normally, the queue managerreturns the first message with a messageidentifier and correlation identifier thatmatches those identifiers specified.

For an MQPUT call, this specifies themessage identifier to use.

The message identifier.

messageSequenceNumber

Specifies the sequence number of a logicalmessage within a group.

The sequence number of the logicalmessage within a group.


MQMO_MATCH_CORREL_ID

Specifies that the retrieved message musthave a correlation identifier that matches thevalue of the correlationId parameter. Thevalues are:■ True: Indicates that the message must

have a matching correlation identifier.

■ False: Indicates that the correlationidentifier is ignored and any correlationidentifier will be accepted.This match is in addition to any othermatches that may apply (for example,the message identifier).

True or False.




TABLE 1–22 Connectivity Map - Inbound WebSphere MQ Adapter Settings with GetMessageOptions andmatchOptions (Continued)


MQMO_MATCH_GROUP_ID

Specifies that the retrieved message musthave a group identifier that matches thevalue of the groupId parameter. The valuesare:■ True: Indicates that the message must

have a matching group identifier.

■ False: Indicates that the group identifieris ignored and any group identifier isaccepted.This match is in addition to any othermatches that may apply (for example,the correlation identifier).

True or False.


MQMO_MATCH_MSG_ID

Specifies that the retrieved message musthave a message identifier that matches thevalue of the messageId parameter. Thevalues are:■ True: Indicates that the message must

have a matching message identifier.

■ False: Indicates that the messageidentifier is ignored and any messageidentifier is accepted.This match is in addition to any othermatches that may apply (for example,the correlation identifier).

True or False.


MQMO_MATCH_MSG_SEQ_NUMBER

Specifies that the retrieved message musthave a message sequence number thatmatches the value of themessageSequenceNumber parameter. Thevalues are:■ True: Indicates that the message must

have a matching message sequencenumber.

■ False: Indicates that the messagesequence number is ignored and anymessage sequence number is accepted.This match is in addition to any othermatches that may apply (for example,the group identifier).

True or False.




TABLE 1–22 Connectivity Map - Inbound WebSphere MQ Adapter Settings with GetMessageOptions andmatchOptions (Continued)


MQMO_NONE Specifies that no matches are to be used inselecting the message to be returned. Allmessages on the queue are eligible forretrieval (subject to some MQGMO_options...).

True or False.


Inbound WebSphere MQ Adapter Settings with GetMessageOptionsand optionsThe Inbound Adapter Settings with GetMessageOptions and options section of the WebSphereMQ Adapter Connectivity Map properties contains the top-level parameters displayed in thefollowing table.

TABLE 1–23 Connectivity Map - Inbound Adapter Settings with GetMessageOptions and options


MQGMO_ACCEPT_TRUNCATED_MSG

Specifies whether a truncated message isaccepted as a complete message. If themessage buffer is too small to hold thecomplete message, this option allows theMQGET call to fill the buffer with as muchas it can hold and complete its processing.Without this option, in the given situation,the MQGET call will still be filled tocapacity, but the processing will not beconsidered completed. The values are:■ True: Indicates that a truncated message

is accepted as a complete message.

■ False: Indicates that a truncated messageis not considered as a complete message.

True or False.


MQGMO_FAIL_IF_QUIESCING

Forces the MQGET call to fail if the queuemanager is in the quiescing state. The valuesare:■ True: Indicates that calling MQGET

fails if the queue manager is in thequiescing state.

■ False: Indicates that calling MQGETdoes not fail if the queue manager is inthe quiescing state.

True or False.




TABLE 1–23 Connectivity Map - Inbound Adapter Settings with GetMessageOptions and options(Continued)


MQGMO_SYNCPOINT

Forces the MQGET call to get the messageunder syncpoint control; the message ismarked as being unavailable to otherapplications, but it is deleted from the queueonly when the unit of work is committed.The message is made available again if theunit of work is backed out. The values are:■ True: Indicates that calling MQGET

gets the message under syncpointcontrol.

■ False: Indicates that MQGET, whencalled does not get the message undersyncpoint control.

True or False.


MQGMO_SYNCPOINT_IF_PERSISTENT

Forces the MQGET call to get the messageunder syncpoint control if the message ispersistent. The values are:■ True: Indicates that calling MQGET

gets the message under syncpointcontrol if the message is persistent.

■ False: Indicates that MQGET, whencalled does not get the message undersyncpoint control if the message ispersistent.

True or False.


MQGMO_COMPLETE_MSG

Specifies that only a complete logicalmessage can be returned by calling MQGET.If the logical message is segmented, thequeue manager reassembles the segmentsand returns the complete logical message tothe application; the fact that the logicalmessage was segmented is not apparent tothe Adapter. The values are:■ True: Indicates that only a complete

logical message can be returned bycalling MQGET.

■ False: Indicates that a complete logicalmessage is not required.

True or False.




TABLE 1–23 Connectivity Map - Inbound Adapter Settings with GetMessageOptions and options(Continued)


MQGMO_WAIT Specifies that an MQ GET call waits (blockand/or suspend) until a message becomesavailable in the queue. The values are:■ True: Indicates that an MQ GET call

waits until a message becomes availablein the queue.

■ False: Indicates that an MQ GET calldoes not wait until a message becomesavailable in the queue.

True or False.


waitInterval Specifies how long (in milliseconds) an MQGET call waits for a message to becomeavailable in the queue. This parameter isused in conjunction with MQGMO_WAIT.If MQGMO_WAIT is set to false,waitInterval is not used.

Specifying a negative value indicates that thewait will last indefinitely.

Setting this value to a negative numbercauses the polling Adapter to execute MQGET calls with a wait interval ofMQWI_UNLIMITED. With this type of getcall, the Adapter will block indefinitely untila suitable message is available. If theIntegration Server (in association with theApplication Server) is commanded to shutdown or restart while the Adapter is stillblocked, the Integration Server will not beable to proceed until the Adapter isunblocked by the availability of a suitableMQ message.

The same limitation affects the non-pollinguse of the Adapter. The WebSphere MQAdapter’s OTD GMO structure exposes amethod named setUnlimitedWait() to JavaCollaborations that, when used, sets thewaitInterval to the valueMQWI_UNLIMITED. If usingsetUnlimitedWait() causes the Adapter toblock indefinitely during a subsequent getcall, the Integration Server will be unable toshut down until the Adapter is unblocked.

A number indicating the period of time,in milliseconds, that an MQ GET callwaits for a message to become availablein the queue.




Outbound WebSphere MQ Adapter XA ConnectivityMap PropertiesThe outbound WebSphere MQ Adapter XA parameters, accessed from the Connectivity Map,are contained in the following section.

■ “Outbound WebSphere MQ Adapter (XA) Settings” on page 41.■ “Outbound WebSphere MQ Adapter (XA) Settings with Queue Open Options” on page 42.

Outbound WebSphere MQ Adapter (XA) SettingsThe Outbound Adapter (XA) Settings section of the WebSphere MQ Adapter ConnectivityMap properties contains the top-level parameters displayed in the following table.

TABLE 1–24 Connectivity Map - Outbound Adapter Settings


Queue Name Specifies the name of queue to which themessage is published. This parameter isoptional. The queue name may also bespecified manually in the Business Processor Collaboration that effects the put.

The queue name to which the message isretrieved or published.

Security Exit Specifies the optional, package qualifiedname of a user-defined class thatimplements thecom.ibm.mq.MQSecurityExit interface.

WebSphere MQ invokes an instance of theclass whenever the Adapter attempts toconnect to the queue manager. The namedclass must include a default constructor.



The name of the user-defined class. Thisproperty also requires an assigned valuefor the Security Exit JAR Classpathproperty.



TABLE 1–24 Connectivity Map - Outbound Adapter Settings (Continued)Name Description Required Value

Security ExitJAR Classpath



If this property value is left blank, you mustensure that a JAR file containing the SecurityExit is made accessible to the runtimeEnvironment prior deploying the Project(for example, by manually copying the JARfile into the Integration Server’s lib directoryprior to or during the Deployment Process).



Outbound WebSphere MQ Adapter (XA) Settings with Queue OpenOptionsThe Outbound Adapter Settings with Queue Open Options section of the WebSphere MQAdapter Connectivity Map properties contains the top-level parameters displayed in thefollowing table. These properties apply specifically to the MQOPEN calls.

TABLE 1–25 Connectivity Map - Outbound Adapter Settings with Queue Open Options


MQOO_ALTERNATE_USER_AUTHORITY

Specifies whether an alternate useridentifier is used to check the authorizationfor the open.

True indicates that and alternate useridentifier is used.

True or False.


MQOO_BIND_AS_Q_DEF

Specifies whether the binding used for thequeue handle is taken from the DefBindqueue attribute.

True indicates that the binding used istaken from DefBind queue attribute.

True or False.




TABLE 1–25 Connectivity Map - Outbound Adapter Settings with Queue Open Options (Continued)Name Description Required Value

MQOO_BIND_NOT_FIXED

Specifies whether the local queue managerbinds the queue handle to a particularinstance of the destination queue, when theobject being opened is a cluster queue.

True indicates that the local queuemanager will bind to a specific destination.

This option is ignored when specified for aqueue that is not a cluster queue.

True or False.


MQOO_BIND_ON_OPEN


True indicates that the local queuemanager will not bind to a specificdestination.


True or False.


MQOO_BROWSE Specifies whether the queue is opened tobrowse messages.

True indicates that the queue is open foruse with MQGET calls with the followingoptions:■ MQGMO_BROWSE_FIRST■ MQGMO_BROWSE_NEXT■ MQGMO_BROWSE_

MSG_UNDER_CURSOR

True or False.


MQOO_FAIL_IF_QUIESCING

Specifies whether the MQOPEN call failswhen the queue manager is in quiescingstate. Used to control authorizationchecking.

True indicates that the MQOPEN call willfail if queue manager is quiescing.

True or False.





MQOO_INPUT_AS_Q_DEF

Specifies whether the queue is opened tobrowse messages using the queue-defineddefault.

True indicates that the queue is open foruse with subsequent MQGET calls.

Note – The value of this parameter isignored when the Adapter is operating inautomatic connection mode, because theAdapter must be capable of both receivingand sending messages.

True or False.


MQOO_INPUT_EXCLUSIVE

Specifies whether the queue is opened toget messages with exclusive access.

True indicates that the queue is open foruse with subsequent MQGET calls. Callswill fail with reason codeMQRC_OBJECT_IN_USE if the queue iscurrently used (open) by this or anotherapplication for input of any type.

True or False.


MQOO_INPUT_SHARED

Specifies whether the queue is opened toget messages with shared access.

True indicates that the queue is open foruse with subsequent MQGET calls. Callswill succeed, even when the queue iscurrently used (open) by this or anotherapplication for input of any type.

True or False.


MQOO_INQUIRE Specifies whether the object is opened toinquire attributes.

True indicates that the queue, name list,process definition, or queue manager isopen for use with subsequent MQINQcalls.

True or False.





MQOO_OUTPUT Specifies whether the object is opened toput messages.

True indicates that MQOPEN call cansucceed, even if the InhibitPut queueattribute is set toMQQA_PUT_INHIBITED (thoughsubsequent MQPUT calls will fail).

Note – The value of this parameter isignored when the Adapter is operating inautomatic connection mode, because theAdapter must be capable of both receivingand sending messages.

True or False.


MQOO_PASS_ALL_CONTEXT

Specifies whether to allow all context topass.

True indicates that theMQPMO_PASS_ALL_CONTEXT optionis specified in the PutMsgOpts parameterwhen a message is put on a queue, andgives the message identity and origincontext information from an input queueopened with theMQOO_SAVE_ALL_CONTEXT option.

True also indicates thatMQOO_PASS_IDENTITY_CONTEXT isimplied and does not need to be specified.

True or False.


MQOO_PASS_IDENTITY_CONTEXT

Specifies whether to allow identity contextto pass.

True indicates that theMQPMO_PASS_IDENTITY_CONTEXToption to be specified in the PutMsgOptsparameter when a message is put on aqueue. This gives the message the identitycontext information from an input queueopened with theMQOO_SAVE_ALL_CONTEXT option.

True indicates that the MQOO_OUTPUToption must be specified.

True or False.





MQOO_RESOLVE_NAMES

Specifies MQOO_RESOLVE_NAMES.

Select True if you want to use the resolvedqueue manager name and resolved queuename attributes of the ImqQueue class.

True or False.


MQOO_SAVE_ALL_CONTEXT

Specifies whether to save context whenmessage is retrieved.

True indicates that context is saved.Context information is associated with thisqueue handle and set from the context ofany message retrieved using this handle.

True or False.


MQOO_SET Specifies whether the queue is open to setattributes.

True indicates that the queue is open to setattributes and for use with subsequentMQSET calls.

True or False.


MQOO_SET_ALL_CONTEXT

Specifies whether to allow all context to beset.

True indicates that all context can be set.The MQPMO_SET_ALL_CONTEXToption is specified in the PutMsgOptsparameter when a message is put on aqueue. Gives the identity and origincontext information contained in theMsgDesc parameter specified on theMQPUT or MQPUT1 call to the message.

True or False.


MQOO_SET_IDENTITY_CONTEXT

Specifies whether to allow identity contextto be set.

True indicates that identity context can beset. TheMQPMO_SET_IDENTITY_CONTEXToption can be specified in the PutMsgOptsparameter when a message is put on aqueue. Gives the identity and origincontext information contained in theMsgDesc parameter specified on theMQPUT or MQPUT1 call to the message.

True or False.




Outbound WebSphere MQ Adapter Connectivity MapPropertiesThe outbound WebSphere MQ Adapter parameters, accessed from the Connectivity Map, aredescribed in the following section.

■ “Outbound WebSphere MQ Adapter Settings” on page 47.■ “Outbound WebSphere MQ Adapter Settings with Queue Open Options” on page 48.■ “Running XA Transactions in Client (Outbound) Mode” on page 52.

Outbound WebSphere MQ Adapter SettingsThe Outbound Adapter Settings section of the WebSphere MQ Adapter Connectivity Mapproperties contains the top-level parameters displayed in the following table.

TABLE 1–26 Connectivity Map - Outbound Adapter Settings with GetMessageOptions and options


Queue Name Specifies the name of queue to which themessage is published. This parameter isoptional. The queue name may also bespecified manually in the Business Processor Collaboration that effects the put.

The queue name to which the message isretrieved or published.

Security Exit Specifies the optional, package qualifiedname of a user-defined class thatimplements thecom.ibm.mq.MQSecurityExit interface.

WebSphere MQ invokes an instance of theclass whenever the Adapter attempts toconnect to the queue manager. The namedclass must include a default constructor.



The name of the user-defined class. Thisproperty also requires an assigned valuefor the Security Exit JAR Classpathproperty.



TABLE 1–26 Connectivity Map - Outbound Adapter Settings with GetMessageOptions and options(Continued)


Security Exit JARClasspath



If this property value is left blank, you mustensure that a JAR file containing the SecurityExit is made accessible to the runtimeEnvironment prior deploying the Project(for example, by manually copying the JARfile into the Integration Server’s lib directoryprior to or during the Deployment Process).



Outbound WebSphere MQ Adapter Settings with Queue Open OptionsThe Outbound Adapter Settings with Queue Open Options section of the WebSphere MQAdapter Connectivity Map properties contains the top-level parameters displayed in thefollowing table. These properties apply specifically to the MQOPEN calls.

TABLE 1–27 Connectivity Map - Outbound Adapter Settings with Queue Open Options


MQOO_ALTERNATE_USER_AUTHORITY

Specifies whether an alternate user identifieris used to check the authorization for theopen.

True indicates that and alternate useridentifier is used.

True or False.


MQOO_BIND_AS_Q_DEF

Specifies whether the binding used for thequeue handle is taken from the DefBindqueue attribute.

True indicates that the binding used is takenfrom DefBind queue attribute.

True or False.





MQOO_BIND_NOT_FIXED


True indicates that the local queue managerwill bind to a specific destination.


True or False.


MQOO_BIND_ON_OPEN


True indicates that the local queue managerwill not bind to a specific destination.


True or False.


MQOO_BROWSE Specifies whether the queue is opened tobrowse messages.

True indicates that the queue is open for usewith MQGET calls with the followingoptions:■ MQGMO_BROWSE_FIRST■ MQGMO_BROWSE_NEXT■ MQGMO_BROWSE_

MSG_UNDER_CURSOR

True or False.


MQOO_FAIL_IF_QUIESCING

Specifies whether the MQOPEN call failswhen the queue manager is in quiescingstate. Used to control authorizationchecking.

True indicates that the MQOPEN call willfail if queue manager is quiescing.

True or False.





MQOO_INPUT_AS_Q_DEF

Specifies whether the queue is opened tobrowse messages using the queue-defineddefault.

True indicates that the queue is open for usewith subsequent MQGET calls.

Note – The value of this parameter is ignoredwhen the Adapter is operating in automaticconnection mode, because the Adapter mustbe capable of both receiving and sendingmessages.

True or False.


MQOO_INPUT_EXCLUSIVE

Specifies whether the queue is opened to getmessages with exclusive access.

True indicates that the queue is open for usewith subsequent MQGET calls. Calls will failwith reason code MQRC_OBJECT_IN_USEif the queue is currently used (open) by thisor another application for input of any type.

True or False.


MQOO_INPUT_SHARED

Specifies whether the queue is opened to getmessages with shared access.

True indicates that the queue is open for usewith subsequent MQGET calls. Calls willsucceed, even when the queue is currentlyused (open) by this or another applicationfor input of any type.

True or False.


MQOO_INQUIRE Specifies whether the object is opened toinquire attributes.

True indicates that the queue, name list,process definition, or queue manager is openfor use with subsequent MQINQ calls.

True or False.





MQOO_OUTPUT Specifies whether the object is opened to putmessages.

True indicates that MQOPEN call cansucceed, even if the InhibitPut queueattribute is set toMQQA_PUT_INHIBITED (thoughsubsequent MQPUT calls will fail).

Note – The value of this parameter is ignoredwhen the Adapter is operating in automaticconnection mode, because the Adapter mustbe capable of both receiving and sendingmessages.

True or False.


MQOO_PASS_ALL_CONTEXT

Specifies whether to allow all context to pass.

True indicates that theMQPMO_PASS_ALL_CONTEXT option isspecified in the PutMsgOpts parameterwhen a message is put on a queue, and givesthe message identity and origin contextinformation from an input queue openedwith the MQOO_SAVE_ALL_CONTEXToption.

True also indicates thatMQOO_PASS_IDENTITY_CONTEXT isimplied and does not need to be specified.

True or False.


MQOO_PASS_IDENTITY_CONTEXT

Specifies whether to allow identity context topass.

True indicates that theMQPMO_PASS_IDENTITY_CONTEXToption to be specified in the PutMsgOptsparameter when a message is put on a queue.This gives the message the identity contextinformation from an input queue openedwith the MQOO_SAVE_ALL_CONTEXToption.

True indicates that the MQOO_OUTPUToption must be specified.

True or False.


MQOO_RESOLVE_NAMES

Specifies MQOO_RESOLVE_NAMES.

Select True if you want to use the resolvedqueue manager name and resolved queuename attributes of the ImqQueue class.

True or False.





MQOO_SAVE_ALL_CONTEXT

Specifies whether to save context whenmessage is retrieved.

True indicates that context is saved. Contextinformation is associated with this queuehandle and set from the context of anymessage retrieved using this handle.

True or False.


MQOO_SET Specifies whether the queue is open to setattributes.

True indicates that the queue is open to setattributes and for use with subsequentMQSET calls.

True or False.


MQOO_SET_ALL_CONTEXT

Specifies whether to allow all context to beset.

True indicates that all context can be set.The MQPMO_SET_ALL_CONTEXToption is specified in the PutMsgOptsparameter when a message is put on a queue.Gives the identity and origin contextinformation contained in the MsgDescparameter specified on the MQPUT orMQPUT1 call to the message.

True or False.


MQOO_SET_IDENTITY_CONTEXT

Specifies whether to allow identity context tobe set.

True indicates that identity context can beset. TheMQPMO_SET_IDENTITY_CONTEXToption can be specified in the PutMsgOptsparameter when a message is put on a queue.Gives the identity and origin contextinformation contained in the MsgDescparameter specified on the MQPUT orMQPUT1 call to the message.

True or False.


Running XA Transactions in Client (Outbound) ModeThe outbound WebSphere MQ Adapter supports XA transactions with WebSphere MQManager servers running on Solaris, AIX, HP-UX, Linux or Windows (not supported forOS/400 or z/OS). If your Sun Java Composite Application Platform Suite is installed on adifferent computer than your WebSphere MQ server, XA mode requires that you first install theWebSphere MQ base client, and then the WebSphere MQ Extended Transactional client, on theApplication Server.



The transaction manager of the WebSphere MQ Adapter in XA mode, runs in the SunIntegration Server. The Integration Server (IS) requires two JAR files, com.ibm.mq.jar andcom.ibm.mqetclient.jar, to be added to the Integration Server classpath..

The IBM document WebSphere MQ External Transactional Clients, provides information ondistributed XA transactions and limitations, such as WebSphere MQ API that cannot be issuedin XA mode.

According to IBM, when using the WebSphere MQ Extended Transactional client, a clientapplication can be connected to only one queue manager at a time within a single thread. Thisrestriction applies to the WebSphere MQ Extended Transactional client. (The WebSphere MQbase client can be connected to more than one queue manager concurrently within a singlethread.) For the WebSphere MQ Adapter this means, in one deployment, you are only allowedto have one outbound XA mode Adapter connecting to a WebSphere MQ external system. Youcannot have multiple XA outbound connections to different WebSphere MQ external systemsand expect the Integration Server Transactional manager to handle XA transaction for multipleWebSphere MQ queue managers.



ConfiguringJavaCAPSProject ComponentsforApplication Adapters · ConfiguringJavaCAPSProject...

Documents

Transcript of ConfiguringJavaCAPSProject ComponentsforApplication Adapters · ConfiguringJavaCAPSProject...