Installation guide

This document describes how to install and configure components of the IBM® WebSphere® Business Integration Express for Item Synchronization Fix Pack.

Deployment of the IBM WebSphere Business Integration Express for Item Synchronizaiton Fix Pack involves a series of component installations and configurations. Several elements are common to all engagements; other elements depend on your individual topology, set of installed enterprise applications, and on the marketplaces in which you participate.

---

Fix Pack components

The following tables list the components contained within the IBM WebSphere Business Integration Express for Item Synchronization Fix Pack. Note that there are many other existing components that can be utilized in your customized solution.

Repository files

The following repository files are included:
BIA_Retail_BO_ItemSync.jar
BIA_Retail_BO_ItemSyncSamples.jar
BIA_Retail_CT_ItemSync.jar
BIA_Retail_NM_ItemSync.jar
BIA_Retail_NM_ItemSyncSamples.jar

Collaboration templates

The following collaborations, in the BIA_Retail_CT_ItemSync.jar repository file, are included in the Fix Pack:
UCCnet_ItemSync
UCCnet_requestWorklist
UCCnet_processWorklist
Notify_by_eMail
CommandRouter
CI_Sync
CIN_CIP_Dispatcher
UCCnet_Price

Business objects

The following business objects are included in the Fix Pack.

Business objects in the BIA_Retail_BO_ItemSync.jar repository file

UCCnetGBO_envelope
UCCnetXSD_envelope
UCCnetTPIXSD_envelope
UCCnetJMSXSD_envelope
Retail_Item
Retail_Price

Business objects in the BIA_Retail_BO_ItemSyncSamples.jar repository file

Retail_Item_ASBO
Retail_Price_ASBO

Maps

The following maps are included in the Fix Pack.

Maps located in the BIA_Retail_NM_ItemSyncSamples.jar

Retail_Item_ASBO_to_Retail_Item
Retail_Price_ASBO_to_Retail_Price

Maps located in the BIA_Retail_NM_ItemSync.jar

Retail_Item_to_UCCnetXSD_envelope_publicationCommand_catalogueItem
Retail_Item _to_UCCnetJMSXSD_envelope_publicationCommand_catalogueItem
Retail_Item_to_UCCnetTPIXSD_envelope_publicationCommand_catalogueItem
Retail_Item_to_UCCnetGBO_env_publicationCommand_CIP
Retail_Item _to_UCCnetGBO_envelope_notifyCommand_catalogueItem
Retail_Item _to_UCCnetXSD_envelope_registerCommand_itemAddChange
Retail_Item _to_UCCnetJMSXSD_envelope_registerCommand_itemAddChange
Retail_Item_to_UCCnetTPIXSD_envelope_registerCommand_itemAddChange
Retail_Price_to_UCCnetJMSXSD_envelope
Retail_Price_to_UCCnetTPIXSD_envelope
Retail_Price_to_UCCnetXSD_envelope

Data base scripts

The following data base scripts are included for DB2

• Create_ItemSync_database.sql
• Create_ItemSync_tables.sql

Microsoft^(R) SQL Server uses the Create_ItemSync_tables.sql script to create the tables. However, you must create the database.

The following database scripts are included for DB2 UDB for iSeries

• ITMSNKDB – SQL source to create the QITEMSYNC database
• ITMSNKTBL – SQL source to create the tables in the QITEMSYNC database

The following CL program is included to create the database and tables on OS/400

• QWEBBIIAL – CL program to submit jobs which create the database and associated tables

Library file for collaboration templates

The CatalogueItemUtility.jar library file for collaboration templates is included.

License file updates (OS/400 only):

wbilicense.lic – License which will allow solutions to deploy 5 adapters as compared 4

---

Supported operating environments

The following operating environments are supported:

• Windows 2000 (Professional, Server, or Advanced Server) with Service Pack 4
• LINUX
1. Red Hat Enterprise Linux WS/ES/AS for Intel 2.1
2. SuSE Linux Enterprise Server 7.3
• OS/400® V5R2

---

Hardware prerequisites

The IBM WebSphere Business Integration Express for Item Synchronization Fix Pack has the same processor, memory, and disk space requirements as the IBM WebSphere Business Integration Express for Item Synchronization V4.3.1 product. To download, expand, and install this Fix Pack, you require 56.2 MB of free space. After the installation, you can remove the downloaded installation files and leave only the Fix Pack on your machine. The installed Fix Pack takes up 6.6 MB of space.

---

Software prerequisites

Ensure that you have installed the following prerequisites appropriately for your platform:

• For Windows & Linux – one of the following depending on your installation:
• IBM WebSphere Business Integration Express for Item Synchronization 4.3.1 (or)
• IBM WebSphere Business Integration Express Plus for Item Synchronization 4.3.1
• For OS/400 – Integration Assistant for iSeries V5.2.0, LPP 5722IA1 with one of the following depending on your installation:
• Option 13 – WebSphere Business Integration Express for Item Sync
• Option 14 – WebSphere Business Integration Express Plus for Item Sync

---

Installing and configuring the Fix Pack

This installation guide provides step-by-step instructions for installing and configuring the IBM WebSphere Business Integration Express for Item Synchronization Fix Pack. Install and configure the Fix Pack in the order listed below:

1. Planning the configuration details the connectivity and messaging decisions.
2. Configuring the system environment details setting up the system environment to run the IBM WebSphere Business Integration Express for Item Synchronization Fix Pack on all supported platforms.
3. Installing the components instructs how to load artifacts and install them in the InterChange Server Express repository, ensuring that the Fix Pack code is accessible to your system including the license file update for OS/400.
4. Creating the ItemSync database and tables describes how to create the relational tables required by the Fix Pack.
5. Configuring the metaobjects instructs how to create and configure the business objects required to properly process UCCnet messages.
6. Creating the database connection pool describes how to create the connection to the Item Sync database.
7. Creating and configuring the connectors describes how to create and configure the connectors.

Note:

The term connector used throughout refers to the runtime portion of an Adapter component of IBM WebSphere Business Integration Express for Item Synchronization. References to specific connectors are related to specific adapters, for example, "EmailConnector" refers specifically to the runtime component of an Adapter for e-Mail.

8. Creating and configuring the collaboration objects details the collaboration objects that must be created from the collaboration templates, and how to set the port connections and configuration properties for each collaboration object.
9. Deploying the Fix Pack details how to deploy the Fix Pack.

Planning the configuration

Before you install and configure the IBM WebSphere Business Integration Express for Item Synchronization Fix Pack, you must determine how you will connect to UCCnet and what message format and protocols you will use.

Connectors

The way you connect to UCCnet determines the connector that you use to communicate with it.

• If you exchange messages with UCCnet using an AS2/EDIINT interface protocol, you can use an iSoftConnector or you can use WebSphere Business Integration Connect.
• Use the iSoftConnector if you communicate with UCCnet through an iSoft Peer-to-Peer Agent.
• Use the JMS connector if you communicate with UCCnet through WebSphere Business Integration Connect Advanced/Enterprise edition.
• If you exchange messages through the UCCnet Command Line Utility (CLU), WebSphere Business Integration Connect Express, or are testing your installation, you can use a JTextConnector.
• If you are using an OS/400 ICS based solution incorporating WebSphere Business Integration Connect Express on OS/400 then your choice of connectivity will be the JTextConnector.
• If you are using an OS/400 ICS based solution incorporating UCCnet connectivity on a remote machine via JMS, then you will use the JMSConnector to access remote queues and/or queue managers on the remote machine.

Because the actual connector you use is dependent on your set up, this documentation uses AS2 channel connector as a general term for the iSoftConnector, JTextConnector, or JMSConnector.

Messages

Messages are exchanged with UCCnet in Extensible Markup Language (XML) documents. The XML document format and the protocol that you select for communication with UCCnet significantly impact the way that you set up your solution. The format of the XML documents exchanged with UCCnet is defined by an XML Schema Definition (XSD). The XSD mode of operation supports the following command protocols:

CIN operation

The supplier implements its own subscriber data pool. Catalogue_Item_Notification (CIN) messages are sent from the supplier directly to trading partners subscribed to the product categories.

CIP operation

The supplier uses UCCnet as the subscriber data pool. Catalogue_Item (CI) messages containing additional item information that is not included in the UCCnet registry data are sent from the supplier to UCCnet. Catalogue_Item_Publication messages are then sent to UCCnet to identify the subscribers to whom UCCnet needs to send CIN messages.

Configuring the system environment

To configure the system environment, complete the following steps. Be sure to follow the instructions appropriate for your platform where indicated.

1. Edit the CWCLASSES path, as follows:

Windows operating systems

Edit the <WebSphereICS_installation_dir>\bin\start_server.bat file by appending the end of the CWCLASSES path to include the CatalogueItemUtility.jar file, as shown in the following example:

CWCLASSES=...;%CROSSWORLDS%\lib\CatalogueItemUtility.jar 

LINUX operating systems

Edit the <WebSphereICS_installation_dir>/bin/CWSharedEnv.sh file and alter the CWCLASSES path to include the CatalogueItemUtility.jar file, as shown in the following example:

CWCLASSES=${CWCLASSES}:${CROSSWORLDS}/lib/CatalogueItemUtility.jar 

Note:

The CatalogueItemUtility.jar file must be copied from the Windows system to the LINUX system.

OS/400 operating systems

Edit the /QIBM/UserData/Webbiics/bin/start_server.sh file and append the path to CatalogueItemUtility.jar file to the CWCLASSES path as shown below:

 CWCLASSES=...:${CROSSWORLDS}/lib/CatalogueItemUtility.jar 

2. If you are running the System Manager from the WebSphere Studio Workbench SDK, edit the <WebSphereICS_installation_dir>\bin\cwtools.cfg file by adding the CatalogueItemUtility.jar file and its appropriate path information to the line classpath= in this file, as in the following example:

 classpath=<directory_location_of_CatalogueItemUtility.jar_file 
 -file>CatalogueItemUtility.jar

3. Configure the InterChange Server Express with e-mail information by doing the following:
• Open the System Manager.
• Connect to the InterChange Server Express.
• Right-click on the InterChange Server Express name and select Edit Configuration.
• On the E-mail tab, select Connector mail from the E-mail send type menu.
• Close the Edit Configuration window and save it when prompted.

Note:

