The topics in this section apply if you are using WebSphere MQ Integrator
(also referred to as WMQI) as the integration broker.
When you create and name a new connector configuration file, or when you
open an existing connector configuration file, Connector Configurator displays
a configuration screen with tabs for the categories of required configuration
values.
Connector Configurator requires values for properties in all of these
categories:
- Standard Properties
- Connector-Specific Properties
- Supported Business Objects
- Trace/Log File values
- Data Handlers (where applicable)
- Note:
- For connectors that use JMS messaging, an additional category may display,
for configuration of data handlers that convert the data to business
objects. For information about the values to use in the Data Handlers
category, see the Connector Development Guide for C++ or the
Connector Development Guide for Java.
- Important:
- Connector Configurator accepts property values in either English or
non-English character sets. However, the names of both standard and
connector-specific properties, and the names of supported business objects,
must use the English character set only.
Standard properties differ from connector-specific properties as
follows:
- Standard properties of a connector are shared by both the
application-specific component of a connector and its broker component.
All connectors have the same set of standard properties. These
properties are described in Appendix A of each adapter guide. You can
change some but not all of these values.
- Application-configuration (application-specific) properties apply only to
the application-specific component of a connector, that is, the component that
interacts directly with the application. Each connector has
application-specific properties that are unique to its application.
Some of these properties provide default values and some do not; you can
modify some of the default values. The installation and configuration
chapter of each adapter guide describes the application-specific properties
and the recommended values.
The fields for Standard Properties and Connector-Specific Properties are
color-coded to show which are configurable:
- A field with a grey background indicates a standard property. You
can change the value but cannot change the name or remove the property.
- A field with a white background indicates an application-specific
property. These properties vary according to specific needs of the
application or connector. You can change the value and delete these
properties.
- Value fields are configurable.
- The Update Method field is informational and not configurable. This
field specifies the action required to activate a property whose value has
changed.
To change the value of a standard property:
- Click in the field whose value you want to set.
- Either enter a value, or choose from the drop-down menu if one
appears.
- After entering all values for the standard properties, you can do one of
the following:
- To discard the changes, preserve the original values, and exit Connector
Configurator, choose File > Exit (or close the window), and choose No when
prompted to save changes.
- To enter values for other categories in Connector Configurator, choose the
tab for the category. The values you enter for Standard Properties (or
other category) are retained when you move to the next category; when you
close the window, you are prompted to either save or discard the values that
you entered in all of the categories as a whole.
- To save the revised values, choose File > Exit (or close the window)
and choose Yes when prompted to save changes. Alternatively, choose
Save > To File from either the File menu or the toolbar.
For application-specific configuration properties, you can add or change
property names, configure values, delete a property, and encrypt a
property:
- Click in the field whose name or value you want to set.
- Enter a name or value.
- To encrypt a property, click the Encrypt box.
- Choose to save or discard changes, as described for Setting Standard
Connector Properties.
The Update Method displayed for each property indicates whether a component
or agent restart is necessary to activatechanged values.
- Important:
- Changing a preset application-specific connector property name may cause a
connector to fail. Certain property names may be needed by the
connector to connect to an application or to run properly.
Application-specific properties can be encrypted by clicking the Encrypt
check box in the Edit Property window. To decrypt a value, click to
clear the Encrypt check box, enter the correct value in the Verification
dialog box, and choose OK. If the entered value is correct, the value
is decrypted and displays. The adapter guide for each connector
contains a list and description of each property and its default value.
When WebSphere MQ Integrator Broker is the integration broker, connector
properties are static. The Update Method is always Agent
Restart. In other words, for changes to take effect, you must restart
the connector agent after saving the revised connector configuration
file.
The procedures in this section assume that you have already created:
- Business object definitions
- MQ message set files (*.set files)
The *.set files contain message set IDs that Connector
Configurator requires for designating the connector's supported business
objects. See the Implementation Guide for WebSphere MQ Integrator
Broker for information about creating the MQ message set files.
Each time that you add business object definitions to the system, you must
use Connector Configurator to designate those business objects as supported by
the connector.
- Important:
- If the connector requires meta-objects, you must create message set files for
each of them and load them into Connector Configurator, in the same manner as
for business objects.
To specify supported business objects:
- Select the Supported Business Objects tab and choose Load. The Open
Message Set ID File(s) dialog displays.
- Navigate to the directory where you have placed the message set file for
the connector and select the appropriate message set file (*.set) or
files.
- Choose Open. The Business Object Name field displays the business
object names contained in the *.set file; the numeric message set
ID for each business object is listed in its corresponding Message Set ID
field. Do not change the message set IDs. These names and
numeric IDs are saved when you save the configuration file.
- When you add business objects to the configuration, you must load their
message set files. If you attempt to load a message set that contains a
business object name that already exists in the configuration, or if you
attempt to load a message set file that contains a duplicate business object
name, Connector Configurator detects the duplicate and displays the Load
Results dialog. The dialog shows the business object name or names for
which there are duplicates. For each duplicate name shown, click in the
Message Set ID field, and choose the Message Set ID that you wish to
use.
When you open a connector configuration file or a connector definition
file, Connector Configurator uses the logging and tracing values of that file
as default values. You can change those values in Connector
Configurator.
To change the logging and tracing values:
- Choose the Trace/Log Files tab.
- For either logging or tracing, you can choose to write messages to one or
both of the following:
- To console (STDOUT): Writes logging or tracing messages to the
STDOUT display.
- To File: Writes logging or tracing messages to a file that you
specify. To specify the file, choose the directory button (ellipsis),
navigate to the preferred location, provide a file name, and choose
Save. Logging or tracing message are written to the file and location
that you specify.
- Note:
- Both logging and tracing files are simple text files. You can use the
file extension that you prefer when you set their file names. For
tracing files, however, it is advisable to use the extension
.trace rather than .trc, to avoid
confusion with other files that might reside on the system. For logging
files, .log and .txt are typical file
extensions.
The data handlers section is available for configuration only if you have
designated a value of JMS for DeliveryTransport and a value of JMS for
ContainerManagedEvents. See the descriptions under
ContainerManagedEvents in Appendix A, Standard Properties, for values to use
for these properties. For additional details, see the Connector
Development Guide for C++ or the Connector Development Guide for
Java
