This section provides a high-level overview of the configuration procedures required after you have successfully installed WebSphere Business Integration Express for Item Synchronization software:
InterChange Server Express can be started in either Design mode or Production mode. Production mode is the default setting. You should change this setting before you start InterChange Server Express the first time:
Before you start InterChange Server Express the first time, you should set it to start in Design mode, so that you can incrementally assemble your integration components. To set the InterChange Server Express to start in Design mode, do this:
Add the -design parameter in the Target field of the Windows shortcut property for InterChange Server Express before starting the server. For example: C:\IBM\WebSphereItemSync1\bin\start_server.bat -design
At the command line, append the -design parameter to ProductDir/bin/ics_manager
Add the -design parameter to the script that you use for starting InterChange Server Express. On OS/400, add the parameter to the CL command that calls the /QIBM/UserData/WebBIICS/bin/start_server.sh script.
To do so, edit the QWEBBISTR member in file QWEBBIICS in library QWEBBIICS. Change this line:
DCL VAR(&DESIGN) TYPE(*CHAR) LEN(10) VALUE(' ')
to:
DCL VAR(&DESIGN) TYPE(*CHAR) LEN(10) VALUE('-design ')
Exit and Save. Then run the following CL Commands:
CRTCLPGM PGM(QWEBBIICS/QWEBBISTR) SRCFILE(QWEBBIICS/QWEBBIICS) SRCMBR(QWEBBISTR) TEXT('WebSphere Business Integration Interchange Server') OPTION(*GEN *NOSRC *NOXREF *NOSECLVL *NOSRCDBG *NOLSTDBG) GENOPT(*NOLIST *NOXREF *NOPATCH) LOG(*JOB) ALWRTVSRC(*YES) REPLACE(*YES) TGTRLS(*CURRENT) AUT(*EXCLUDE) SRTSEQ(*JOBRUN)LANGID(*JOBRUN)
And:
CHGOBJOWN OBJ(QWEBBIICS/QWEBBISTR) OBJTYPE(*PGM) NEWOWN(QWEBBIICS) CUROWNAUT(*REVOKE)
After you have set the InterChange Server Express mode, do this to start InterChange Server Express:
Choose Start>Programs>IBM WebSphere Business Integration Express for Item Sync>InterChange Server Express>InterChange Server Express.
First start the name server:
ProductDir/bin/PersistentNameServer.sh
Then start InterChange Server Express itself, in Design mode:
ProductDir/bin/ics_manager -start -design
From the command line, issue the CL command STRSBS QWEBBIICS/QWEBBIICS. Alternatively, you can start it from an OS/400 shortcut on the Windows client, by choosing Start>Programs>IBM WebSphere Business Integration Express for Item Sync >iSeries Remote>InterChange Server Express>InterChange Server Express.
When you are ready to deploy your implementation, you should return the mode to Production mode. To do so, remove the -design parameter from the shortcut or script or CL program that you use for starting InterChange Server Express.
After you have finished running the Installer, you are ready to perform the final tasks for setting up your business integration system.
The System Manager interface is the starting point for most of the tasks needed to complete the setup of your business integration system.
System Manager runs only on Windows. System Manager must be able to connect to InterChange Server Express in order to deploy a project. For System Manager to be able to connect to the InterChange Server Express running on Linux or OS/400, you must modify the ORB properties in the file
ProductDir\bin\CWSharedEnv.bat
on Windows to specify the name server that InterChange Server Express uses on your platform.
For OS/400, edit the CWSharedEnv file such that ORB_HOST points to the OS/400 host on which InterChange Server Express is running, and ORB_PORT specifies the port on which it is listening. Modify the CWSharedEnv file as follows:
set ORB_PORT=PortNumber set ORB_HOST=HostName or IP address
If a port number is not specified for the ORB_PORT, the port number defaults to 14500.
For Linux, modify the CWSharedEnv file as follows:
set ORB_PORT=PortNumber set ORB_HOST=HostName or IP address
Where HostName and PortNumber together specify which host the name server is running on and which port it is listening on.
To begin using System Manager, do this:
If your InterChange Server Express platform is OS/400, choose Start > Programs > IBM WebSphere Business Integration for Item Sync v4.3.1 >iSeries remote> InterChange Server Express>IBM WebSphere InterChange Server to start InterChange Server Express.
The System Manager environment displays.
In the InterChange Server Express panel at the lower left portion of the display, right-click on the displayed InterChange Server Express to verify that it is connected. If it is not connected, you may need to register the server (by choosing Server > Register Servers from the menu) and then connect to it. By default, the server you are using is named WebSphereICS (QWEBBIICS on OS/400), and the username/password combination for registering and connecting to it is:
admin/null
For more information regarding System Manager, see the following: User Guide for WebSphere Business Integration Express and Express Plus for Item Synchronization, and context-sensitive help for System Manager (activated when you press F1 within System Manager).
Most of the components necessary for implementing the ItemSync solution have already been created for you and are imported into System Manager when you run the Installer. You must configure some components, and you must create some from templates that are provided.
After you have System Manager, you can view the integration components that the Installer has already made available to you. To do so, in the upper left panel of System Manager, expand the icon for the ItemSyncLibrary integration component library, which resides under the Integration Component Libraries folder.
Three general types of content are provided for you in ItemSyncLibrary: business objects, collaboration templates, and maps. To complete the setup of your business integration system, you will modify or create some additional components, save them in ItemSyncLibrary, and then create a System Manager user project that contains the components. Then you will deploy that user project to InterChange Server Express.
In addition to the components already visible in ItemSyncLibrary, several connector configuration templates are provided to you. There is one template for each of the adapters that you selected when you ran the Installer. Before you begin the configuration steps that follow in this section, you should be certain that you have run the Installer to copy to your system all the adapters that you will be using. For a description of the roles that different adapters perform in an implementation, see Table 8.
To view the connector configuration templates that have been copied to your system, do the following:
To use the connectors, you will need to configure and create connector configuration objects. These tasks, and the configuration of some other necessary components, are described in the steps that follow in this guide.
If you are doing a non-default implementation, and have available to you additional components in the form of .jar files, you will need to import the components into System Manager in order to use them. Instructions for importing files into System Manager are provided in the User Guide.
The WebSphere Business Integration Express for Item Sync system uses a database table called audit_log to track events associated with UCCnet activities. For more information on the use of this table, see the documentation forthe Collaboration for UCCnet Item Synchronization.
To create the audit_log table, complete the following steps:
For OS/400: Run the CL command CALL QWEBBIICS/QWEBBIIAL
For Windows and Linux: Use the script appropriate for your database server:
ProductDir\collaborations\dependencies\UCCnet\db2
db2
db2 connect to SMB_DB
db2 connect to SMB_DB user smbadmin using smbP4$$word
db2 -f audit_log.sql
Account: smbadmin
Password: smbP4$$word
ProductDir\collaborations\dependencies\UCCnet\mss
InterchangeSystem_orig.cfg
ProductDir\samples\UCCnet\InterchangeSystem.UCCnet
UCCnet subproperty | Value |
---|---|
USER_NAME |
For a DB2 database on Windows or Linux: smbadmin For OS/400, leave this value blank.
|
PASSWORD |
For a DB2 database on Windows or Linux: smbP4$$word For OS/400, leave this value blank.
|
DRIVER |
For a DB2 database on Windows: database:COM.ibm.db2.jdbc.app.DB2Driver For a DB2 database on OS/400: com.ibm.db2.jdbc.app.DB2Driver For a MicrosoftSQL Server database: com.ibm.jdbc.sqlserver.SQLServerDriver |
DATA_SOURCE_NAME |
For a DB2 database on Windows: jdbc:db2:SMB_DB For OS/400 DB2UDB, use the following URL: jdbc:db2:MyHost/QWEBBIICSD where MyHost is the name of the OS/400 host on which InterChange Server Express is running For a Microsoft SQL Server database: jdbc_ibm.crossworlds:sqlserver://machine_name:1433; DatabaseName=SMB_DB (where machine_name is the name of the host machine on which your ICS repository resides) |
TARGETHLQ |
On OS/400 systems, set this value to a directory in the root file system on
the OS/400. Recommended: /QIBM/UserData/WebBIICS/
|
Processing of UCCnet XML messages requires meta-objects for the Data Handler for XML (the XML data handler). This data handler uses a meta-object, which is a kind of business object, to hold its configuration information. In addition, each of the connectors that interacts with UCCnet requires a meta-object.
Default configuration files for these meta-objects are provided for you in System Manager. The default meta-objects are pre-set with default settings for use with a typical implementation. However, you must complete the configuration of the meta-objects by reviewing or setting certain values that are specific to your implementation, as described in the following steps.
The following steps describe how to complete configuration of the meta-objects. For each of these, you will launch Business Object Designer and open the business object definition for the meta object that you are viewing or configuring. (If the New Business Object Definition dialog appears when you launch Business Designer, click Cancel.):
Table 3. Default values for properties in MO_DataHandler_UCCnetXMLConfig
Attribute name | Default value |
---|---|
BOPrefix | For DTD support:
UCCnetDTDFor schema-document support: UCCnetXSD |
DTDPath | Full path to the XML-structure document: For DTD XML definition
type:
Envelope.dtdFor schema-document support XML definition type: Envelope.xsdThe Envelope structure document is available from the UCCnet web site. To download these files, you must have a valid UCCnet user ID and password. |
After you have set the values, close the MO_DataHandler_UCCnetXMLConfig meta-object with File > Close. However do not exit Business Object Designer.
Table 4. Default property values for MO_JTextRWLConnector_Default
Attribute name | Default value |
---|---|
OutputDir | Name of the directory where the JTextRWLConnector is to write the XML
files it generates. For example:
C:\IBM\WebSphereItemSync\UCCnet\JTextRWL\outFor OS/400, use the path to the directories on the OS/400 host on which InterChange Server Express is running. For example, /QIBM/UserData/Webbiics/UCCNet/JTextRWL/out If the output directory you specify does not already exist, create it. |
ArchiveDir | Name of the directory where the JTextRWLConnector archives events (XML
files). For example:
C:\IBM\WebSphereItemSync\UCCnet\JTextRWL\archiveFor OS/400, use the path to the directories on the OS/400 host on which InterChange Server Express is running. For example, /QIBM/UserData/Webbiics/UCCNet/JTextRWL/archiveIf the archive directory you specify does not already exist, create it. |
EventDir | Name of the directory from which the JTextRWLConnector obtains input
events (XML files). For example:
C:\IBM\WebSphereItemSync\UCCnet\JTextRWL\eventFor OS/400, use the path to the directories on the OS/400 host on which InterChange Server Express is running. For example, /QIBM/UserData/Webbiics/UCCNet/JTextRWL/eventIf the event directory you specify does not already exist, create it. |
Table 5. Default property values for MO_JTextISoftConnector
Attribute name | Default value |
---|---|
OutputDir | Name of the directory where the JTextISoftConnector is to write the XML
files it generates. For example:
C:\IBM\WebSphereItemSync\UCCnet\JTextISoft\outFor OS/400: /QIBM/UserData/Webbiics/UCCnet/JTextISoft/outIf the output directory you specify does not already exist, create it. |
OutputExt | xml |
ArchiveDir | Name of the directory where the JTextISoftConnector archives events (XML
files). For example:
C:\IBM\WebSphereItemSync\UCCnet\JTextISoft\archiveFor OS/400: /QIBM/UserData/Webbiics/UCCnet/JTextISoft/archiveIf the archive directory you specify does not already exist, create it. |
EventDir | Name of the directory from which the JTextISoftConnector obtains input
events (XML files). For example:
C:\IBM\WebSphereItemSync\UCCnet\JTextISoft\eventFor OS/400: /QIBM/UserData/Webbiics/UCCnet/JTextISoft/eventIf the event directory you specify does not already exist, create it. |
EventExt | xml |
EndBODelimiter | EOF |
In addition to the creation and configuration of business objects for the XML data-handler meta-objects, you also need to configure business objects for the following components:
If you are exchanging messages with UCCnet through an AS2/EDIINT interface protocol (using the Windows platform), you must use a meta-object called MO_ISoftAdapterConfig for the iSoft connector.
A default sample of this meta-object is copied to your system during
installation. Open the meta-object in Business Object Designer to
verify that it has the correct attributes for your implementation.
Review the attributes described in Table 6:
Table 6. Attributes in MO_ISoftAdapter_Config
Attribute name | Type | Key | Application-specific information |
---|---|---|---|
Default | String | Yes | The output queue, where messages derived from the business object
definitions listed in this meta-object are delivered. For
example:
OutputQueue=queue://crossworlds. queue.manager/ outbox_queue_name; DataEncoding=Text (where outbox_queue_name identifies where these messages are delivered)
The output queue specified in this Default attribute applies to all business-object conversions. |
UCCnet_envelope_
Create | String | No | If the application-specific information that you provided for the Default attribute (above) is insufficient to identify the business-object configuration properties for the UCCnet_envelope business object, you can provide any additional information that might be required here. For more information about the format of this application-specific information, see the Adapter Guide for iSoft. |
The EmailConnector handles messages for events that occur during the execution of the Item Sync collaboration. It uses a business object definition called EmailNotification to hold its configuration information.
To configure the EmailConnector, complete the following steps:
Table 7. Default property values for EmailNotification
Attribute name | Default value | Required |
---|---|---|
RecipientName | Email address of recipient | Yes. For information on how to specify the message recipients, see the Adapter Guide for e-Mail. |
FromAddress | Email address of undelivered messages | No |
Your item information originates from your Enterprise Resource Planning (ERP) application. As the first step to sending this item information to UCCnet, an ERP-source connector receives information from your ERP application and takes the following steps:
The ERP-source business object is an application-specific business object that contains the item information your ERP application needs sent to UCCnet. For the ERP-source connector to create such a business object, it must be able to locate an associated business object definition, which the connector uses as a template for the business object creation. Therefore, as part of the Item Sync configuration process, you must create business object definitions to represent the item information that your ERP application must send to UCCnet.
To create a business object definition, use the Business Object Designer tool. This tool provides a graphical interface that assists you in naming the business object definition and defining its attributes. When you design your ERP-source business object definition, you must determine which item information needs to be sent to UCCnet. To assist in this determination, you can examine the information in the generic item-information business object, ItemBasic.
The basic steps to creating the business object definition for your application-specific business object are as follows:
For a more complete description of Business Object Designer and how to create a business object definition, see Developing business objects.
Once the ERP-source connector has created the application-specific business object, the item information is ready to be sent to InterChange Server Express. There, any application-specific formats of data in this business object are converted to the data format used by the associated generic business object, ItemBasic. It is the generic business object that InterChange Server Express routes to various components of the Item Sync system. To provide this data conversion, you must create a map that describes the data transformations necessary to convert the data from any application-specific formats to their generic equivalents.
To create a map, use the Map Designer tool. This tool provides a graphical interface that assists you in naming the map and defining its transformation. When you design your ERP-source map, you must determine which item information is currently in an application-specific format; that is, which data is in a format different from its equivalent in the generic business object. To assist in this determination, you can examine the information in the generic item-information business object, ItemBasic.
The basic steps to creating the map from your application-specific business object to the ItemBasic generic business object are as follows:
CwSource_to_CwDestinationwhere Source and Destination are the names of your source and destination business object definitions, respectively. For example, if your application-specific business object was named JDBC_ERPItem, the associated ERP-source map name could be:
CwJDBC_ERPItem_to_CwItemBasic
For a more complete description of Map Designer and how to create a map, see the Map Development Guide.
This section provides a roadmap of the basic steps for creating a business object definition. For complete details about developing a business object definition, see the Business Object Development Guide.
In the WebSphere business integration system, information sent or received between components is packaged in the form of a business object. For data that is transferred between a connector and an integration broker, you design application-specific business objects that model the appropriate application entities. Application-specific business objects are modeled during design-time as business object definitions, which are stored in the business integration system, specifically in the System Manager Integration Component Library (ICL). At runtime, data is populated in a business object instance (often just called a "business object") that is based on the proper definition, and is moved through the business integration system as dictated by its routing and business logic rules.
For details about the business object requirements of your specific adapter, refer to your adapter's user guide.
There are two ways to create a business object definition:
An Object Discovery Agent (ODA) is an optional component of an adapter. When you install a pre-defined adapter that has an ODA, its ODA is installed automatically. Business Object Designer Express provides a graphical interface in the form of a wizard, called Business Object Wizard, to interact with the ODA. The purpose of Business Object Wizard is to display a series of dialogs to the user. These dialogs obtain information from the user that the ODA needs to generate the business object content. The ODA is the component that "discovers" objects in the data source and generates the content. The ODA receives information that the user provides in the dialogs of Business Object Wizard. It then sends information (such as the generated content) to the ODA runtime, the intermediary component between Business Object Wizard and the ODA.
Before you run an ODA, verify that the following steps have occurred (for details, see Business Object Development Guide):
Business Object Designer Express invokes Business Object Wizard, which displays the first dialog in the wizard, Select Agent.
After the ODA completes the generation of business object definitions, Business Object Wizard displays the final dialog in the wizard, Save Business Objects.
For more detailed information, see the following:WebSphere Business Integration Express for Item Synchronization Business Object Development Guide.
Some application-specific business objects are provided to you. In some implementations, you may need to modify them.
You can open a business object definition provided by the adapter and modify it as needed using Business Object Designer Express. You can also modify any business object definition you have created. New objects are created in Business Object Designer Express, with or without the assistance of the ODA. To modify an existing object, use Business Object Designer Express directly (the ODA cannot be used to modify an existing business object).
To modify a business object definition:
Business Object Designer Express displays a window for each selected definition.
Connector Configurator Express allows you to configure the connector component of your adapter for use with InterChange Server Express.
You use Connector Configurator Express to:
Use Connector Configurator Express to create this configuration file and to modify its settings.
The following table describes the required connector configuration files
for a typical implementation of WebSphere Business Integration Express for
Item Synchronization:
Table 8. Connectors in the Item Sync solution
Connector object that you configure | Required Installer component selections | Role of the configured connector |
---|---|---|
JTextRWLConnector, based on the JText connector template | Adapter for JText (installed by default when you choose the Typical package) | Inputs a worklist request to UCCnet. This connector is required for all implementations. |
iSoftConnector, based on the iSoft connector template | Adapter for iSoft | Exchanges messages with UCCnet . Use this connector only if you are on the Windows platform and you intend to use an AS2/EDIINT interface protocol to exchange messages with UCCnet. This connector can be used on Windows platforms only. For OS/400 and Linux platforms, use the JTextISoftConnector. |
JTextISoftConnector, based on the JText connector template | Adapter for JText | Exchanges messages with UCCnet. Use this connector if you intend to use UCCNet Command Line Utility (CLU) to communicate with the iSoft Peer-to-Peer Agent. This connector can be used on Windows, Linux, and OS/400 platforms. |
JText, JMS, JDBC, XML, Web Services, WebSphere MQ, or mySAP | One of the following adapters:
| Exchanges messages with your ERP application. You must configure at least one of these connectors. |
EmailConnector | Adapter for e-Mail | Yes, if your UCCnet Item Synchronization collaboration uses the "notify by email" feature |
PortConnector | None | Yes |
Use Connector Configurator Express, launched from System Manager, to create these files. For information on how to launch, run, and use this tool, see the Connector Configurator Express appendix in your adapter user guide.
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 filesystem folder. To poll for the worklist, a scheduler operation (which the operating system performs) must be configured to periodically drop a fresh copy of the request XML file into the event file-system folder for the JTextRWLConnector.
On OS/400: Programs > IBM WebSphere Business Integration Express for Item Sync v4.3.1 > iSeries remote > Adapters > Connectors.
ProductDir\connectors\JText\start_JText.bat JText WebSphereICS
For example, if WebSphere Business Express for Item Sync is installed in your C: partition, then the initial text for the new startup shortcut would be:
C:\IBM\WebSphereItemSync\connectors\JText\start_JText.bat JText WebSphereICS
For OS/400:
C:\IBM\WebSphereItemSync\scripts\runCommand.bat start_adapter JText/start_JText.sh JText QWEBBIICS QWEBBIJTC
In this case, you would change the shortcut so it reads:
C:\IBM\WebSphereItemSync\connectors\JText\ start_JText.bat JTextRWL WebSphereICS
For OS/400:
C:\IBM\WebSphereItemSync\scripts\runCommand.bat start_adapter JText/start_JText.sh JTextRWL QWEBBIICS QWEBBIJTC
Table 9. Supported business objects for JTextRWLConnector
Business object definition | Agent support required? |
---|---|
MO_JTextRWLConnector_Default | Yes |
MO_DataHandler_UCCnet_envelope | Yes |
The UCCnet envelope:
| Yes |
UCCnetGBO_envelope | No |
Table 10. Associated maps for JTextRWLConnector
Business object definition | Name of map |
---|---|
UCCnetDTD_envelope | UCCnetDTD_envelope_to_UCCnetGBO_envelope |
UCCnetXSD_envelope | UCCnetXSD_envelope_to_UCCnetGBO_envelope |
UCCnetGBO_envelope |
For DTD XML definition type: RouterMap_UCCnetGBO_envelope_to_UCCnetDTD_ envelope
For schema-document XML definition type: UCCnetGBO_envelope_to_UCCnetXSD_envelope |
The iSoftConnector can be used only on the Windows platform. On OS/400 and Linux platforms, the JTextISoft connector is used instead. The instructions that follow for configuring the iSoft Connector assume that you included the iSoft connector among your selections when you ran the Installer.
The iSoft Connector connector exchanges messages with UCCnet through an AS2/EDIINT interface protocol. You need to create or modify a connector configuration file for the iSoftConnector, using Connector Configurator Express, and configure it to include the appropriate business objects.
To create the iSoftConnector, complete the following steps:
Table 11. Connector-specific properties for iSoftConnector
Connector-specific property | Value |
---|---|
ArchiveQueue |
Queue to which copies of successfully processed messages are sent. For example: queue://crossworlds.queue.manager/ MQCONN.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
|
ErrorQueue |
Queue to which messages that could not be processed are sent. For example: queue://crossworlds.queue.manager/ MQCONN.ERROR |
HostName | The name of the host on which the iSoft Peer-to-Peer Agent WebSphere MQ queue manager is running |
InputQueue |
List of queues that the connector polls for new messages. Queue names are delimited with a semicolon (;). For example: queue://crossworlds.queue.manager/ MQCONN.IN1; queue://crossworlds.queue.manager/MQCONN.IN2 |
InProgressQueue |
Queue where messages are held during processing. For example: queue://crossworlds.queue.manager/ MQCONN.IN_PROGRESS |
Port | The port established for the WebSphere MQ Listener of the iSoft Peer-to-Peer Agent's queue manager |
ReplyToQueue |
Queue to which replies are sent. For example: queue://crossworlds.queue.manager/ MQCONN.REPLY |
UnsubscribedQueue |
Queue to which messages that are not subscribed are sent. For example: queue://crossworlds.queue.manager/ MQCONN.UNSUBSCRIBED |
UseDefaults |
True
|
Table 12. Supported business objects for iSoftConnector
Business object definition | Agent support required? |
---|---|
The UCCnet envelope:
| Yes |
Table 13. Associated maps for iSoftConnector
Business object definition | Name of map |
---|---|
UCCnetGBO_envelope |
For DTD XML definition type: RouterMap_UCCnetGBO_envelope_to_ UCCnetDTD_envelope For schema-document XML definition type: UCCnetGBO_envelope_to _UCCnetXSD_envelope |
ItemBasic |
For DTD XML definition type: RouterMap_CwItemBasic_to_ UCCnetDTD_envelope For schema-document XML definition type: CwItemBasic_to_UCCnetXSD_envelope_ registerCommand_itemAddChange |
For further information, see the Adapter for iSoft Peer-to-Peer Agent User Guide.
The JTextISoft connector is used for exchanging messages with UCCnet. The JTextISoft connector is required for the OS/400 and Linux platforms. For Windows platforms, either the JTextISoft connector or the ISoft connector can be used. The JTextISoft connector uses the UCCnet Command Line Utility (CLU) to communicate with UCCnet.
To configure and use the JTextISoftConnector, complete the following steps:
ProductDir\connectors\JText\start_JText.bat JText WebSphereICS
For OS/400:
ProductDir\scripts\runCommand.bat start_adapter JText/start_JText.sh JText QWEBBIICS QWEBBIJTC
where ProductDir is the name of the directory in which WebSphere Business Integration Express for Item Sync is installed. For example, if WebSphere Business Express for Item Sync is installed in your C: partition, then the initial text for the new startup shortcut would be:
C:\IBM\WebSphereItemSync\connectors\JText\ start_JText.bat JText WebSphereICS
For OS/400:
C:\IBM\WebSphereItemSync\scripts\runCommand.bat start_adapter JText/start_JText.sh JText QWEBBIICS QWEBBIJTC
In this case, you would change the shortcut so it reads:
C:\IBM\WebSphereItemSync\connectors\JText\ start_JText.bat JTextISoft WebSphereICS
For OS/400:
C:\IBM\WebSphereItemSync\scripts\runCommand.bat start_adapter JText/start_JText.sh JTextISoft QWEBBIICS QWEBBIJTC
Table 14. Specifying definition type in business objects for JTextISoftConnector
Business object definition | Agent support required? |
---|---|
The UCCnet envelope:
| Yes |
Table 15. Specifying definition type in associated maps for JTextISoftConnector
Business object definition | Name of map |
---|---|
UCCnetGBO_envelope |
For DTD XML definition type: RouterMap_UCCnetGBO_envelope_to_ UCCnetDTD_envelope
For schema-document XML definition type: UCCnetGBO_envelope_to_UCCnetXSD_envelope |
ItemBasic |
For DTD XML definition type: RouterMap_CwItemBasic_to_ UCCnetDTD_envelope
For schema-document XML definition type: CwItemBasic_to_UCCnetXSD_envelope_ registerCommand_itemAddChange |
The ERP-source connector is the input connector for the UCCnet_ItemSync collaboration object. This connector receives information from your Enterprise Resource Planning (ERP) application and formats this information in the appropriate application-specific business object. It converts this application-specific business object to an ItemBasic business object, passing the ItemBasic business object to the UCCnet_ItemSync collaboration. The UCCnet_ItemSync collaboration delivers the ItemBasic business object to UCCnet through either the iSoftConnector or JTextISoftConnector.
You choose the ERP-source connector based on the format that
application-specific information can be obtained from your ERP
application. WebSphere Business Integration Express for Item Sync
provides the following adapters for use as possible ERP-source
connectors:
Adapter | Purpose |
---|---|
Adapter for JDBC | Handles application-specific information using the Java Database Connectivity (JDBC) and converts between this format and an application-specific business object |
Adapter for JMS | Handles application-specific information using the Java Message Service (JMS) and converts between this format and an application-specific business object |
Adapter for JText | Handles application-specific information in file-system files and converts between this format and an application-specific business object |
Adapter for WebSphere MQ | Handles application-specific information using WebSphere MQ queues and converts between this format and an application-specific business object |
Adapter for XML | Handles application-specific information in XML and converts between this format and an application-specific business object |
Adapter for Web Services | Handles application-specific information in SOAP and converts between this format and an application-specific business object |
Once you have selected the appropriate ERP-source connector, you must create and configure it with the following steps:
Table 16. Supported business objects for ERP-source connector
Business object definition | Agent support required? |
---|---|
ERP-source application-specific business object definition (This is the business object definition that you created for the ERP-source connector. For more information, see Creating ERP-source business objects.) | Yes |
ItemBasic | No |
Table 17. Associated maps for ERP-source connector
Business object definition | Name of map |
---|---|
ERP-source application-specific business object (This is the map that you created for the ERP-source connector. For more information,Creating ERP-source maps.) |
UCCnet_CwERPsource_to_CwItemBasic
UCCnet_CwItemBasic_to_CwERPsource |
The PortConnector is a "dummy" connector to bind to collaboration ports that do not send a business object to a connector during the Item Sync business process. To create the PortConnector, you create a connector configuration file using Connector Configurator Express. For general information on how to use this tool to create a connector configuration file, see the Connector Configurator Express appendix in your adapter guide.
Table 18. Supported business objects for PortConnector
Business object definition | Agent support required? |
---|---|
ItemBasic | Yes |
UCCnetGBO_envelope | Yes |
You create the connector configuration file for the EmailConnector using Connector Configurator Express. For general information on how to use this tool to create a connector configuration file, see the Connector Configurator Express appendix in your adapter user guide.
The WebSphere Business Integration Express for Item Sync system requires
runtime objects, called collaboration objects, which are created from
collaboration templates. The following table lists the collaboration
objects you must create, based on their associated collaboration
template.
Table 19. Collaboration objects for Item Sync
Collaboration template | Collaboration object |
---|---|
UCCnet_ItemSync | UCCnet_ItemSyncObject |
For schema-document XML definition type:
|
UCCnetXSD_CIN_DISPATCHER_forICR_Obj
|
UCCnet_requestWorklist | UCCnet_requestWorklistObject |
UCCnet_processWorklist | UCCnet_processWorklistObject |
Notify_by_eMail |
UCCnet_processWorklist_
UCCnet_processWorklist_
UCCnet_processWorklist_
UCCnet_processWorklist_
UCCnet_processWorklist_
UCCnet_processWorklist_
UCCnet_processWorklist_FAILURE_RESPONSEObject UCCnet_processWorklist_
UCCnet_processWorklist_RCIR_QUERY_RESPONSEObject
UCCnet_processWorklist__CI_RESPONSEObject
UCCnet_processWorklist_CIP_RESPONSEObject
ItemCommandRouter_DE_LIST_WITHDRAWObject
UCCnet_processWorklist_CIN_RESPONSEObject
|
You create collaboration objects in the System Manager tool. Before beginning the steps in the subsequent sections, start up System Manager and connect to the WebSphereICS instance of InterChange Server Express. For information on how to start up System Manager, see Starting System Manager.
The collaboration object for the UCCnet_ItemSync collaboration template is called UCCnet_ItemSyncObject. You create a collaboration object from System Manager.
To configure this collaboration object, complete the following steps:
Table 20. Port Bindings for UCCnet_ItemSync
Collaboration port | Type | Bind to |
---|---|---|
DestinationAppRetrieve | Connector | PortConnector |
From | Connector | Your ERP-source connector (for example, JDBCsourceERPConnector) |
To (For DTD XML definition type) | Connector | The connector that sends the ItemBasic business object to UCCnet (though
the iSoft Peer-to-Peer Agent):
|
To (For schema-document XML definition type) | Collaboration |
ItemCommandRouter_Obj.
|
Table 21. Collaboration-specific properties for UCCnet_ItemSync
Property name | Property description | Required? |
---|---|---|
GtinDB_User |
For Windows and Linux: smbadmin For OS/400, leave this value blank.
| Yes |
GtinDB_PASSWORD |
For Windows and Linux: smbP4$$word For OS/400, leave this value blank.
| Yes |
JDBC_DRIVER | The name of the JDBC driver used to connect to the ICS repository database. For more information, see the description of the DRIVER property in Creating the logging table. | Yes, if InterChange Server Express does not register the driver in the Java Virtual Machine (JVM). The Microsoft SQL driver, for example, is already registered in the JVM. |
JDBC_URL | The JDBC URL that corresponds to the driver that JDBC_DRIVER specifies. For more information, see the description of the DATA_SOURCE_NAME property in Creating the logging table. | Yes |
SEND_EMAIL | Determines whether the Item Sync collaboration sends email when it generates certain messages To send email, set this property to the value "all". Otherwise, set it to "none". | Yes, if you want the Item Sync collaboration to send email |
SEND_EMAIL_TO | Specifies the email address where the Item Sync sends email messages, assuming that the SEND_EMAIL property is set. | No. Requires:
|
AUDITLOG_INSTANCE_
NAME | UCCnet | Yes |
SUPPLIER_NAME | Specifies the name of the partner that is synchronizing item information with UCCnet. This value is logged in audit entries. | No |
If your Item Sync solution uses the UCCnet Envelope that is based on the schema-document XML definition type (Envelope.xsd), you must create special collaboration objects to handle routing of information:
The collaboration object for the ItemCommandRouter collaboration template is called ItemCommandRouter_Obj.
You create a collaboration object from System Manager.
To configure this collaboration object, complete the following steps:
Table 22. Port bindings for ItemCommandRouter
Collaboration port | Type | Bind to |
---|---|---|
From | Collaboration | UCCnet_ItemSyncObject.To |
TO_RCIR | Connector | iSoftConnector |
ToCIN_CI | Collaboration | For CIN operation:
UCCnetXSD_CIN_CIP_DISPATCHER_forICR_Obj.From For CIP operation: ItemCommandRouter_DE_LIST_WITHDRAWObject:FromItemBasic (Note: For CIP operation, the ToCin_CI port is configured to send an email indicating that delist and withdrawal actions are not supported.) |
When you are using the schema-document XML definition type, you need to create two collaboration objects from the CIN_CIP_DISPATCHER collaboration template.
Complete the following steps:
Table 23. Port bindings for UCCnetXSD_CIN_DISPATCHER_forICR_Obj
Collaboration port | Type | Bind to |
---|---|---|
DestinationAppReceive | Connector | PortConnector |
From | Collaboration | ItemCommandRouter_Obj.TO_CIN |
To | Connector | iSoftConnector |
Table 24. Collaboration-specific properties for UCCnetXSD_CIN_DISPATCHER_forICR_Obj
Property name | Property description | Required? |
---|---|---|
CIN_DISPATCHER_GLN_FILE | The fully qualified name of the file that holds the GLNs subscribed to each category code. | Yes |
TO_UCCNETGBO_PROCESSING_MAP | By the UCCnet_CIN_DISPATCHER object to map incoming ItemBasic objects to the outgoing CATALOGUE_ITEM_NOTIFICATIONMessage. | Yes |
SUPPLIER_NAME | The name of the partner responsible for synchronizing item information with UCCnet. This value is included in audit log entries. | No |
Table 25. Port bindings for UCCnetXSD_CIN_DISPATCHER_forPWL_Obj
Collaboration port | Type | Bind to |
---|---|---|
DestinationAppReceive | Connector | PortConnector |
From | Collaboration | For CIN operation:
UCCnet_processWorklist: RCIR_RESPONSE
|
To | Connector | iSoftConnector |
DestinationAppRetrieve | Connector | PortConnector |
The collaboration object for the UCCnet_processWorklist collaboration template is called UCCnet_processWorklistObject.
To configure this collaboration object, complete the following steps:
Table 26. Initial port bindings for UCCnet_processWorklist
Collaboration port | Type | Bind to |
---|---|---|
From | Connector | iSoftConnector or JTextISoftConnector |
ITEM_ADD_CHANGE | Connector | iSoftConnector or JTextISoftConnector |
NEW_ITEM_PUBLICATION_REQUEST | Connector | iSoftConnector or JTextISoftConnector |
INITIAL_ITEM_LOAD_REQUEST | Connector | iSoftConnector or JTextISoftConnector |
PUBLICATION_CMD_RESPONSE | DTD support
Connector XSD support, CIN operation Connector XSD support, CIP operation Collaboration object | DTD support
PortConnector XSD support, CIN operation PortConnector XSD support, CIP operation CIN_CIP_Dispatcher_forPWL_Obj:From |
DestinationAppReceive | Connector | PortConnector |
CIN_RESPONSE | DTD support
Connector XSD support, CIN operation Collaboration object XSD support, CIP operation Connector | DTD support
PortConnector XSD support, CIN operation UCCnet_processWorklist_ CIN_RESPONSEObject:From XSD support, CIP operation PortConnector |
CIP_RESPONSE | DTD support
Connector XSD support, CIN operation Connector XSD support, CIP operation Collaboration object | DTD support
PortConnector XSD support, CIN operation PortConnector XSD support, CIP operation UCCnet_processWorklist_ CIP_RESPONSEObject:From |
CI_RESPONSE | DTD support
Connector XSD support, CIN operation Connector XSD support, CIP operation Collaboration object | DTD support
PortConnector XSD support, CIN operation PortConnector XSD support, CIP operation UCCnet_processWorklist_ CI_RESPONSEObject:From |
RCIR_RESPONSE | DTD support
Connector XSD support, CIN operation Collaboration object XSD support, CIP operation Connector | DTD support
PortConnector XSD support, CIN operation UCCnetXSD_CIN_DISPATCHER_ forPWL_Obj:From XSD support, CIP operation Second instrance of iSoftConnector or JTextISoftConnector |
RCIR_QUERY_RESPONSE | DTD support
Connector XSD support Collaboration object | DTD support
PortConnector XSD support UCCnet_processWorklist_ RCIR_QUERY_RESPONSEObject |
All of these ports must be bound to a collaboration object based on the Notify_by_eMail collaboration template. You can bind these ports later, once these Notify_by_eMail collaboration objects exist. Continue with the steps outlined in this section. When you reach Creating the collaboration objects for Notify_by_eMail, instructions are provided for finishing the port binding for the UCCnet_processWorklistObject collaboration object.
Table 27. Collaboration-specific properties for UCCnet_processWorklistObject
Property name | Property description | Required? |
---|---|---|
DB_USER |
For Windows and Linux: smbadmin For OS/400, leave this value blank.
| Yes |
DB_PASSWORD |
For Windows and Linux: smbP4$$word For OS/400, leave this value blank.
| Yes |
JDBC_DRIVER | The name of the JDBC driver used to connect to the ICS repository database. For more information, see the description of the DRIVER property in Creating the logging table. | Yes, if InterChange Server Express does not register the driver in the Java Virtual Machine (JVM). The Microsoft SQL driver, for example, is already registered in the JVM. |
JDBC_URL | The JDBC URL that corresponds to the driver that JDBC_DRIVER specifies. For more information, see the description of the DATA_SOURCE_NAME property in Creating the logging table. | Yes |
SEND_EMAIL_TO | Specifies the email address where the Item Sync sends email messages, assuming that the SEND_EMAIL property is set. | No.Requires: the EmailConnector The SEND_EMAIL property set to "all" |
SEND_EMAIL | Determines whether the Item Sync collaboration sends email when it generates certain messages To send email, set this property to the value "all". Otherwise, set it to "none". | Yes, if you want the Item Sync collaboration to send email |
AUDITLOG_INSTANCE_
NAME | UCCnet | Yes |
SUPPLIER_NAME | The name of the partner responsible for synchronizing item information with UCCnet. This value is included in audit log entries. | No |
DTD_URL |
Specifies the value for the DOCTYPE line in outgoing XML. The default value is: DOCTYPE envelope SYSTEM http://www.uccnet.net/xmlschema/2.2/ envelope_file For the DTD XML definition type, replace envelope_file with: Envelope.dtd For the schema-document XML definition type, replace envelope_file with: Envelope.xsd | No, unless the default value is incorrect for the environment |
AUTO_RESPOND | Controls whether an automatic response is set to UCCnet | Yes |
The Item Sync collaboration requires several collaboration objects for the Notify_by_eMail collaboration template.
To configure these collaboration objects, complete the following steps:
Table 28. Port bindings for Notify_by_eMail
Collaboration object | Bind to collaboration object port |
---|---|
UCCnet_processWorklist_
CATEGORY_ADD_CHANGEObject | UCCnet_processWorklistObject:
CATEGORY_ADD_CHANGE |
UCCnet_processWorklist_
DEAD_LETTER_PUB_RECEIPT | UCCnet_processWorklistObject.
DEAD_LETTER_PUB_RECEIPT |
UCCnet_processWorklist_
AUTHORIZATION_ RESPONSES | UCCnet_processWorklistObject.
AUTHORIZATION_RESPONSES |
UCCnet_processWorklist_
UNKNOWN_RESPONSE | UCCnet_processWorklistObject.
UNKNOWN_RESPONSE |
UCCnet_processWorklist_
UNKNOWN_MESSAGES | UCCnet_processWorklistObject.
UNKNOWN_MESSAGES |
UCCnet_processWorklist_
SIMPLE_RESPONSE | UCCnet_processWorklistObject.
SIMPLE_RESPONSE |
UCCnet_processWorklist_
CATALOGUE_ITEM_ CONFIRMATION Used for schema-document support only (CIN and CIP operation) | UCCnet_processWorklistObject.
CATALOGUE_ITEM_CONFIRMATION |
UCCnet_processWorklist_
RCIR_QUERY_RESPONSEObject Used for schema-document support only (CIN and CIP operation) | UCCnet_processWorklistObject:
RCIR_QUERY_RESPONSE |
UCCnet_processWorklistObject:CI_
RESPONSE Used for schema-document support only (CIP operation) | UCCnet_processWorklistObject:
CI_RESPONSE |
UCCnet_processWorklist
_CIP_RESPONSEObject Used for schema-document support only (CIP operation) | UCCnet_processWorklist_CIP_RESPONSEObject |
ItemCommandRouter_
DE_LIST_WITHDRAWObject Used for schema-document support only (CIP operation) | Port Connector |
UCCnet_processWorklist_
CIN_RESPONSEObject Used for schema-document support only (CIN operation) | UCCnet_processWorklist_CIN_RESPONSEObject |
UCCnet_processWorklist_
FAILURE_RESPONSEObject | UCCnet_processWorklistObject:
FAILURE |
Table 29. Collaboration-specific properties for Notify_by_eMail
Property name | Property description | Required |
---|---|---|
EMAIL_NOTIFICATION_RCPTS | Lists the email address of the message recipient | Yes |
EMAIL_SUBJECT | Specifies the format of the subject line of the email message. For more information on the syntax that this property supports, see the description of this property in the reference page for the UCCnet Item Synchronization Collaboration. | Yes |
EMAIL_MESSAGE | Specifies the format body of the email message. For more information on the syntax that this property supports, see the description of this property in the reference page for the UCCnet Item Synchronization Collaboration. | Yes |
DOCTYPE | Specifies the value for the DOCTYPE line in outgoing XML. The
default value is:
DOCTYPE envelope SYSTEM http://www.uccnet.net/xmlschema/2.2/ envelope_fileFor the DTD XML definition type, replace envelope_file with: Envelope.dtd For the schema-document XML definition type, replace envelope_file with: Envelope.xsd | Yes |
Table 30. Additional port bindings for UCCnet_processWorklist
Collaboration object port | Bind to collaboration object port |
---|---|
CATEGORY_ADD_CHANGE | UCCnet_processWorklist_
CATEGORY_ADD_CHANGEObject.From |
DEAD_LETTER_PUB_RECEIPT | UCCnet_processWorklist_
DEAD_LETTER_PUB_RECEIPTObject.From |
AUTHORIZATION_RESPONSES | UCCnet_processWorklist_
AUTHORIZATION_RESPONSESObject.From |
UNKNOWN_RESPONSE | UCCnet_processWorklist_
UNKNOWN_RESPONSEObject.From |
UNKNOWN_MESSAGES | UCCnet_processWorklist_
UNKNOWN_MESSAGESObject.From |
SIMPLE_RESPONSE | UCCnet_processWorklist_
SIMPLE_RESPONSEObject.From |
CATALOGUE_ITEM_
CONFIRMATION | UCCnet_processWorklist_
CATALOGUE_ITEM_ CONFIRMATIONObject.From |
FAILURE | UCCnet_processWorklist_FAILURE_RESPONSEObject:From |
The collaboration object for the UCCnet_requestWorklist collaboration template is called UCCnet_requestWorklistObject. You create a collaboration object from System Manager.
To configure this collaboration object, complete the following steps:
Table 31. Port bindings for UCCnet_requestWorklist
Collaboration port | Type | Bind to |
---|---|---|
From | Connector | JTextRWLConnector |
To | Connector | iSoftConnector or JTextISoftConnector |
Table 32. Collaboration-specific properties for UCCnet_requestWorklist
Property name | Property description | Required |
---|---|---|
DTD_URL | Specifies the value for the DOCTYPE line in outgoing XML. The
default value is:
DOCTYPE envelope SYSTEM http://www.uccnet.net/xmlschema/2.2/ envelope_file For the DTD XML definition type, replace envelope_file with: Envelope.dtd For the schema-document XML definition type, replace envelope_file with: Envelope.xsd | No, unless the default value is incorrect for the environment |
SET_UNIQUE_IDS | Controls whether unique IDs (messageIdentifier and
uniqueCreateorIdentification) are set in the output XML messages.
Possible values are:
| No |
Once you have created all the components in the ItemSyncLibrary ICL project, you are ready to create a user project and deploy this project to the WebSphereICS instance of InterChange Server Express.
To deploy the solution, complete these steps:
On OS/400: Start > Programs > IBM WebSphere Business Integration Item Sync Express v4.3 > iSeries remote > InterChange Server Express > InterChange Server.
After the relationships have been deployed, you must then populate them with default values and make any necessary modifications to the default schemas. To populate the relationships, complete the steps appropriate for your database server.
On OS/400:
For DTD XML definition type: CALL QWEBBIICS/QWEBBIIREL
For the schema-document XML definition type:CALL QWEBBIICS/QWEBBIIRELX
On Windows and Linux: DB2 Database Server
Start > Programs > IBMDB2 > Command Line Tools > Command Window.
Enter the following command in a terminal window:
db2
Windows and Linux: Microsoft SQL Server
Account: smbadmin
Password: smbP4$$word
This script is located in the following directory: ProductDir\collaborations\dependencies\UCCnet\mss
After running the InitialiseRelationshipTables or InitialiseRelationshipTablesForXSD script, you must manually populate the trading_partner table with the correct GLN SOURCE and TARGET information.
The following example adds a SOURCE row to the trading_partner table. Since the SOURCE entry indicates your own GLN, the table should have only one SOURCE record.
insert into trading_partner (gln_code, trading_partner_name, trading_partner_contact, trading_partner_group, trading_partner_type, initial_load_flag) values ('0000000000001','ACME Inc.','Mr. Acme', 'Group 1','SOURCE','Y')
The next example adds a TARGET entry to the table. Since the TARGET entries record your trading partners' GLNs, the table can have multiple TARGET records.
insert into trading_partner (gln_code, trading_partner_name, trading_partner_contact,trading_partner_group, trading_partner_type, initial_load_flag) values ('0000000000002','Green Co.','Ms. Green','Group 1','TARGET','N')
After you have deployed the project, you must shutdown ICS Express, then restart ICS Express, and then start your adapter.
Choose Start > Programs > IBM WebSphere Business Integration for Item Sync Express v4.3 > InterChange Server Express.
Enter the following command in a terminal window
:ProductDir/bin/ics_manager -start.
Choose Start > Programs > IBM WebSphere Business Integration for Item Sync Express v4.3 >Adapters > Connectors > name of your adapter.
Enter following command in a terminal window:
ProductDir/connectors/Connector/start_Connector.sh Connector ICS
For more information, see the following: User Guide for WebSphere Business Integration Express for Item Synchronization.