The EmailConnector requires that the E-mail collaboration template be active on the server. The E-mail collaboration template is installed by default during installation of the InterChange Server Express, and must always be active, although it might not appear in any Component Library, and does not appear in the System Manager System View window.If you drop the InterChange Server Express repository and redeploy the IBM WebSphere Business Integration Express for Item Synchronization Fix Pack from the System Manager, you must restore the E-mail collaboration template to the repository by entering the following command (on one line):

• Windows operating systems:

o repos_copy -sICS_server_name 
o  -uICS_admin_ID 
o  -pICS_admin_password 
o  -ai -i<ICS_installation_path>\repository\Email.jar 
o  -xcompilepackage

• LINUX operating systems:

o repos_copy -sICS_server_name 
o  -uICS_admin_ID 
o  -pICS_admin_password 
o  -ai -i<ICS_installation_path>/repository/Email.jar 
o  -xcompilepackage

• OS/400 operating systems:

o repos_copy -sQWEBBIICS
o  -uICS_admin_ID 
o  -pICS_admin_password 
o  -ai -i/QIBM/ProdData/Webbiics/repository/Email.jar 
o  -xcompilepackage
o  

This command activates the E-mail collaboration template and does not require a restart of the InterChange Server Express.

1. Stop the InterChange Server Express.

Installing the components

Installation for Windows and Linux

Complete the following steps to ensure that the Fix Pack code is accessible to your system. Be sure to follow the instructions appropriate for your platform where indicated.

1. Start the InterChange Server Express in design mode (-design parameter).
2. Unzip the ItemSync_4.3.1.3_FixPack.zip file
3. Verify that the CatalogueItemUtility.jar file is in the directory specified in the classpath on the machine where the System Manager is installed. This ensures that the templates can be compiled successfully in the System Manager before deployment to the InterChange Server Express.
4. On LINUX systems, transfer the file <WebSphereICS_installation_dir>\lib\CatalogueItemUtility.jar from the Windows system to the LINUX system by using File Transfer Protocol (FTP) in binary mode. Place it in the <WebSphereICS_installation_dir>/lib/ directory.
5. Import the repository files into the System Manager as follows:
1. Create a new Integration Component Library (ICL).
2. Right-click the new ICL name, and select Import Repository File.
3. Browse to the repository .jar files and select one of the files.
4. Click Open.
5. Click Finish.
6. Repeat this process for each of the remaining repository files.

Installation for OS/400

1. Start the InterChange Server Express running on OS/400 in design mode.
2. Obtain, and apply this Item Sync fix pack onto the OS/400 system running the InterChange Server Express (this will copy the jars and related files to the OS/400 system).
3. From a Window’s PC which is running the tools, map a network drive to the OS/400 system which this fix pack was applied on.
4. From the OS/400 mapped drive copy the CatalogueItemUtility.jar located on the OS/400 system in /QIBM/ProdData/Webbiics/lib/CatalogueItemUtility.jar to <WebSphereICS_install_dir>\lib\CatalogueItemUtility.jar on the Window’s PC.
5. Verify that the CatalogueItemUtility.jar file is in the Windows directory specified in the classpath on the machine where the System Manager is installed. This ensures that the templates can be compiled successfully in the System Manager before deployment to the InterChange Server Express.
6. Import the repository files into the System Manager as follows:
1. Create a new Integration Component Library (ICL).
2. Right-click the new ICL name, and select Import Repository File.
3. Browse to the repository .jar files via a mapped drive to your OS/400 system and select one of the files which can be found in /QIBM/UserData/Webbiics/repository.
4. Click Open.
5. Click Finish.
6. Repeat this process for each of the remaining repository files.

Installing the updated license file (OS/400 only)

1. Obtain, and apply this Item Sync fix pack onto the OS/400 system running the InterChange Server Express (this will copy the jars and related files to the OS/400 system). Note: Skip this step if you have already applied this fix pack using the ‘Installation for OS/400’ section above.
2. Make a backup copy of <WebSphereICS_install_dir>\bin\wbilicense.lic on the Windows PC.
3. Copy /QIBM/ProdData/Webbiics/wbilicense.lic from the IFS of the OS/400 system which you applied this fix pack on, to <WebSphereICS_install_dir>\bin\ on the Window’s PC running the tools using a mapped network drive.
4. Restart your System Manager application if it is active.

Creating the ItemSync database and tables

Do the following steps to create the ItemSync database and PROCESSED_GTIN and AUDIT_LOG tables.

Be sure to follow the instructions appropriate for your platform.

Creating the data base on a Windows system

Do the following steps, as appropriate for your data base system.

DB2

The script you run creates a database called ITEMSYNC. You can edit the script to change the name of the database. The database name must match the name specified in the database connection pool created later in this installation.

The script also contains a drive and path to a DB2CLI.LST file which must be edited to match your DB2^(R) installation.

1. Start a DB2 session by opening a DB2 command window. Click Start > Programs > IBMDB2 > Command Line Tools > Command Window.
2. Change to the directory: <ICS_installation_path>\collaborations\dependencies\db2
3. To run the script.enter the command

 db2 < Create_ItemSync_Database.sql 

You can ignore the error messages from the DROP commands in the script.

4. To connect to the ITEMSYNC database, enter the command:

 db2 < connect to ITEMSYNC

5. Enter the command

 db2 < Create_ItemSync_Tables.sql

to run the script to create the tables.

Microsoft SQL Server

1. Create a database named ITEMSYNC.
2. Use the Query Analyzer tool to run the Create_ItemSync_Tables.sql script to create the tables.

Creating the data base on a LINUX system

Do the following steps, as appropriate for your data base system.

DB2

1. Transfer the files

 <ICS_installation_path>/collaborations/dependencies/UCCnet/db2/
 Create_ItemSync_Database.sql
 <ICS_installation_path>/collaborations/dependencies/UCCnet/db2/
 Create_ItemSync_tables.sql

to the LINUX system using FTP in ASCII mode. Place the file in the <ICS_installation_path>/collaborations/dependencies/UCCnet/db2 directory.

2. At the LINUX system, cd to the directory: <ICS_installation_path>/collaborations/dependencies/UCCnet/db2
3. Start the DB2 session. Enter the command

 db2 

4. When the session has started, enter the command

 < Create_ItemSync_Database.sql

to run the script.

5. Enter the command

 < Create_ItemSync_Dables.sql

to run the script to create the tables.

Creating the data base on a OS/400 system

Do the following steps, as appropriate for your data base system.

DB2 UDB for iSeries

1. Run the following CL command which will create a database named ‘QITEMSYNC’ and the appropriate tables (Note: This command takes approximately 1 minute to complete). The user issuing the command must have authority to the QWEBBIICS library and associated objects (Note: The QWEBBIICS subsystem must be active when issuing this command):

CALL QWEBBIICS/QWEBBIIAL

Configuring the metaobjects

You must configure (and in some cases create) the following metaobjects to properly process UCCnet XML messages. To perform these tasks, complete the following steps:

1. Edit the MO_DataHandler_DefaultXMLConfig metaobject by setting or adding the following attributes, then save it as MO_DataHandler_UCCnetXMLConfig.

Table 1. Selected attribute values for MO_DataHandler_UCCnetXMLConfig metaobject

Attribute name	Column	Setting
BOPrefix	Default	a. UCCnetXSD (for iSoft or WebSphere Business Integration Connect express connectivity ) b. UCCnetJMSXSD (For WebSphere Business Integration Connect Advanced/Enterprise-Java Message Service connectivity )
DefaultEscapeBehavior	Default	true
DTDPath	Default	Path to Envelope.xsd file. For example, <ICS_installation_path>\UCCnet\XSDs\uccnet\2.2\Envelope.xsd Notes: a. The attribute values shown are examples only. The actual value must be the fully qualified path to the Envelope.xsd file on your system. b. The Envelope file is available from the UCCnet eRoom. You must have a valid UCCnet eRoom user ID and password to obtain them.
IgnoreUndefinedElements	Default	true
Validation	Default	false (This must be set to false to keep the DataHandler from validating the messages against the UCCnetGBO envelope since this business object has been extended beyond the envelope.xsd file.)

2. Edit the MO_DataHandler_Default metaobject by setting the following attribute, then save it as MO_DataHandler_UCCnet_envelope.

Table 2. Selected attribute value for MO_DataHandler_UCCnet_envelope metaobject

Attribute name	Column	Setting
text_xml	Type	MO_DataHandler_UCCnetXMLConfig

3. Edit the MO_JTextConnector_Default metaobject by setting the following attributes, then save it as MO_JTextRWLConnector_Default.

Table 3. Selected attribute values for MO_JTextRWLConnector_Default metaobject

Attribute name	Column	Setting
ArchiveDir	Default	<Name of the directory where archive XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextRWL\archive). Create this directory if it does not already exist.
EndBODelimiter	Default	EOF
EventDataHandler	Type	MO_DataHandler_UCCnetXMLConfig
EventDir	Default	<Name of the directory to obtain input XMLs (Events)> (for example, C:\IBM\WebSphereICS\UCCnet\JTextRWL\event). Create this directory if it does not already exist.
EventExt	Default	xml
OutputDataHandler	Type	MO_DataHandler_UCCnetXMLConfig
OutputDir	Default	<Name of the directory where the XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextRWL\out). Create this directory if it does not already exist.
OutputExt	Default	xml
OutputFileName	Default	Native

4. If you are exchanging messages through the UCCnet CLU, WebSphere Business Integration Connect Express, or testing your installation, follow the instructions to create a JTextConnector meta object

a. Edit the MO_JTextConnector_Default metaobject by setting the following attributes, then save it as MO_JTextxxxConnector_Default Where xxx can be replaced with JMS if simulating a JMS connection, or omit the xxx characters if using an iSoft connector.

Table 4. Selected attribute values for MO_JTextxxxConnector_Default metaobject

Attribute name	Column	Setting
EventDataHandler	Type	MO_DataHandler_UCCnetXMLConfig
OutputDataHandler	Type	MO_DataHandler_UCCnetXMLConfig
OutputDir	Default	<Name of the directory where the XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextxxx\out). Create this directory if it does not already exist.
OutputExt	Default	xml
OutputFileName	Default	Native
ArchiveDir	Default	<Name of the directory where archive XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextxxx\archive). Create this directory if it does not already exist.
EventDir	Default	<Name of the directory to obtain input XML (Events)> (for example, C:\IBM\WebSphereICS\UCCnet\JTextxxx\event). Create this directory if it does not already exist.
EventExt	Default	xml
EndBODelimiter	Default	EOF

If you are planning to use the schema-supported Catalogue Item Publication functions, you must create a second instance of the JTextxxx connector metaobjects. Edit the MO_JTextxxxConnector_Default by setting the following attributes, then save it as MO_JTextxxx2Connector_Default.

Table 5. Selected attribute values for MO_JTextxxx2Connector_Default metaobject

Attribute name	Column	Setting
EventDataHandler	Type	MO_DataHandler_UCCnetXMLConfig
OutputDataHandler	Type	MO_DataHandler_UCCnetXMLConfig
OutputDir	Default	<Name of the directory where the XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextxxx\out). Create this directory if it does not already exist.
OutputExt	Default	xml
OutputFileName	Default	Native
ArchiveDir	Default	<Name of the directory where archive XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextxxx2\archive). Create this directory if it does not already exist.
EventDir	Default	<Name of the directory to obtain input XML (Events)> (for example, C:\IBM\WebSphereICS\UCCnet\JTextxxx2\event). Create this directory if it does not already exist.
EventExt	Default	xml
EndBODelimiter	Default	EOF

1. If you are exchanging messages with UCCnet through an AS2/EDIINT interface protocol, follow the instructions that apply to the connectivity that you are using:

iSoft connectivity

Use the Business Object Designer to create a metaobject called MO_iSoftAdapterConfig with the attributes shown in the following table. If you are using XSD CIP operation, you need two instances of the iSoft connector. However, because both instances use the same metaobject, only one metaobject is needed.

Table 6. Attribute values for MO_iSoftAdapterConfig

Attribute name	Type	Key	Application Specific Information
Default	String	x	OutputQueue=queue:// my_p2p_agent_queue_manager_name/ my_outbox_queue_name; DataEncoding=Text
UCCnetXSD_envelope_Create (for schema support)	String		If the application specific information provided for the Default attribute is insufficient for your installation, additional information on this metaobject is available in the Adapter for iSoft Peer-to-Peer Agent User Guide.

WebSphere Business Integration Connect Advanced/Enterprise-Java Message Service connectivity

Use the Business Object Designer to create a metaobject called MO_JMSAdapterConfig with the attributes shown in the following table.

Table 7. Attribute values for MO_JMSAdapterConfig

Attribute name	Type	Key	Application specific information
Default	String	x	OutputQueue=my_output_queue_name; where my_output_queue_name specifies where to deliver the messages.
UCCnetJMSXSD_envelope_create (for XSD support)	String		The application specific information provided for the Default attribute might be sufficient for your installation. For additional information on this metaobject, refer to the Adapter for Java Message Service Agent User Guide.

2. Set the following attributes in the EmailNotification business object:

Table 8. Selected attribute values for EmailNotification business object

Name	Column	Setting
RecipientName	Default	E-mail address of recipient.
FromAddress	Default	E-mail address of sender.

Creating the database connection pool

The Item Sync collaborations use a database connection pool to access the ITEMSYNC database (Note: For OS/400 the database is named QITEMSYNC) PROCESSED_GTIN and AUDIT_LOG tables. See IBM WebSphere Business Integration Express for Item Synchronization System Administration Guide for instructions on creating a connection pool. Ensure the following values are set when you define the database connection pool:

• Use the appropriate Database Driver, Login ID, and Password. The Login ID and password used in the connection pool must match those used when creating the database and tables.
• The database name must match the name used in the database creation script. The default value in the script is ITEMSYNC (use QITEMSYNC for OS/400).
• The Connection Pool name must match the value set in the collaboration object's DB_CONN_POOL_NAME collaboration property. The default value of the property is ITEMSYNC_DATA.

Creating and configuring the connectors

The connectors that must be created or configured depend on the individual installation, as follows:

• Create and configure the JTextRWLConnector in every installation. See Creating and configuring the JTextRWLConnector.
• Configure, or if necessary, create and configure one of the following connectivity connectors depending on the connectivity type you are using and the protocol you are using to exchange messages:

Table 9. Connectors and connector information

Connectivity type and protocol	Connector to configure
Exchanging messages with UCCnet through an AS2/EDIINT interface protocol and using iSoft connectivity	Creating and configuring the iSoftConnector
Exchanging messages with UCCnet through an AS2/EDIINT interface protocol and are using the WebSphere Business Integration Connect Advanced/Enterprise interface, or if you are using an OS/400 ICS based solution incorporating UCCnet connectivity on a remote machine and wish to use JMS to access remote queues or queue managers on the remote host.	Creating and configuring the first instance of the JMSConnector
Testing your installation, and are using iSoft connectivity or WebSphere Business Integration Connect express, or if you are using an OS/400 ICS based solution incorporating WebSphere Business Integration Connect Express on the OS/400	Creating and configuring the JTextConnector

• Configure the PortConnector in every installation, as detailed in the section Configuring the PortConnector.
• If you want to use the e-mail capabilities of the IBM WebSphere Business Integration Express for Item Synchronization Fix Pack, configure the EmailConnector, as detailed in the section Configuring the EmailConnector.

The connector configuration procedures defined in the following sections assume the connector configuration information is saved to the project, where it is accessed by the connector at startup time. As an alternative, the connector configuration information can be saved to a file and the connector startup procedure can be altered to access that file. For additional information on options for starting your connectors, refer to the System Administration Guide.

Creating and configuring the JTextRWLConnector

The JTextRWLConnector is the input connector for a UCCnet_requestWorklist collaboration object. The UCCnet_requestWorklist collaboration object passes a UCCnet worklist request to UCCnet from a file system folder. To poll for the worklist, a scheduler operation performed by an operating system must be configured to periodically drop a fresh copy of the request .xml into the event file system folder for the JTextRWLConnector.

Creating the JTextRWLConnector

To create the JTextRWLConnector, complete the following steps:

1. Open the System Manager.
2. Save the JTextRWLConnector by doing the following:
1. Open the JTextConnector.
2. Click File > Save As > To Project.
3. Save the connector as JTextRWLConnector.

Configuring the JTextRWLConnector

Perform the following steps to configure the JTextRWLConnector:

1. Configure this connector to include the standard configuration property and appropriate business objects. Use the values shown in the following tables.

Table 10. Standard property

Property name	Value
ApplicationName	JTextRWLConnector

Table 11. Supported business objects

Business object name	Agent support required?
MO_JTextRWLConnector_Default	Yes
MO_DataHandler_UCCnet_envelope	Yes
One of the following: o UCCnetXSD_envelope (when iSoft or WebSphere Business Integration Connect express connectivity and XSD XML definition type are used) o UCCnetJMSXSD_envelope (when WebSphere Business Integration Connect Advanced/Enterprise connectivity and XSD XML definition type are used)	Yes
UCCnetGBO_envelope	No

2. Save the configuration (File > Save > To Project), then go back to the Associated Map tab and set the explicit bindings.

Table 12. Associated maps

Business object name	Map name
UCCnetXSD_envelope for iSoft connectivity or WebSphere Business Integration Connect express	UCCnetXSD_envelope_to_UCCnetGBO_envelope
UCCnetJMSXSD_envelope for WebSphere Business Integration Connect Advanced/Enterprise	UCCnetJMSXSD_envelope_to_UCCnetGBO_envelope
UCCnetGBO_envelope	o iSoft connectivity or WebSphere Business Integration Connect express: UCCnetGBO_envelope_to_UCCnetXSD_envelope o WebSphere Business Integration Connect Advanced/Enterprise: UCCnetGBO_envelope_to_UCCnetJMSXSD_envelope

3. Save the configuration file (File > Save > To Project), then close the Connector Configurator.
4. Create the JTextRWLConnector Agent, as follows:

Windows operating systems

a. In the Windows task bar, right-click Start and select Open All Users.

b. Navigate to the folder on your system that contains the installed connectors by clicking Programs > IBM WebSphere Business Integration Express for Item Sync > Adapters > Connectors.

c. Copy the JText Connector short cut and rename it to JTextRWL Connector.

d. Right-click the JTextRWL Connector short cut and select Properties.

e. Click the Short cut tab, edit the Target field, and set the first command line argument to JTextRWL, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

f. <install_path>\IBM\WebSphereICS\connectors\JText
g.  \start_JText.bat JTextRWL ICS_server_name
h.  

LINUX operating systems

(There is nothing to perform at this point. Use these steps later when you actually want to start the Jtext Connector Agent after the connector has been deployed)

i. Change to the <install_path>/IBM/WebSphereICS/connectors/JText/ directory.

j. Run JTextRWL. by entering the following command, where ICS_server_name refers to the name of the InterChange Server Express:

k. start_JText.sh JTextRWL ICS_server_name 

OS/400 operating systems

a. On the OS/400 system which will run the adapter, copy /QIBM/UserData/Webbiics/connectors/JText to /QIBM/UserData/Webbiics/connectors/JTextRWL

b. Set the IFS authorities to the contents of /QIBM/UserData/Webbiics/connectors/JTextRWL appropriately

c. Using System Manager, open the JTextRWL connector and save it to /QIBM/UserData/Webbiics/connectors/JTextRWL/JTextRWLConnector.cfg using File > Save > Save To File and browse to the IFS location via a mapped drive

d. Select Programs > IBM WebSphere Business Integration Express for Item Sync > iSeries remote, right-click Adapters and select Explore

e. Copy the JText Connector short cut and rename it to JTextRWLConnector.

f. Right-click the JTextRWLConnector short cut and select Properties.

g. Click the Short cut tab, edit the Target field, and set the first command line argument to JTextRWLConnector, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

C:\IBM\WebSphereItemSync\scripts\runCommand.bat start_adapter JTextRWL/start_JText.sh JTextRWL QWEBBIICS QWEBBIJTC

h. On the OS/400 system, edit the /QIBM/UserData/Webbiics/connectors/JTextRWL/start_JText.sh script to contain the –c with the path to the configuration file, and also –b parameter in the last line of the script.

For example:

java -Djava.version=1.3 ${ORB_PROPERTY} -Djava.ext.dirs=${CROSSWORLDS}/lib/ext -Djava.library.path=${CROSSWORLDS}/bin:${CONNDIR}:${MQ_LIB} -Duser.home=${CROSSWORLDS} -cp ${JCLASSES} AppEndWrapper -lcom.crossworlds.connectors.jtext.ConnectorAgent -n${CONNAME}Connector -s${SERVER} –c/QIBM/UserData/Webbiics/connectors/JTextRWL/JTextRWLConnector.cfg -b ${PARM3} ${PARM4}

Creating and configuring the iSoftConnector

Open the iSoft connector in the Connector Configurator and configure this connector only if you are using the iSoft Peer-to-Peer Agent and are communicating with UCCnet through an AS2/EDIINT interface protocol.

Creating and configuring the first instance of the iSoftConnector

Note:

The iSoft connector is not supported natively on OS/400.

Perform the following steps to configure the first instance of the iSoftConnector:

1. Set the value of the MQSERIES_JAVA_LIB attribute in the connector startup file (start_iSoft.bat on Windows, start_iSoft.sh on LINUX ) to the location of your WebSphere MQ Java client libraries (for example, C:\Program Files\IBM\WebSphere MQ\Java\lib).
2. Configure this connector to include the connector-specific configuration properties and appropriate business objects. Use the values shown in the following tables.

Table 13. Connector-specific properties

Property name	Value
ArchiveQueue	Queue to which copies of successfully processed messages are sent (for example, queue://my_p2p_agent_queue_manager_name/archive)
Channel	WebSphere MQ server connector channel for your iSoft Peer-to-Peer Agent queue manager.
ConfigurationMetaObject	MO_iSoftAdapterConfig
DataHandlerConfigMO	MO_DataHandler_UCCnet_envelope
DefaultVerb	Create (add this property if it does not appear in the list of connector-specific properties)
ErrorQueue	Queue to which messages that could not be processed are sent (for example, queue://my_p2p_agent_queue_manager_name/error)
HostName	The name of the host running the iSoft Peer-to-Peer Agent WebSphere MQ queue manager.
InputQueue	Semicolon-delimited list of message queues that are polled by the connector for new messages (for example, queue://my_p2p_agent_queue_manager_name/inbox1; queue://my_p2p_agent_queue_manager_name/inbox2)
InProgressQueue	Message queue where messages are held during processing (for example, queue://my_p2p_agent_queue_manager_name/in_progress)
Port	Port established for the WebSphere MQ listener of the iSoft Peer-to-Peer Agent's queue manager.
UnsubscribedQueue	Queue to which messages that are not subscribed are sent (for example, queue://my_p2p_agent_queue_manager_name/unsubscribed)
UseDefaults	true (add this property if it does not appear in the list of connector-specific properties)

Table 14. Supported business objects

Business object name	Agent support required?
MO_DataHandler_UCCnet_envelope	Yes
MO_iSoftAdapterConfig	Yes
UCCnetXSD_envelope	Yes
UCCnetGBO_envelope	No
Retail_Item	No
Retail_Price	No

3. Save the configuration (File > Save > To Project), then go back to the Associated Map tab and set the explicit bindings.

Table 15. Associated maps

Business object name	Map name
Retail_Item	Retail_Item_to_UCCnetXSD_envelope_registerCommand_itemAddChange
Retail_Price	Retail_Price_to_UCCnetXSD_envelope
UCCnetGBO_envelope	UCCnetGBO_envelope_to_UCCnetXSD_envelope
UCCnetXSD_envelope	UCCnetXSD_envelope_to_UCCnetGBO_envelope

4. Save the configuration (File > Save > To Project) then close the Connector Configurator.

Creating and configuring the second instance of the iSoftConnector

Note:
The iSoft connector is not supported natively on OS/400.

If you are setting up for XSD CIP operation, you need two instances of the iSoft connector. Do the following steps to configure the second instance:

1. Open the System Manager.
2. Save the iSoft2Connector by doing the following:
1. Open the iSoftConnector.
2. Click File > Save As > To Project.
3. Save the connector as iSoft2Connector.
3. Open the iSoft2Connector in the Connector Configurator and configure this connector to include the connector-specific configuration properties and appropriate business objects. Use the values shown in the following tables.

Table 16. Connector-specific properties

Property name	Value
ArchiveQueue	Queue to which copies of successfully processed messages are sent (for example, queue://my_p2p_agent_queue_manager_name/archive2)
Channel	WebSphere MQ server connector channel for your iSoft Peer-to-Peer Agent queue manager.
ConfigurationMetaObject	MO_iSoftAdapterConfig
DataHandlerConfigMO	MO_DataHandler_UCCnet_envelope
DefaultVerb	Create (add this property if it does not appear in the list of connector-specific properties)
ErrorQueue	Queue to which messages that could not be processed are sent (for example, queue://my_p2p_agent_queue_manager_name/error2)
HostName	The name of the host running the iSoft Peer-to-Peer Agent WebSphere MQ queue manager.
InputQueue	Semi-colon-delimited list of message queues that are polled by the connector for new messages (for example, queue://my_p2p_agent_queue_manager_name/inbox3; queue://my_p2p_agent_queue_manager_name/inbox4) Note: The inbox for the second instance of the iSoft connector must not be the same as the inbox for the first instance of the iSoft connector. This instance of the connector is not configured to receive business objects.
InProgressQueue	Message queue where messages are held during processing (for example, queue://my_p2p_agent_queue_manager_name/in_progress2)
Port	Port established for the WebSphere MQ listener of the iSoft Peer-to-Peer Agent's queue manager.
UnsubscribedQueue	Queue to which messages that are not subscribed are sent (for example, queue://my_p2p_agent_queue_manager_name/unsubscribed2)
UseDefaults	true (add this property if it does not appear in the list of connector-specific properties)

Table 17. Supported business objects

Business object name	Agent support required?
MO_DataHandler_UCCnet_envelope	Yes
MO_iSoftAdapterConfig	Yes
UCCnetXSD_envelope	Yes
Retail_Item	No

4. Create the iSoft2Connector Agent, as follows:

Windows operating systems

1. In the Windows task bar, right-click Start and select Open All Users.
2. Navigate to the folder on your system that contains the installed connectors by clicking Programs > IBM WebSphere Business Integration Express for Item Sync > Adapters > Connectors.
3. Copy the iSoftConnector short cut and rename it to iSoft2Connector.
4. Right-click the iSoft2Connector short cut and select Properties.
5. Click the Short cut tab, edit the Target field, and set the first command line argument to iSoft2, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

f. <install_path>\connectors\iSoft\start_iSoft.bat iSoft2 ICS_server_name

LINUX operating systems

(There is nothing to perform at this point. Use these steps later when you actually want to start the Jtext Connector Agent after the connector has been deployed)

7. Change to the <install_path>/IBM/WebSphereICS/connectors/iSoft/ directory.
8. Run iSoft2. by entering the following command, where ICS_server_name refers to the name of the InterChange Server Express:

i. start_jText.sh iSoft2 ICS_server_name 

5. Save the configuration (File > Save > To Project), then go back to the Associated Map tab and set the explicit bindings.

Table 18. Associated maps

Business object name	Map name
Retail_Item	Retail_Item_to_UCCnetXSD_envelope_publicationCommand_catalogueItem

6. Save the configuration (File > Save > To Project) then close the Connector Configurator.

Refer to the Adapter for iSoft Peer-to-Peer Agent User Guide for more information about this connector.

Creating and configuring the JTextConnector

Create and configure this connector only if you are using the iSoft Peer-to-Peer Agent and are communicating with UCCnet through the UCCnet CLU , using or WebSphere Business Integration Connect express ,or testing your installation. This is a copy of the JTextConnector. The JTextConnector uses the IBM WebSphere Business Integration Data Handler for XML and generates the same XML output.

If you are setting up for XSD CIP operation, you need to configure two instances of the JText connector. Otherwise, you need to create and configure only the first instance.

Creating and configuring the first instance of the JTextxxxConnector

1. Create the JTextxxxConnector using the System Manager, as follows:
1. Open the System Manager.
2. Save the JTextxxxConnector by doing the following:
1. Open the JTextConnector.
2. Click File > Save As > To Project.
3. Save the connector as JTextxxxConnector.
3. Create the JTextxxxConnector Agent, as follows:

Windows operating systems

1. In the Windows task bar, right-click Start and select Open All Users.
2. Navigate to the folder on your system that contains the installed connectors by clicking Programs > IBM WebSphere Business Integration Express for Item Sync > Adapters > Connectors.
3. Copy the JText Connector short cut and rename it to JTextxxxConnector.
4. Right-click the JTextxxxConnector short cut and select Properties.
5. Click the Short cut tab, edit the Target field, and set the first command line argument to JTextxxx, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

 vi. <install_path>\connectors\JText\start_JText.bat JTextxxx ICS_server_name

LINUX operating systems

7. Change to the <install_path>/IBM/WebSphereICS/connectors/JText/ directory.
8. Run JTextxxx by entering the following command, where ICS_server_name refers to the name of the InterChange Server Express:

 ix. start_JText.sh JTextxxx ICS_server_name 

OS/400 operating systems

i. On the OS/400 system which will run the adapter, copy /QIBM/UserData/Webbiics/connectors/JText to /QIBM/UserData/Webbiics/connectors/JTextxxx

ii. Set the IFS authorities to the contents or /QIBM/UserData/Webbiics/connectors/JTextxxx appropriately

iii. Using System Manager open JTextxxx connector and save it to /QIBM/UserData/Webbiics/connectors/JTextxxx/JTextxxxConnector.cfg using the File>Save>Save To File option and browse to the IFS location via a mapped network drive

iv. Select Programs > IBM WebSphere Business Integration Express for Item Sync > iSeries remote, right-click Adapters and select Explore

v. Copy the JText Connector short cut and rename it to JTextxxxConnector.

vi. Right-click the JTextxxxConnector short cut and select Properties.

vii. Click the Short cut tab, edit the Target field, and set the first command line argument to JTextxxxConnector, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

viii. C:\IBM\WebSphereItemSync\scripts\runCommand.bat start_adapter JTextxxx/start_JText.sh JTextxxx QWEBBIICS QWEBBIJTC

ix. On the OS/400 system, edit the /QIBM/UserData/Webbiics/connectors/JTextxxx/start_JText.sh script to contain the –c option to specify the configuration file, and the –b parameter in the last line of the script.

For example:

java -Djava.version=1.3 ${ORB_PROPERTY} -Djava.ext.dirs=${CROSSWORLDS}/lib/ext -Djava.library.path=${CROSSWORLDS}/bin:${CONNDIR}:${MQ_LIB} -Duser.home=${CROSSWORLDS} -cp ${JCLASSES} AppEndWrapper -lcom.crossworlds.connectors.jtext.ConnectorAgent -n${CONNAME}Connector -s${SERVER} –c/QIBM/UserData/Webbiics/connectors/JTextxxx/JTextxxxConnector.cfg -b ${PARM3} ${PARM4}

Perform the following steps to configure the JTextxxxConnector:

1. Configure this connector to include the standard configuration property and appropriate business objects. Use the values shown in the following tables.

Table 25. Standard property

Property name	Value
ApplicationName	JTextxxxConnector

Table 26. Supported business objects

Business object name	Agent support required?
MO_JTextxxxConnector_Default	Yes
MO_DataHandler_UCCnet_envelope	Yes
UCCnetXSD_envelope	Yes
Retail_Item	No
Retail_Price	No
UCCnetGBO_envelope	No

2. Save the configuration (File > Save > To Project), then go back to the Associated Map tab and set the explicit bindings.

Table 27. Associated maps

Business object name	Map name
Retail_Item	Retail_Item_to_UCCnetXSD_envelope_registerCommand_itemAddChange
UCCnetGBO_envelope	UCCnetGBO_envelope_to_UCCnetXSD_envelope
UCCnetXSD_envelope	UCCnetXSD_envelope_to_UCCnetGBO_envelope
Retail_Price	Retail_Price_to_UCCnetXSD_envelope

3. Save the configuration (File > Save > To Project), then close the Connector Configurator.

Creating and configuring the second instance of the JTextxxxConnector

The second instance of the JTextxxxConnector is used only for XSD CIP operation. If it is required, create it as follows:

1. Create the JTextxxx2Connector using the System Manager, as follows:
1. Open the System Manager.
2. Save the JTextxxx2Connector by doing the following:
1. Open the JTextxxxConnector.
2. Click File > Save As > To Project.
3. Save the connector as JTextxxx2Connector.
3. Create the JTextxxx2Connector Agent, as follows:

Windows operating systems

i. If the connector needs to use a separate JTextxxx2Connector.cfg please create the cfg by saving the connector using the File>Save>Save To File option in System Manager. The JTextxxx2Connector.cfg needs to be passed as an argument to the connector using the –c option. Alternatively a new JTextxxx2Connector directory can also be created by copying …/connectors/JText/ directory as …/connectors/JTextxxx2/.

2. In the Windows task bar, right-click Start and select Open All Users.
3. Navigate to the folder on your system that contains the installed connectors by clicking Programs > IBM WebSphere Business Integration Express for Item Sync > Adapters > Connectors.
4. Copy the JTextxxxConnector short cut and rename it to JTextxxx2Connector.
5. Right-click the JTexxxx2Connector short cut and select Properties.
6. Click the Short cut tab, edit the Target field, and set the first command line argument to JTextxxx2, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

 vii.  <install_path>\connectors\JText\start_JText.bat JTextxxx2 ICS_server_name. 

LINUX operating systems

viii. If the connector needs to use a separate JTextxxx2Connector.cfg please create the cfg by saving the connector using the File>Save>Save To File option in System Manager. The JTextxxx2Connector.cfg needs to be passed as an argument using the –c option. Alternatively a new JTextxxx2Connector directory can also be created by copying …/connectors/JText/ directory as …/connectors/JTextxxx2/.

9. Change to the <install_path>/IBM/WebSphereICS/connectors/JText/ directory or to the appropriate directory.
10. Run JTextxxx2. by entering the following command, where ICS_server_name refers to the name of the InterChange Server Express:

 xi. start_JText.sh JTextxxx2 ICS_server_name 

OS/400 operating systems

i. On the OS/400 system which will run the adapter, copy /QIBM/UserData/Webbiics/connectors/JText to /QIBM/UserData/Webbiics/connectors/JTextxxx2

ii. Set the IFS authorities to the contents or /QIBM/UserData/Webbiics/connectors/JTextxxx2 appropriately

iii. Using System Manager open JTextxxx2 connector and save it to /QIBM/UserData/Webbiics/connectors/JTextxxx2/JTextxxx2Connector.cfg using the File>Save>Save To File option

iv. Select Programs > IBM WebSphere Business Integration Express for Item Sync > iSeries remote, right-click Adapters and select Explore

v. Copy the JText Connector short cut and rename it to JTextxxx2Connector.

vi. Right-click the JTextxxx2Connector short cut and select Properties.

vii. Click the Short cut tab, edit the Target field, and set the first command line argument to JTextxxx2Connector, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

viii. C:\IBM\WebSphereItemSync\scripts\runCommand.bat start_adapter JTextxxx2/start_JText.sh JTextxxx2 QWEBBIICS QWEBBIJTC

ix. On the OS/400 system, edit the /QIBM/UserData/Webbiics/connectors/JTextxxx2/start_JText.sh script to contain the –c option to specify the configuration file, and the –b parameter in the last line of the script.

For example:

java -Djava.version=1.3 ${ORB_PROPERTY} -Djava.ext.dirs=${CROSSWORLDS}/lib/ext -Djava.library.path=${CROSSWORLDS}/bin:${CONNDIR}:${MQ_LIB} -Duser.home=${CROSSWORLDS} -cp ${JCLASSES} AppEndWrapper -lcom.crossworlds.connectors.jtext.ConnectorAgent -n${CONNAME}Connector -s${SERVER} –c/QIBM/UserData/Webbiics/connectors/JTextxxx2/JTextxxx2Connector.cfg -b ${PARM3} ${PARM4}

Perform the following steps to configure the JTextxxx2Connector:

1. Configure this connector to include the standard configuration property and appropriate business objects. Use the values shown in the following tables.

Table 28. Standard property

Property name	Value
ApplicationName	JTextxxx2Connector

Table 29. Supported business objects

Business object name	Agent support required?
MO_JTextxxx2Connector_Default	Yes
MO_DataHandler_UCCnet_envelope	Yes
UCCnetXSD_envelope	Yes
Retail_Item	No

2. Save the configuration (File > Save > To Project), then go back to the Associated Map tab and set the explicit bindings.

Table 30. Associated map

Business object name	Map name
Retail_Item	Retail_Item_to_UCCnetXSD_envelope_publicationCommand_catalogueItem

3. Save the configuration (File > Save > To Project), then close the Connector Configurator.

Creating and configuring the JMSConnector

Create and configure this connector only if you are communicating with UCCnet through a WebSphere Business Integration Connect Advanced/Enterprise interface. If you are setting up your system to use the XSD CIP operation, you must create and configure two instances of the JMSConnector connector.

Creating and configuring the first instance of the JMSConnector

To create and configure the JMSConnector, complete the following steps:

Note:

In the situation where your UCCnet connectivity is located on a remote machine and you need to use the JMS adapter to communicate with a remote queue manager, then the following steps will apply to OS/400. For OS/400 queues, you can use the iSeries remote tools from a Window’s client: Start>Programs>IBM WebSphere Business Integration Express for Item Sync>iSeries remote>InterChange Server Express> Configure Queue Manager. This will open crossworlds_mq.tst (on OS/400) in NotePad on your PC. From NotePad you can edit the file to contain the Queues you need to create (see samples in your installed files directory). When you close NotePad, the OS/400 tools will create your Queue definitions in the Queue Manager listed in InterchangeSystem.cfg.

1. Create the following channels and queues using MQ Explorer, or the runmqsc tool:
1. Start runmqsc:

 runmqsc local_queue_manager name

2. Define a transmission queue

 DEFINE QLOCAL(xmit q_name) USUAGE(XMITQ) MAXMSGL(10485760)

3. Define a sender channel for sending messages to WebSphere Business Integration Connect (Enter the following on one line. It is formatted for readability.)

 DEFINE CHANNEL(channel_name) CHLTYPE(SDR) XMITQ(xmit q_name) CONNAME
  ('IP_address_of_Business_Integration_Conenct_machine(listener_port)%csq;) MAXMSGL(10485760)

Note:

On the Business Integration Connect machine, you must have a channel of type "Server Connection" defined with the same name you define for the channel here.

4. Define a receiver channel for receiving messages from WebSphere Business Integration Connect

 DEFINE CHANNEL (channel_name) CHLTYPE (RCVR) MAXMSGL(10485760)

5. Define a Remote queue

 DEFINE QREMOTE(q_name) RNAME(name_of_input_queue_for_Business_Integration_Connect)
 RQMNAME(QM_name_used_by_Business_Integration_Connect) XMITQ(name_of_transmission_queue) 

6. Define a local queue for receiving messages

 DEFINE QLOCAL(Input_qname) MAXMSGL(10485760) DEFPSIST(YES);

2. Create the JMS bindings files:

Note:

On OS/400 you will need to edit the /QIBM/ProdData/mqm/java/bin/JMSAdmin script to contain the class paths to the WebSphere MQ jar files. Below is a sample JMSAdmin script for OS/400:

#!/bin/sh

# ------------------------------------------------------------

# IBM Websphere MQ Support for Java Message Service

# IBM Websphere MQ JMS Admin Tool Execution Script

# for Unix variants

#

# Licensed Materials - Property of IBM

#

# 5648-C60 5724-B4 5655-F10

#

# (c) Copyright IBM Corp. 2002. All Rights Reserved.

#

# US Government Users Restricted Rights - Use, duplication or

# disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

#

# Note that the properties passed to the java program are defaults,

# and should be edited to suit your installation if necessary

# ------------------------------------------------------------

export MQ_JAVA_INSTALL_PATH=/QIBM/ProdData/mqm/java

export MQ_CP=$MQ_JAVA_INSTALL_PATH/lib/com.ibm.mq.jar

export MQ_CP=$MQ_CP:$MQ_JAVA_INSTALL_PATH/lib/com.ibm.mqjms.jar

export MQ_CP=$MQ_CP:$MQ_JAVA_INSTALL_PATH/lib/jms.jar

export MQ_CP=$MQ_CP:$MQ_JAVA_INSTALL_PATH/lib/jndi.jar

export MQ_CP=$MQ_CP:$MQ_JAVA_INSTALL_PATH/lib/providerutil.jar

export MQ_CP=$MQ_CP:$MQ_JAVA_INSTALL_PATH/lib/connector.jar

export MQ_CP=$MQ_CP:$MQ_JAVA_INSTALL_PATH/lib/fscontext.jar

export MQ_CP=$MQ_CP:$MQ_JAVA_INSTALL_PATH/lib

export MQ_LOG_DIR=-DMQJMS_LOG_DIR=$MQ_JAVA_INSTALL_PATH/log

export MQ_TRACE_DIR=-DMQJMS_TRACE_DIR=$MQ_JAVA_INSTALL_PATH/trace

export MQ_INSTALL_PATH=-DMQJMS_INSTALL_PATH=$MQ_JAVA_INSTALL_PATH

export MQ_FLAGS="${MQ_LOG_DIR} ${MQ_TRACE_DIR} ${MQ_INSTALL_PATH}"

export PATH=$MQ_JAVA_INSTALL_PATH/bin:$MQ_JAVA_INSTALL_PATH/lib:$PATH

java -classpath $MQ_CP $MQ_FLAGS com.ibm.mq.jms.admin.JMSAdmin $*

You will also need to ensure the /QIBM/ProdData/mqm/java/bin/JMSAdmin.config script is in CCSID 819. If your JMSAdmin.config is not in CCSID 819 you can use the CPY command and specify the source and destination CCSID to copy your JMSAdmin.config to CCSID 819.

1. Modify the <MQ_JAVA_INSTALL_PATH>\bin\JMSAdmin.config file as follows:
1. Comment out the following line:

 INITIAL_CONTEXT_FACTORY=com.sun.jndi.ldap.LdapCtxFactory

2. Uncomment the following line:

INITIAL_CONTEXT_FACTORY=com.sun.jndi.fscontext.RefFSContextFactory

3. Set the PROVIDER_URL variable to point to the directory where you want the JMS bindings file to be placed.

For example:

PROVIDER_URL=file:/C:/IBM/WebSphereICS/connectors/JMS

On OS/400:

 PROVIDER_URL=file:/QIBM/UserData/Webbiics/connectors/JMS

Note:

This directory must exist, and you must have write permission for it.

4. Leave the rest of the file as it is.
1. Save your changes.
2. Create a new file called WBIRetail.jdni with the following content:

Note:
For OS/400 you will be defining many of these queues as remote queues (interfacing with remote UCCnet connectivity), thus depending on your configuration substitute remote queue definitions where appropriate

d. *
e. * JDNI Configured Objects for Information Pipeline
f. * Used by MQSeries JMS*
g. *
h. *
i. DEFINE QCF(WBIC_JMSQCF) +
j. TRAN(client) HOST(HOST_NAME) PORT(1414) +
k. CHANNEL(CHANNEL_NAME) CLIENTID(' ')
l. *
m. * Queues
n. *
o. DEFINE Q(INPUTQ) +
p. QUEUE(INPUTQ) +
q. TARGCLIENT(JMS)
r. *
s. DEFINE Q(REPLYQ) +
t. QUEUE(REPLYQ) +
u. TARGCLIENT(JMS)
v. *
w. DEFINE Q(REMOTEQ) +
x. QUEUE(REMOTEQ) +
y. TARGCLIENT(JMS)
z. *
aa. DEFINE Q(ERRORQ) +
bb. QUEUE(ERRORQ) +
cc. TARGCLIENT(JMS)
dd. *
ee. DEFINE Q(IN_PROGRESSQ) +
ff. QUEUE(IN_PROGRESSQ) +
gg. TARGCLIENT(JMS)
hh. *
ii. DEFINE Q(UNSUBSCRIBEQ) +
jj. QUEUE(UNSUBSCRIBEQ) +
kk. TARGCLIENT(JMS)
ll.  
mm.  

If you are setting up for setting up for XSD CIP operation, you must also include the following additional queue declarations:

DEFINE Q(INPUTQ2) +
QUEUE(INPUTQ2) +
TARGCLIENT(JMS)
*
DEFINE Q(REPLYQ2) +
QUEUE(REPLYQ2) +
TARGCLIENT(JMS)
*
DEFINE Q(REMOTEQ2) +
QUEUE(REMOTEQ2) +
TARGCLIENT(JMS)
*
DEFINE Q(ERRORQ2) +
QUEUE(ERRORQ2) +
TARGCLIENT(JMS)
*
DEFINE Q(IN_PROGRESSQ2) +
QUEUE(IN_PROGRESSQ2) +
TARGCLIENT(JMS)
*
DEFINE Q(UNSUBSCRIBEQ2) +
QUEUE(UNSUBSCRIBEQ2) +
TARGCLIENT(JMS)
 
 

Where HOST_NAME is the name of the host machine, CHANNEL_NAME is the name of the communications channel, and INPUTQ, REPLYQ, REMOTEQ , and the other indicated variables are the queue names.

40. Save the file. The location that you save the file to does not matter, as long as it is available when you run the batch file in step 2f.
41. Move to the <MQ_JAVA_INSTALL_PATH>\bin directory.

pp. On LINUX operating systems

Run the JMSAdmin.bat file with the following syntax:

./JMSAdmin.sh < WBIRetail.jndi

where WBIRetail.jndi is the file that you created in step 2d.

On Windows operating systems

Run the JMSAdmin.bat file with the following syntax:

JMSAdmin.bat < WBIRetail.jndi

Where WBIRetail.jndi is the file that you created in step 2d.The JMSAdmin.bat and JMSAdmin.sh files create the JMS bindings files, called .bindings, and puts it in the directory specified by the PROVIDER_URL variable of the JMSAdmin.config file.

qq. On OS/400 operating systems

Run the JMSAdmin script in QSH using the following syntax:

/QIBM/ProdData/mqm/java/bin/JMSAdmin < /path/to/WBIRetail.jndi

Where WBIReatil.jndi is the file you created in step 2d.

3. Open the JMSConnector. Configure this connector to include the connector-specific configuration properties and appropriate business objects. Use the values shown in the following tables. The variable my_queue_manager_name represents the name of the name of the queue manager defined for the InterChange Server Express.

Table 31. Connector-specific properties

Property name	Value
CTX_InitialContextFactory	com.sun.jndi.fscontext.RefFSContextFactory (This is the same name that you uncommented in the JMSAdmin.config file in step 2a.ii.
ReplyToDestination	The name of the queue, in full URL format, to which replies are sent. For example, queue://my_queue_manager_name/REPLYQ
UnsubscribedQueue	The name of the queue, in full URL format, that receives unsubscribed messages. For example, queue://my_queue_manager_name/UNSUBSCRIBEQ
CTX_ProviderURL	The fully-qualified path, in full URL format, to the directory that contains the JMS bindings file. This name must match the value of the PROVIDER_URL in the JMSAdmin.config file. For example, file:/C:/IBM/WebSphereICS/connectors/JMS
InProgressQueue	The name of the queue, in full URL format, that holds messages during processing. For example, queue://my_queue_manager_name/IN_PROGRESSQ
Error Queue	The name of the queue, in full URL format, that receives messages that cannot be processed. For example, queue://my_queue_manager_name/ERROR
DataHandlerConfigMO	MO_DataHandler_UCCnet_envelope
ConfigurationMetaObject	MO_JMSAdapterConfig
DataHandlerMimeType	text/xml
QueueConnectionFactoryName	The name of the queue connection factory. For example, WBIC_JMSQCF.
DefaultVerb	Create
InputQueue	The name of the queue, in full URL format, that the connector polls for new messages. For example, queue://my_queue_manager_name/INPUTQ
PollQuantity	1

Notes:

1. Add the PollQuantity property if it does not appear in the list of connector-specific properties.
2. All the queue names defined by the connector-specific properties must be listed in the WBI_Retail.jndi file

Table 32. Supported business objects

Business object name	Agent support required?
MO_DataHandler_UCCnet_envelope	Yes
MO_JMSAdapterConfig	Yes
UCCnetGBO_envelope	No
UCCnetJMSXSD_envelope	Yes
Retail_Item	No
Retail_Price	No

4. Save the configuration (File > Save > To Project), then go back to the Associated Map tab and set the explicit bindings.

Table 33. Associated maps

Business object name	Map name
UCCnetJMSXSD_envelope	UCCnetJMSXSD_envelope_to_UCCnetGBO_envelope
UCCnetGBO_envelope	UCCnetGBO_envelope_to_UCCnetJMSXSD_envelope
Retail_Item	Retail_Item_to_UCCnetJMSXSD_envelope_registerCommand_itemAddChange
Retail_price	Retail_Price_to_UCCnetJMSXSD_envelope

5. Save the configuration (File > Save > To Project), then close the Connector Configurator.

Refer to the Adapter for JMS User Guide for more information about this connector.

Creating and configuring the second instance of the JMSConnector

If you are setting up for XSD CIP operation, you need two instances of the JMS connector. Perform the following steps to configure the second instance:

1. Open the System Manager.
2. Save the JMS2Connector by doing the following:
1. Open the JMSConnector.
2. Click File > Save As > To Project.
3. Save the connector as JMS2Connector.
3. Create the JMS2Connector Agent, as follows:

On Windows operating systems

1. If the connector needs to use a separate JMS2Connector.cfg please create the cfg by saving the connector using the File>Save>Save To File option in System Manager. The JMS2Connector.cfg needs to be passed as an argument to the connector using the –c option. Alternatively a new JMS2Connector directory can also be created by copying …/connectors/JMS/directory as …/connectors/JMS2/.
2. In the Windows task bar, right-click Start and select Open All Users.
3. Navigate to the folder on your system that contains the installed connectors by clicking Programs > IBM WebSphere Business Integration Express for Item Sync > Adapters > Connectors.
4. Copy the JMSConnector short cut and rename it to JMS2Connector.
5. Right-click the JMS2Connector short cut and select Properties.
6. Click the Short cut tab, edit the Target field, and set the first command line argument to JMS2, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

g. <install_path>\connectors\JMS\start_JMS.bat JMS2 ICS_server_name

On LINUX operating systems

8. If the connector needs to use a separate JMS2Connector.cfg please create the cfg by saving the connector using the File>Save>Save To File option in System Manager. The JMS2Connector.cfg needs to be passed as an argument to the connector using the –c option. Alternatively a new JMS2Connector directory can also be created by copying …/connectors/JText/ directory as …/connectors/JMS2/.
9. Change to the <install_path>/IBM/WebSphereICS/connectors/JMS/ directory or to the appropriate directory.
10. Run JMS2. by entering the following command, where ICS_server_name refers to the name of the InterChange Server Express:

k. start_JText.sh JMS2 ICS_server_name 

On OS/400 operating systems

i. Create the connector directory by copying /QIBM/UserData/Webbiics/connectors/JMS to /QIBM/UserData/Webbiics/connectors/JMS2 on the OS/400 system which will run the adapter

ii. Set the IFS authorities to the contents or /QIBM/UserData/Webbiics/connectors/JMS2 appropriately

iii. Using System Manager, open the JMS2Connector and save it to /QIBM/UserData/Webbiics/connectors/JMS2/JMS2Connector.cfg on the OS/400 by using the File>Save >Save To File option from Connector Configurator

iv. Select Programs > IBM WebSphere Business Integration Express for Item Sync > iSeries remote, right-click Adapters and select Explore

v. Copy the JMSConnector short cut and rename it to JMS2Connector.

vi. Right-click the JMS2Connector short cut and select Properties.

vii. Click the Short cut tab, edit the Target field, and set the first command line argument to JMS2Connector, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

C:\IBM\WebSphereItemSync\scripts\runCommand.bat start_adapter JMS2/start_JMS.sh JMS2 QWEBBIICS QWEBBIJTC

viii. On the OS/400 system, edit the /QIBM/UserData/Webbiics/connectors/JMS2/start_JMS.sh script to contain the –c option to specify the configuration location, and the –b parameter in the last line of the script.

For example:

java -Djava.version=1.3 ${ORB_PROPERTY} -Djava.ext.dirs=${CROSSWORLDS}/lib/ext -Djava.library.path=${CROSSWORLDS}/bin:${CONNDIR}:${MQ_LIB} -Duser.home=${CROSSWORLDS} -cp ${JCLASSES} AppEndWrapper –l${CONNPACKAGENAME} -n${CONNAME}Connector -s${SERVER} –c/QIBM/UserData/Webbiics/connectors/JMS2/JMS2Connector.cfg -b ${PARM3} ${PARM4}

4. Open the JMS2Connector in the Connector Configurator and configure it to include the connector-specific configuration properties and appropriate business objects. Use the values shown in the following tables.

Table 34. Connector-specific properties

Property name	Value
CTX_InitialContextFactory	com.sun.jndi.fscontext.RefFSContextFactory (This is the same name that you uncommented in the JMSAdmin.config file in step 2a.ii).
ReplyToQueue	The name of the queue, in full URL format, to which replies are sent. For example, queue://my_queue_manager_name/REPLYQ2
UnsubscribedQueue	The name of the queue, in full URL format, that receives unsubscribed messages. For example, queue://my_queue_manager_name/UNSUBSCRIBEQ2
CTX_ProviderURL	The fully-qualified path, in full URL format, to the directory that contains the JMS bindings file. This name must match the value of the PROVIDER_URL in the JMSAdmin.config file. For example, file:/C:/IBM/WebSphereICS/connectors/JMS
InProgressQueue	The name of the queue, in full URL format, that holds messages during processing. For example, queue://my_queue_manager_name/IN_PROGRESSQ2
Error Queue	The name of the queue, in full URL format, that receives messages that cannot be processed. For example, queue://my_queue_manager_name/ERROR2
DataHandlerConfigMO	MO_DataHandler_UCCnet_envelope
ConfigurationMetaObject	MO_JMSAdapterConfig
DataHandlerMimeType	text/xml
QueueConnectionFactoryName	The name of the queue connection factory. For example, WBIC_JMSQCF.
InputQueue	The name of the queue, in full URL format, that the connector polls for new messages. For example, queue://my_queue_manager_name/INPUTQ2
PollQuantity	1

Notes:

1. Add the PollQuantity property if it does not appear in the list of connector-specific properties.
2. All the queue names defined by the connector-specific properties must be listed in the WBI_Retail.jndi file

Table 35. Messaging properties

Property name	Value
MessagingType	MQSERIES
HostName	The name of the machine running the InterChange Server Express.
QueueManagerName	The name of the queue manager defined for the InterChange Server Express.
ClientChannel	The name of the MQ channel defined for InterChange Server Express communication.
Port	The port number that the Interchange Server listens on.

Table 36. Supported business objects

Business object name	Agent support required?
MO_DataHandler_UCCnet_envelope	Yes
MO_JMSAdapterConfig	Yes
UCCnetJMSXSD_envelope	Yes
Retail_Item	No

5. Save the configuration (File > Save > To Project), then go back to the Associated Map tab and set the explicit bindings.

Table 37. Associated map

Business object name	Map name
Retail_Item	Retail_Item_to_UCCnetJMSXSD_envelope_publicationCommand_catalogueItem

6. Save the configuration (File > Save > To Project) then close the Connector Configurator.

Refer to the Adapter for JMS User Guide for more information about this connector.

Configuring the PortConnector

Perform the following steps to configure the PortConnector:

1. Configure this connector to include the appropriate business object. Use the value shown in the following table.

Table 38. Supported business object

Business object name	Agent support required?
Retail_Item	Yes
UCCnetGBO_envelope	Yes
Retail_Price	Yes

2. Save the configuration file (File > Save > To Project).

Configuring the EmailConnector

To create the EmailConnector, complete the following steps:

1. In the Windows task bar, right-click Start and select Open All Users.
2. Navigate to the folder on your system that contains the installed connectors by clicking Programs > IBM WebSphere Business Integration Express for Item Sync > Adapters > Connectors.

For OS/400: Programs > IBM WebSphere Business Integration Express for Item Sync > iSeries remote > Adapters > Connectors

3. Right-click the EmailConnector and select Properties > Modify.
4. Click the Short cut tab, edit the Target field, and set the first command line argument to EMail, where ICS_server_name refers to the name of the InterChange Server Express, as shown in the following example:

<install_path>\connectors\email\start_email.bat
 EMail ICS_server_name

For OS/400:

ProductDir\scripts\runCommand.bat start_adapter EMail/start_EMail.sh EMail QWEBBIICS QWEBBIEMC

5. Configure the EmailConnector to include the following configuration property value.

Table 39. Connector-specific property

Property name	Property value
SMTP_MailHost	Hostname or IP address of a mail server.

6. Save the configuration (File > Save > To Project).

Creating and configuring the collaboration objects

Use the information provided in this section to bind the ports and set the attribute values of various collaboration objects.

Creating and configuring a UCCnet_ItemSync collaboration object and making its port connections

1. Create and configure the following collaboration object based on the UCCnet_ItemSync collaboration template.

Table 40. Collaboration object name: UCCnet_ItemSyncObj

Port	Type	Bind to
From	Collaboration	CommandRouterObj.ToRCIR
To	Connector	AS2 channel connector
Error	Connector	Supplier choice of connector
DestinationAppReceive	Connector	PortConnector

2. Set the tracing level for the object.
3. Configure the collaboration object properties using the values from the following table.

Table 41. UCCnet_ItemSyncObj collaboration object configuration properties

Property name	Property description	Required
SEND_EMAIL_TO	Defines the e-mail address to which problems detected during execution of collaboration object processing are sent. This entry is for InterChange Server Express administrators. Do not confuse this property with the Email notification address field, which is configured from the Collaboration General Properties tab when creating a collaboration object.	No. Requires the Email Connector to run if email is entered. The SEND_EMAIL property must be set also.
SEND_EMAIL	Specifies whether e-mail is sent to the address set in the SEND_EMAIL_TO property.	Yes, if you want to send e-mail. To send e-mail, set the value to all. Otherwise, set the value to none.
DB_CONN_POOL_NAME	The name of the connection data pool. The default value is ITEMSYNC_DATA..	Yes
FAILURE_EXCEPTIONS	Specifies exception message numbers that would cause the collaboration object to fail flow	Yes, if a particular exception number should cause a failed flow situation

Creating and configuring the CommandRouter collaboration object and making its port connections

1. Create and configure the following collaboration object based on the CommandRouter collaboration template:

Table 42. Collaboration object name: CommandRouterObj

Port	Type	Bind to
From	Connector	Supplier's choice of adapter
ToCINCIP	Collaboration object	CIN_CIP_DispatcherObj.From
ToRCIR	Collaboration object	UCCnet_ItemSyncObj.From
ToCI	Collaboration object	CI_SyncObj.From
Error	Connector	Supplier's choice of adapter

2. Set the tracing level for the object.
3. Configure the collaboration object properties using the values from the following table.

Table 43. CommandRouterObj collaboration object configuration properties

Property name	Property description	Required
SEND_EMAIL_TO	Defines the e-mail address to which problems detected during execution of collaboration object processing are sent. This entry is for InterChange Server Express administrators. Do not confuse this property with the Email notification address field, which is configured from the Collaboration General Properties tab when creating a collaboration object.	No. Requires the Email Connector to run if email is entered. The SEND_EMAIL property must be set also.
SEND_EMAIL	Specifies whether e-mail is sent to the address set in the SEND_EMAIL_TO property.	Yes, if you want to send e-mail. To send e-mail, set the value to all. Otherwise, set the value to none.
FAILURE_EXCEPTIONS	Specifies exception message numbers that would cause the collaboration object to fail flow	Yes, if a particular exception number should cause a failed flow situation

Creating and configuring a CI_Sync collaboration object and making its port connections

1. Create and configure the following collaboration object based on the CI_Sync collaboration template.

Table 44. Collaboration object name: CI_SyncObj

Port	Type	Bind to
From	Collaboration	CommandRouterObj.ToCI
To	Connector	AS2 channel connector (second instance)
Error	Connector	Supplier's choice of adapter
DestinationAppRetrieve	Connector	PortConnector

2. Set the tracing level for the object.
3. Configure the collaboration object properties using the values from the following table.

Table 45. CI_SyncObj collaboration properties

Property name	Description	Required
SEND_EMAIL_TO	Defines the e-mail address to which problems detected during execution of collaboration object processing are sent. This entry is for InterChange Server Express administrators. Do not confuse this property with the Email notification address field, which is configured from the Collaboration General Properties tab when creating a collaboration object.	No. Requires the Email Connector to run if email is entered. The SEND_EMAIL property must also be set.
SEND_EMAIL	Specifies whether e-mail is sent to the address set in the SEND_EMAIL_TO property.	Yes, if you want to send e-mail. To send e-mail, set the value to all. Otherwise, set the value to none.
DB_CONN_POOL_NAME	The name of the connection data pool (default value = ITEMSYNC_DATA)	Yes
FAILURE_EXCEPTIONS	Specifies exception message numbers that would cause the collaboration object to fail flow	Yes, if a particular exception number should cause a failed flow situation

Creating and configuring the CIN_CIP_Dispatcher collaboration objects and making its port connections

1. Create and configure the following collaboration object based on the CIN_CIP_Dispatcher collaboration template:

Table 46. Collaboration object name: CIN_CIP_DispatcherObj

Used for both CIN and CIP operation
Port	Type	Bind to
From	Collaboration object	CommandRouterObj.ToCINCIP
To	Connector	AS2 channel connector
DestinationAppRetrieve	Connector	PortConnector
Error	Connector	Supplier's choice of adapter

2. Set the tracing level for the object.
3. Configure the collaboration object properties using the following values:

Table 47. CIN_CIP_DispatcherObj collaboration properties

Property name	Description	Required
DB_CONN_POOL_NAME	The name of the connection data pool (default value = ITEMSYNC_DATA)	Yes
GLN_ATTRIBUTE	Identifies where in the UCCnetGBO business object the GLN retrieved from the Dispatcher GLN file should be placed. This property is required. CIN operation Default: ROOT.body[0].transaction.command[0].notifyCommand. notifyCommandOperand .catalogueItemNotification. catalogueItem.dataRecipient  CIP operation Default: ROOT.body[0].transaction.command[0].publicationCommand. publicationCommandOperand .catalogueItemPublication. publishToGLN	Yes
TO_UCCNETGBO_PROCESSING_MAP	Called by the CIN_CIP_Dispatcher object to map incoming Retail_Item objects to the outgoing Catalogue Item Notification or Cataloge Item Publication message. CIN operation Default: Retail_Item_to_UCCnetGBO_envelope _notifyCommand_catalogueItem  CIP operation Default: Retail_Item_to_UCCnetGBO_envelope _publicationCommand_CIP
FAILURE_EXCEPTIONS	Specifies exception message numbers that would cause the collaboration object to fail flow	Yes, if a particular exception number should cause a failed flow situation

Creating and configuring a UCCnet_requestWorklist collaboration object and making its port connections

1. Create and configure the following collaboration object based on the UCCnet_requestWorklist collaboration template.

Table 48. Collaboration object name: UCCnet_requestWorklistObj

Port	Type	Bind to
From	Connector	JTextRWLConnector
To	Connector	AS2 channel connector

2. Set the tracing level for the object.
3. Configure the collaboration object properties using the values from the following table.

Table 49. UCCnet_requestWorklistObj collaboration object configuration properties

Property name	Property description	Required
SET_UNIQUE_IDS	Controls whether unique IDs (messageIdentifier and uniqueCreateorIdentification) are set in the output XML messages. Possible values for this property are: ALL Set all three unique IDs. The default value. NONE No unique IDs BLANK Set unique ID only if it is blank in the input	No, unless the default value needs to be changed.
DTD_URL	Value to be copied into the DTD xml DOCTYPE attribute of the output UCCnetGBO_envelope. The default value is DOCTYPE envelope SYSTEM "http://www.uccnet.net/xmlschema/2.2/Envelope.dtd"	Yes, if configured for UCCnet DTD message format. No, if configured for UCCnet XSD message format.

Creating and configuring a UCCnet_processWorklist collaboration object and making its port connections

1. Create and configure the following collaboration object based on the UCCnet_processWorklist collaboration template:

Table 50. Collaboration object name: UCCnet_processWorklistObj

Port	Type	Bind to
From	Connector	AS2 channel connector
To	Connector	Supplier's connector of choice
Failure	Connector	Supplier's connector of choice
UnsolicitedResponse	Connector	Supplier's connector of choice

2. Set the tracing level for the object.
3. Configure the collaboration object properties using the values from the following table.

Table 51. UCCnet_processWorklistObj collaboration object configuration properties

Property name	Property description	Required
SEND_EMAIL_TO	Defines the e-mail address to which problems detected during execution of the collaboration object are sent. This entry is for InterChange Server Express administrators. Do not confuse this property with the Email notification address field, which is configured from the Collaboration General Properties tab when creating a collaboration object.	No. Requires the Email Connector and a valid entry in this field to send e-mail. If this field is left blank, no e-mail is sent.
DB_CONN_POOL_NAME	The name of the connection data pool (default value = ITEMSYNC_DATA)	Yes
BATCH_RESPONSE	Indicates whether the collaboration should send all CatalogueItemConfirmation notifications in one batch to the To port or individually. Default = true.	Yes
FAILURE_EXCEPTIONS	Specifies exception message numbers that would cause the collaboration object to fail flow	Yes, if a particular exception number should cause a failed flow situation
SEND_EMAIL	Specifies whether e-mail is sent to the address set in the SEND_EMAIL_TO property.	Yes, if you want to send e-mail. To send e-mail, set the value to all. Otherwise, set the value to none.

Creating and configuring a UCCnet_Price collaboration object and making its port connections

Do the following steps:

1. Create and configure the following collaboration object based on the UCCnet_Price collaboration template:

Table 52. Collaboration object name: UCCnet_Price

Port	Type	Bind to
From	Connector	Supplier choice of connector
To	Connector	AS2 channel connector
Error	Connector	Supplier choice of connector
DestinationAppRetrieve	Connector	PortConnector

2. Set the tracing level for the object
3. Configure the collaboration object properties using the values from the following table.

Table 53. UCCnet_Price collaboration object configuration properties

Property name	Property description	Required
SEND_EMAIL_TO	Defines the e-mail address to which problems detected during execution of the collaboration object are sent. This entry is for InterChange Server Express administrators. Do not confuse this property with the Email notification address field, which is configured from the Collaboration General Properties tab when creating a collaboration object.	No. Requires the Email Connector to run if email is entered. The SEND_EMAIL property must be set also.
SEND_EMAIL	Specifies whether e-mail is sent to the address set in the SEND_EMAIL_TO property.	Yes, if you want to send e-mail. To send e-mail, set the value to all. Otherwise, set the value to none.
DB_CONN_POOL_NAME	The name of the connection data pool (default value = ITEMSYNC_DATA)	Yes
PERFORM_VALIDATION	Specifies whether to check Price Documents for a gtin, seller gln, and target market country code to validate if the item has already been registered. For PriceBracket documents, checks for a seller gln value.	Yes, if you want to perform this check
FAILURE_EXCEPTIONS	Specifies exception message numbers that would cause the collaboration object to fail flow	Yes, if a particular exception number should cause a failed flow situation

Creating and configuring Notify_by_eMail collaboration objects and making their port connections

You can receive responses and error messages as e-mail by using the Notify_byEmail template. The following is an example of creating a collaboration object based on the Notify_by_eMail template. In this example, a collaboration object is configured for use with the UCCnet_processWorklist Failure port

1. Create and configure the following collaboration objects based on the Notify_by_eMail collaboration template:

Table 54. Collaboration object name: UPW_FAILURE_RESPONSEObj

Port	Type	Bind to
From	Collaboration object	UCCnet_processWorklistObj:Failure
FromItem	Connector	PortConnector

2. Set the tracing level for the object.
3. Configure each collaboration object's properties using the values from the following table.

Table 55. Notify_by_eMail collaboration object configuration properties

Use the values in this table for the UPW_FAILURE_RESPONSEObj collaboration object.
Property name	Property description	Required
EMAIL_MESSAGE	Body of the e-mail. The processing of this field uses the same variables as the EMAIL_SUBJECT property. It also processes values beginning with the @ sign in the same manner. For example, in the following, the first character of the string is an @ sign, so the collaboration object loads the text from the filename following the @ sign: @c:\IBM\WebSphereICS\UCCnet\collaborations\eMail\ \ UCCnet_processWorklist_AUTHORIZATION_RESPONSES.mail	Yes
EMAIL_NOTIFICATION_RCPTS	E-mail address of the recipients.	Yes
EMAIL_SUBJECT	Subject line of the e-mail. This value can contain variables in the form ${variable_name} into which the collaboration object substitutes data from the business object dynamically. See E-mail examples.	Yes

Note:

Several sample e-mail files are in the following directory:

Windows operating systems

<ICS_installation_path>\Samples\UCCnet\collaborations\eMail

LINUX operating systems

You must FTP (ASCII mode) the e-mail files to a directory on your LINUX system.

OS/400 operating systems

/QIBM/UserData/Webbiics/samples/UCCnet/collaborations/eMail

Each of the collaboration objects based on the Notify_by_eMail collaboration template must have its properties updated to point to the correct location of these sample files or to your own custom e-mail files.

E-mail examples

Type text using the following escape codes:

• ${getRoot} - substitutes the entire triggering business object.
• ${getDate} - substitutes the current date and time.
• ${getName} - substitutes the name of the triggering business object.
• ${getVerb} - substitutes the verb of the triggering business object.
• ${attribute} - substitutes the value of the named attribute from the triggering business object. If the value for the variable_name does not match one of the specific values above, the collaboration object interprets it as the name of a business object attribute.

If the first character of the string for this value is an @ sign, the collaboration object loads the text from a filename following the @ sign.

See the Solution development guide for information about how the solution handles sending e-mail and for a sample value for this property.

Deploying the Fix Pack

Deploy the solution, as follows:

1. After all of the components of the solution have been configured, compile the maps and collaboration templates in the System Manager.
2. Create a User Project that contains all of the solution components.
3. Use the Deploy wizard to deploy the solution to the InterChange Server Express (running in design mode). The wizard lets you choose what parts of the solution to deploy. Deploy the solution in stages, as follows:
1. Deploy the business objects.
2. Deploy the maps. Ensure that you have checked the Compile option.
3. Deploy the connectors.
4. Deploy the collaboration templates. Ensure that you have checked the Compile option.
5. Deploy the database connection pool.
6. Restart the InterChange Server Express.

g. Deploy the collaboration objects.