This document describes how to install and configure components of the Item Synchronization for Suppliers solution. In order to implement the solution, you will need to refer to and be familiar with the following core documents:
Deployment of the Item Synchronization for Suppliers solution involves a series of product 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.
Before following the installation procedure, obtain the IBM WebSphere Business Integration Collaboration for UCCnet(R) Item Synchronization by downloading it from Passport Advantage (www.lotus.com/passportadvantage). Refer to Passport Advantage for downloading instructions.
The following tables list the components used to develop the Item
Synchronization for Suppliers solution. Note that there are many other
existing components that can be utilized in your customized solution.
Table 1. Collaboration templates
Name | Location |
---|---|
UCCnet_ItemSync | BIA_Retail_CT_ItemSync.jar repository file |
UCCnet_requestWorklist | BIA_Retail_CT_ItemSync.jar repository file |
UCCnet_processWorklist | BIA_Retail_CT_ItemSync.jar repository file |
Notify_by_eMail | BIA_Retail_CT_ItemSync.jar repository file |
ItemCommandRouter | BIA_Retail_CT_ItemSync.jar repository file |
CIN_CIP_Dispatcher | BIA_Retail_CT_ItemSync.jar repository file |
Name | Location |
---|---|
UCCnetGBO_envelope | BIA_Retail_BO_ItemSync.jar repository file |
UCCnetDTD_envelope | BIA_Retail_BO_ItemSync.jar repository file |
UCCnetXSD_envelope | BIA_Retail_BO_ItemSync.jar repository file |
UCCnetTPIDTD_envelope | BIA_Retail_BO_ItemSync.jar repository file |
UCCnetTPIXSD_envelope | BIA_Retail_BO_ItemSync.jar repository file |
SAP4_MatlBasic | BIA_Retail_BO_ItemSyncSamples.jar repository file |
Name | Location |
---|---|
CwItemBasic_to_UCCnetTPIDTD_envelope_documentCommand_item | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetGBO_envelope_notifyCommand_catalogueItem | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetXSD_envelope_publicationCommand_catalogueItem | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetTPIXSD_envelope_publicationCommand_catalogueItem | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetXSD_envelope_publicationCommand_catalogueItem | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetTPIXSD_envelope_publicationCommand_catalogueItem | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetGBO_env_publicationCommand_catalogueItemPublication | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetDTD_envelope_documentCommand_item | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetDTD_envelope_publishCommand_documentIdentifier | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetTPIDTD_envelope_publishCommand_documentIdentifier | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetXSD_envelope_registerCommand_itemAddChange | BIA_Retail_NM_ItemSync.jar repository file |
CwItemBasic_to_UCCnetTPIXSD_envelope_registerCommand_itemAddChange | BIA_Retail_NM_ItemSync.jar repository file |
RouterMap_CwItemBasic_to_UCCnetDTD_envelope | BIA_Retail_NM_ItemSync.jar repository file |
RouterMap_CwItemBasic_to_UCCnetTPIDTD_envelope | BIA_Retail_NM_ItemSync.jar repository file |
RouterMap_UCCnetGBO_envelope_to_UCCnetDTD_envelope | BIA_Retail_NM_ItemSync.jar repository file |
RouterMap_UCCnetGBO_envelope_to_UCCnetTPIDTD_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetGBO_envelope_to_UCCnetDTD_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetGBO_envelope_to_UCCnetTPIDTD_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetGBO_envelope_to_UCCnetXSD_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetGBO_envelope_to_UCCnetTPIXSD_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetDTD_envelope_to_UCCnetGBO_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetTPIDTD_envelope_to_UCCnetGBO_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetXSD_envelope_to_UCCnetGBO_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetTPIXSD_envelope_to_UCCnetGBO_envelope | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetGBO_envelope_notification_to_UCCnetDTD_envelope_publishCommand | BIA_Retail_NM_ItemSync.jar repository file |
UCCnetGBO_envelope_notification_to_UCCnetTPIDTD_envelope_publishCommand | BIA_Retail_NM_ItemSync.jar repository file |
CwSa4ItemBasic | BIA_Retail_NM_ItemSyncSamples.jar repository file |
Sa4CwItemBasic | BIA_Retail_NM_ItemSyncSamples.jar repository file |
Name | Location |
---|---|
GTIN | BIA_Retail_REL_ItemSync.jar repository file |
LiUT | BIA_Retail_REL_ItemSync.jar repository file |
PrTyNT | BIA_Retail_REL_ItemSync.jar repository file |
SiUT | BIA_Retail_REL_ItemSync.jar repository file |
TPTable | BIA_Retail_REL_ItemSync.jar repository file |
UDEX | BIA_Retail_REL_ItemSync.jar repository file |
UpcTyT | BIA_Retail_REL_ItemSync.jar repository file |
VoUT | BIA_Retail_REL_ItemSync.jar repository file |
WeUT | BIA_Retail_REL_ItemSync.jar repository file |
Name |
---|
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 |
BIA_Retail_REL_ItemSync.jar |
Table 6. Database scripts for DB2(R), Microsoft(R) SQL Server, and Oracle
Name |
---|
audit_log.sql (one copy supplied for each database type) |
InitializeRelationshipTables.sql (one copy supplied for each database type) |
InitializeRelationshipTablesForXSD.sql (one copy supplied for each database type) |
Table 7. Library file for collaboration templates
Name |
---|
CSIAuditLogger.jar |
Table 8. InterchangeSystem.UCCnet file
Name |
---|
InterchangeSystem.UCCnet |
Name |
---|
UCCnet_processWorklist_AUTHORIZATION_RESPONSES.mail |
UCCnet_processWorklist_CATEGORY_ADD_CHANGE.mail |
UCCnet_processWorklist_CATEGORY_ADD_CHANGESubject.mail |
UCCnet_processWorklist_CATALOGUE_ITEM_CONFIRMATION.mail |
UCCnet_processWorklist_DEAD_LETTER_PUB_RECEIPT.mail |
UCCnet_processWorklist_SIMPLE_RESPONSE.mail |
UCCnet_processWorklist_UNKNOWN_MESSAGES.mail |
UCCnet_processWorklist_UNKNOWN_RESPONSE.mail |
UCCnet_processWorklist_CIN_RESPONSE.mail |
UCCnet_processWorklist_CI_RESPONSE.mail |
UCCnet_processWorklist_CIP_RESPONSE.mail |
UCCnet_processWorklist_RCIR_QUERY_RESPONSE.mail |
UCCnet_processWorklist_FAILURE_RESPONSE.mail |
ItemCommandRouter_DE_LIST_WITHDRAW.mail |
The following operating environments are supported in this release:
The Item Synchronization for Suppliers solution has the same processor, memory, disk space, and high-availability requirements as an IBM WebSphere InterChange Server installation, as detailed in the System Installation Guide for Windows and System Installation Guide for UNIX. To download, expand, and install this solution, you require 52.9 MB of free space. After the installation, you can remove the downloaded installation files and leave only the solution on your machine. The installed solution takes up 6.6 MB of space.
Ensure that you have installed the following prerequisites appropriately for your platform:
The IBM WebSphere Interchange Server installer includes Retail collaborations, but the version included may not be the latest available. The latest version of the Item Synchronization for Suppliers collaboration can be downloaded from Passport Advantage (www.lotus.com/passportadvantage). See Obtaining solution components for more information. If you use the version provided by the IBM WebSphere Interchange Server installer, make sure that the version of documentation you use is correct for the version of the Item Synchronization for Suppliers collaboration.
Additionally, you must not install the IBM WebSphere Business Integration Collaboration for Product Information Management or the IBM WebSphere Business Integration Collaboration for UCCnet Message Manager.
Installation instructions for IBM WebSphere InterChange Server, IBM WebSphere Business Integration Toolset, and IBM WebSphere MQ, are provided in the System Installation Guide for Windows or System Installation Guide for UNIX. Installation instructions for IBM WebSphere Business Integration Data Handler for XML, the database, and individual IBM WebSphere Business Integration Adapters, are detailed in their respective installation documents.
This installation guide provides step-by-step instructions for installing and configuring the Item Synchronization for Suppliers solution. It is recommended that you proceed through the sections in order:
Before you install and configure the Item Synchronization for Suppliers solution, you must determine how you will connect to UCCnet and what message format and protocols you will use.
The way you connect to UCCnet will determine the connector that you use to communicate with it. If you exchange messages with UCCnet using an AS2/EDIINT interface protocol, you can use either a TPIConnector or an ISoftConnector. Use the TPI connector if you communicate with UCCnet through Trading Partner Interchange servers. Use the IsoftConnector if you are communicating with UCCnet through an iSoft Peer-to-Peer Agent. If you exchange messages through the UCCnet Command Line Utitily (CLU) or are testing your installation, you can use either a JTextTPIConnector, or a JTextISoftConnector.
Since the actual connector you use is dependent on your set up, the term "AS2 channel connector" is used throughout this documentation as a general term for any of the TPIConnector, iSoftConnector, JTextTPIConnector, and JTextISoftConnector.
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 following options are available:
To configure the system environment, complete the following steps. Be sure to follow the instructions appropriate for your platform where indicated.
DATAHANDLER=%CROSSWORLDS%\DataHandlers\CwXMLDataHandler.jar
DATAHANDLER=%CROSSWORLDS%\DataHandlers\CwXMLDataHandler.jar
DATAHANDLER=${CWCLASSES}:${CROSSWORLDS}/DataHandlers/CwXMLDataHandler.jar
DATAHANDLER=${CWCLASSES}:${CROSSWORLDS}/DataHandlers/CwXMLDataHandler.jar
CWCLASSES=...;%CROSSWORLDS%\lib\CSIAuditLogger.jar
CWCLASSES=${CWCLASSES}:${CROSSWORLDS}/lib/CSIAuditLogger.jar
classpath=<directory_location_of_CSIAuditLogger.jar_file>CSIAuditLogger.jar
repos_copy -sICS_server_name -uICS_admin_ID -pICS_admin_password \ -ai -i<ICS_installation_path>\repository\Email.jar -xcompilepackage
repos_copy -sICS_server_name -uICS_admin_ID -pICS_admin_password \ -ai -i<ICS_installation_path>/repository/Email.jar -xcompilepackage
This command activates the E-mail collaboration template and does not require a restart of the ICS.
Complete the following steps to ensure that the solution code is accessible to your system. Be sure to follow the instructions appropriate for your platform where indicated.
To create the audit_log table, complete the following steps. Be sure to follow the instructions appropriate for your platform where indicated.
<ICS_installation_path>\collaborations\dependencies\db2
<ICS_installation_path>\collaborations\dependencies\ \ UCCnet\oracle
sqlplus dbuser/passwd@SID @audit_log.sql
You might have to enable autoextension of the CWRepository datafile. Select the AUTOEXTEND option on the Storage tab for the datafile in the DBA Studio.
<ICS_installation_path>\collaborations\dependencies\ \ UCCnet\mss
<ICS_installation_path>/collaborations/dependencies/ \ UCCnet/db2
<ICS_installation_path>/collaborations/dependencies/ \ UCCnet/oracle
sqlplus dbuser/passwd@SID @audit_log.sql
You might have to enable autoextension of the CWRepository datafile. Select the AUTOEXTEND option on the Storage tab for the datafile in the DBA Studio.
You must configure (and in some cases create) the following business objects to properly process UCCnet XML messages. To perform these tasks, complete the following steps:
Table 10. Selected attribute values for MO_DataHandler_UCCnetXMLConfig metaobject
Attribute name | Column | Setting |
---|---|---|
BOPrefix | Default |
|
DTDPath | Default |
|
Validation | Default | false |
DefaultEscapeBehavior | Default | true |
IgnoreUndefinedElements | Default | true |
Table 11. Selected attribute value for MO_DataHandler_UCCnet_envelope metaobject
Attribute name | Column | Setting |
---|---|---|
text_xml | Type | MO_DataHandler_UCCnetXMLConfig |
Table 12. Selected attribute values for MO_JTextRWLConnector_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\JTextRWL\out). Create this directory if it does not already exist. |
OutputExt | Default | xml |
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. |
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 |
EndBODelimiter | Default | EOF |
Table 13. Selected attribute values for MO_JTextISoftConnector_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\JTextISoft\out). Create this directory if it does not already exist. |
OutputExt | Default | xml |
ArchiveDir | Default | <Name of the directory where archive XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextISoft\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\JTextISoft\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
functionality, you must create a second instance of both the JTextISoft
connector and the JTextISoft connector metaobjects. Edit the
MO_JTextISoftConnector_Default by setting the following attributes, then save
it as MO_JTextISoft2Connector_Default.
Table 14. Selected attribute values for MO_JTextISoft2Connector_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\JTextISoft2\out). Create this directory if it does not already exist. |
OutputExt | Default | xml |
ArchiveDir | Default | <Name of the directory where archive XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextISoft2\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\JTextISoft2\event). Create this directory if it does not already exist. |
EventExt | Default | xml |
EndBODelimiter | Default | EOF |
Table 15. Selected attribute values for MO_JTextTPIConnector_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\JTextTPI\out). Create this directory if it does not already exist. |
OutputExt | Default | xml |
ArchiveDir | Default | <Name of the directory where archive XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextTPI\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\JTextTPI\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
functionality, you must create a second instance of both the JTextTPI
connector and the JTextTPI connector metaobjects. Edit the
MO_JTextTPIConnector_Default by setting the following attributes, then save it
as MO_JTextTPI2Connector_Default.
Table 16. Selected attribute values for MO_JTextTPI2Connector_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\JTextTPI2\out). Create this directory if it does not already exist. |
OutputExt | Default | xml |
ArchiveDir | Default | <Name of the directory where archive XML files will be written> (for example, C:\IBM\WebSphereICS\UCCnet\JTextTPI2\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\JTextTPI2\event). Create this directory if it does not already exist. |
EventExt | Default | xml |
EndBODelimiter | Default | EOF |
Table 17. 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 |
UCCnetDTD_envelope_Create (for DTD support) or 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. |
Table 18. Selected attribute values for EmailNotification business object
Name | Column | Setting |
---|---|---|
RecipientName | Default | Email address of recipient. |
FromAddress | Default | Email address of sender. |
The connectors that must be created and/or configured depend on the individual installation, as follows:
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.
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.
To create the JTextRWLConnector, complete the following steps:
Perform the following steps to configure the JTextRWLConnector:
Property name | Value |
---|---|
ApplicationName | JTextRWLConnector |
Table 20. Supported business objects
Business object name | Agent support required? |
---|---|
MO_JTextRWLConnector_Default | Yes |
MO_DataHandler_UCCnet_envelope | Yes |
One of the following:
| Yes |
UCCnetGBO_envelope | No |
Business object name | Map name |
---|---|
UCCnetDTD_envelope (when iSoft connectivity and DTD XML definition type are used) | UCCnetDTD_envelope_to_UCCnetGBO_envelope |
UCCnetTPIDTD_envelope (when TPI connectivity and DTD XML definition type are used) | UCCnetTPIDTD_envelope_to_UCCnetGBO_envelope |
UCCnetXSD_envelope (when iSoft connectivity and XSD XML definition type are used) | UCCnetXSD_envelope_to_UCCnetGBO_envelope |
UCCnetTPIXSD_envelope (when TPI connectivity and XSD XML definition type are used) | UCCnetTPIXSD_envelope_to_UCCnetGBO_envelope |
UCCnetGBO_envelope |
|
<install_path>\IBM\WebSphereICS\connectors\JText\start_JText.bat \ JTextRWL ICS_server_name
start_JText.sh JTextRWL ICS_server_name
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/JTEXTRWLCONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/JTEXTRWLCONNECTOR) USAGE (NORMAL) END
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.
Perform the following steps to configure the first instance of the iSoftConnector:
Table 22. Connector-specific properties
Property name | Value |
---|---|
ArchiveQueue | Queue to which copies of successfully processed messages are sent (for instance, 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 instance, 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 | Semi-colon-delimited list of message queues that are polled by the connector for new messages (for instance, 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 instance, 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 instance, 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 23. Supported business objects
Business object name | Agent support required? |
---|---|
MO_DataHandler_UCCnet_envelope | Yes |
MO_ISoftAdapterConfig | Yes |
UCCnetDTD_envelope (used only for DTD support) | Yes |
UCCnetXSD_envelope (used only for XSD support) |
|
UCCnetGBO_envelope | No |
ItemBasic | No |
Business object name | Map name |
---|---|
UCCnetDTD_envelope (used only for DTD support) | UCCnetDTD_envelope_to_UCCnetGBO_envelope |
UCCnetXSD_envelope (used only for XSD support) | UCCnetXSD_envelope_to_UCCnetGBO_envelope |
UCCnetGBO_envelope |
|
ItemBasic |
|
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/ISOFTCONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/ISOFTCONNECTOR) USAGE (NORMAL) END
If you are setting up for XSD CIP operation, you need two instances of the iSoft connector. Perform the following steps to configure the second instance:
<install_path>\connectors\JText\start_ISoft.bat ISoft2 ICS_server_name
start_JText.sh ISoft2 ICS_server_name
Table 25. Connector-specific properties
Property name | Value |
---|---|
ArchiveQueue | Queue to which copies of successfully processed messages are sent (for instance, 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 instance, 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 instance,
queue://my_p2p_agent_queue_manager_name/inbox3;
queue://my_p2p_agent_queue_manager_name/inbox4)
|
InProgressQueue | Message queue where messages are held during processing (for instance, 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 instance, 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 26. Supported business objects
Business object name | Agent support required? |
---|---|
MO_DataHandler_UCCnet_envelope | Yes |
MO_ISoftAdapterConfig | Yes |
UCCnetXSD_envelope | Yes |
ItemBasic | No |
Business object name | Map name |
---|---|
ItemBasic | CwItemBasic_to_UCCnetXSD_envelope_publicationCommand_catalogueItem |
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/ISOFT2CONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/ISOFT2CONNECTOR) USAGE (NORMAL) END
Refer to the Adapter for iSoft Peer-to-Peer Agent User Guide for more information about this connector.
Configure this connector only if you are using the TPI server and are communicating with UCCnet through an AS2/EDIINT interface protocol. If you are setting up for XSD CIP operation, you will need two instances of the TPI connector. Otherwise, you only require one. Perform the following steps to configure the TPIConnector:
Trading Partner ID (tab) XML MIME type
A sample file might look like the following example:
#Comment lines start with # TP1 text/xml TP2 text/xml
Table 28. Connector-specific properties
Property name | Value |
---|---|
ArchiveProcessedDocDir | Directory where processed document meta-events are archived (for instance, C:\TPISolo\data\uccnet2\archive). |
DataHandlerConfigMO | MO_DataHandler_UCCnet_envelope |
DefaultXMLMimeType | text/xml |
DocumentOutDir | Directory location where outbound documents are written temporarily before TPI processes them (for instance, C:\TPISolo\data\uccnet2\xmlout). |
MetaEventDir | Directory used to persist the TPI event information for recovery purposes (for instance, C:\TPISolo\data\uccnet2\xmlin). |
PollQuantity | 1 (add this property it does not appear in the list of connector-specific properties). |
TradingPartnerConfigurationFile | Fully qualified name of the trading partner configuration file created in Step 1 above (for instance, C:\IBM\WebSphereICS\connectors\TPI\tpcfg.txt). |
WaitForMDN | false (MDNs are not supported by this solution). |
Table 29. Supported business objects
Business object name | Agent support required? |
---|---|
MO_DataHandler_UCCnet_envelope | Yes |
| Yes |
UCCnetGBO_envelope | No |
ItemBasic | No |
Business object name | Map name |
---|---|
UCCnetTPIDTD_envelope (used only for DTD support) | UCCnetTPIDTD_envelope_to_UCCnetGBO_envelope |
UCCnetTPIXSD_envelope (used only for XSD support) | UCCnetTPIXSD_envelope_to_UCCnetGBO_envelope |
UCCnetGBO_envelope |
|
ItemBasic |
|
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/TPICONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/TPICONNECTOR) USAGE (NORMAL) END
To implement multiple trading partners, you need either multiple versions of these maps or you need to set these values in the collaboration object.
This connector is only required if you are setting up for XSD CIP operation.
<install_path>\connectors\JText\start_TPI.bat TPI2 ICS_server_name
start_TPI.sh TPI2 ICS_server_name
Configure the TPI2Connector as follows:
Table 31. Connector-specific properties
Property name | Value |
---|---|
ArchiveProcessedDocDir | Directory where processed document meta-events are archived (for instance, C:\TPISolo\data\uccnet2\archive2). |
DataHandlerConfigMO | MO_DataHandler_UCCnet_envelope |
DefaultXMLMimeType | text/xml |
DocumentOutDir | Directory location where outbound documents are written temporarily
before TPI processes them (for instance,
C:\TPISolo\data\uccnet2\xmlout).
|
MetaEventDir | Directory used to persist the TPI event information for recovery purposes (for instance, C:\TPISolo\data\uccnet2\xmlin2). |
PollQuantity | 1 (add this property it does not appear in the list of connector-specific properties). |
TradingPartnerConfigurationFile | Fully qualified name of the trading partner configuration file created in Step 1 above (for instance, C:\IBM\WebSphereICS\connectors\TPI\tpcfg.txt). |
WaitForMDN | false (MDNs are not supported by this solution). |
Table 32. Supported business objects
Business object name | Agent support required? |
---|---|
MO_DataHandler_UCCnet_envelope | Yes |
UCCnetTPIXSD_envelope | Yes |
ItemBasic | No |
Business object name | Map name |
---|---|
UCCnetTPIXSD_envelope | UCCnetTPIXSD_envelope_to_UCCnetGBO_envelope |
ItemBasic | CwItemBasic_to_UCCnetTPIXSD_envelope_registerCommand_itemAddChange |
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/TPI2CONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/TPI2CONNECTOR) USAGE (NORMAL) END
Refer to the Adapter for Trading Partner Interchange User Guide for more information about this connector.
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 or testing your installation. This is a copy of the JTextConnector used to simulate the iSoftConnector. Like the iSoftConnector, the JTextISoftConnector 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 JTextISoft connector. Otherwise, you only need to create and configure the first instance.
<install_path>\connectors\JText\start_JText.bat JTextISoft ICS_server_name
start_JText.sh JTextISoft ICS_server_name
Perform the following steps to configure the JTextISoftConnector:
Property name | Value |
---|---|
ApplicationName | JTextISoftConnector |
Table 35. Supported business objects
Business object name | Agent support required? |
---|---|
MO_JTextISoftConnector_Default | Yes |
MO_DataHandler_UCCnet_envelope | Yes |
| Yes |
UCCnetGBO_envelope | No |
ItemBasic | No |
Business object name | Map name |
---|---|
UCCnetDTD_envelope | UCCnetDTD_envelope_to_UCCnetGBO_envelope |
UCCnetXSD_envelope | UCCnetXSD_envelope_to_UCCnetGBO_envelope |
UCCnetGBO_envelope |
|
ItemBasic |
|
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/JTEXTISOFTCONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/JTEXTISOFTCONNECTOR) USAGE (NORMAL) END
The second instance of the JTextISoftConnector is only used for XSD CIP operation. If it is required, create it as follows:
<install_path>\connectors\JText\start_JText.bat JTextISoft2 ICS_server_name
start_JText.sh JTextISoft2 ICS_server_name
Perform the following steps to configure the JTextISoft2Connector:
Property name | Value |
---|---|
ApplicationName | JTextISoft2Connector |
Table 38. Supported business objects
Business object name | Agent support required? |
---|---|
MO_JTextISoftConnector_Default | Yes |
MO_DataHandler_UCCnet_envelope | Yes |
UCCnetXSD_envelope | Yes |
ItemBasic | No |
Business object name | Map name |
---|---|
UCCnetXSD_envelope | UCCnetXSD_envelope_to_UCCnetGBO_envelope |
ItemBasic | CwItemBasic_to_UCCnetXSD_envelope_publicationCommand_catalogueItem |
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/JTEXTISOFT2CONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/JTEXTISOFT2CONNECTOR) USAGE (NORMAL) END
Create and configure this connector only if you are using the TPI server and are communicating with UCCnet through the UCCnet CLU or testing your installation. This is a copy of the JTextConnector used to simulate the TPIConnector. Like the TPIConnector, the JTextTPIConnector uses the IBM WebSphere Business Integration Data Handler for XML and generates the same XML output. If you are setting up your system to use the XSD CIP operation, you must create and configure two instances of the JTextTPI connector.
To create the JTextTPIConnector, complete the following steps:
To configure the JTextTPIConnector, complete the following steps::
Property name | Value |
---|---|
ApplicationName | JTextTPIConnector |
Table 41. Supported business objects
Business object name | Agent support required? |
---|---|
MO_JTextTPIConnector_Default | Yes |
MO_DataHandler_UCCnet_envelope | Yes |
| Yes |
UCCnetGBO_envelope | No |
ItemBasic | No |
Business object name | Map name |
---|---|
UCCnetTPIDTD_envelope | UCCnetTPIDTD_envelope_to_UCCnetGBO_envelope |
UCCnetTPIXSD_envelope | UCCnetTPIXSD_envelope_to_UCCnetGBO_envelope |
UCCnetGBO_envelope |
|
ItemBasic |
|
<install_path>\connectors\JText\start_JText.bat JTextTPI ics_server_name
start_JText.sh JTextTPI ICS_server_name
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/JTEXTTPICONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/JTEXTTPICONNECTOR) USAGE (NORMAL) END
To create the JTextTPI2Connector, complete the following steps:
Perform the following steps to configure the JTextTPI2Connector:
Property name | Value |
---|---|
ApplicationName | JTextTPI2Connector |
Table 44. Supported business objects
Business object name | Agent support required? |
---|---|
MO_JTextTPI2Connector_Default | Yes |
MO_DataHandler_UCCnet_envelope | Yes |
UCCnetTPIXSD_envelope | Yes |
ItemBasic | No |
Business object name | Map name |
---|---|
UCCnetTPIXSD_envelope | UCCnetTPIXSD_envelope_to_UCCnetGBO_envelope |
ItemBasic | CwItemBasic_to_UCCnetTPIXSD_envelope_publicationCommand_catalogueItem |
<install_path>\connectors\JText\start_JText.bat JTextTPI2 ics_server_name
start_JText.sh JTextTPI2 ICS_server_name
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/JTEXTTPI2CONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/JTEXTTPI2CONNECTOR) USAGE (NORMAL) END
Perform the following steps to configure the PortConnector:
Table 46. Supported business object
Business object name | Agent support required? |
---|---|
ItemBasic | Yes |
runmqsc local_WebSphere_ICS_queue_manager_name DEFINE QLOCAL (AP/PORTCONNECTOR/ICS_server_name) USAGE (NORMAL) DEFINE QLOCAL (IC/ICS_server_name/PORTCONNECTOR) USAGE (NORMAL) END
To create the EmailConnector, complete the following steps:
<install_path>\connectors\email\start_email.bat EMail ICS_server_name
Table 47. Connector-specific property
Property name | Property value |
---|---|
SMTP_MailHost | Hostname or IP address of a mail server. |
If you are using SAP as the source for your item information, configure the
SAPConnector according to the Adapter for mySAP.com (SAP R/3
V.4.x) User Guide. Configure the connector to include the
appropriate business objects. Use the values shown in the following
table.
Table 48. Supported business objects
Business object name | Agent support required? |
---|---|
SAP4_MatlBasic | Yes |
ItemBasic | No |
Save the configuration (File > Save > To Project), then go back
to the Associated Map tab and set the explicit bindings.
Business object name | Map name |
---|---|
SAP4_MatlBasic | Sa4CwItemBasic |
ItemBasic | CwSa4ItemBasic |
Save the configuration (File > Save > To Project).
A TestConnector can be used to simulate a SAP connection (refer to Configuring the TestConnector for details). If you are going to use the TestConnector, you must also save the SAP connector configuration to a file (File > Save > To File). However, if you are connecting to a live SAP system, refer to the document Adapter for mySAP.com (SAP R/3 V.4.x) User Guide for additional configuration steps.
The SAPConnector Agent can be simulated using a TestConnector if a live SAP installation is not available.
Use the information provided in this section to bind the ports and set the attribute values of various collaboration objects. When you have completed creating and configuring the collaboration objects, proceed to the section Configuring the relationships before deployment.
To create and configure a collaboration object based on the UCCnet_ItemSync collaboration template, complete the following steps:
Table 50. UCCnet_ItemSync collaboration object ports
Collaboration object | Port | Type | Bind to |
---|---|---|---|
UCCnet_ItemSyncObject | From | connector | Source application's connector |
| To (Using DTD) | connector | AS2 channel connector |
| To (Using XSD) | collaboration object | ItemCommandRouter_Obj:From |
| DestinationAppRetrieve | connector | PortConnector |
Table 51. UCCnet_ItemSync collaboration object configuration properties
Collaboration object | Property name | Property description | Required |
---|---|---|---|
UCCnet_ItemSyncObject | GtinDB_USER | The user ID used to connect to the database containing the PROCESSED_GTIN and trading_partner tables. | Yes |
| GtinDB_PASSWORD | The password for the GtinDB_USER. | Yes |
| JDBC_DRIVER | Pointer to the driver used to connect to the database containing the PROCESSED_GTIN and trading_partner tables. | It is required if the ICS does not register the driver in the Java Virtual Machine (JVM). The Microsoft SQL driver, for example, is already registered in the JVM by the ICS and does not need to be specified. |
| JDBC_URL | The JDBC URL corresponding to the JDBC_DRIVER specified. | Yes |
| SEND_EMAIL_TO | Defines the email address to which problems detected during execution of collaboration object processing are sent. This entry is for ICS 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 | Dictates whether email is sent to the address set in the SEND_EMAIL_TO property. | Yes, if you want to send email. To send email, set it to the value all. Otherwise, set the value to none. |
| AUDITLOG_INSTANCE_NAME | Identifies the tag in the UCCnet section within the InterchangeServer.cfg file under which other tags needed for audit logging are contained. The default value is UCCnet. This value must be correct for the CSIAuditLogger class to find the database information to make audit log entries. | Yes |
| SUPPLIER_NAME | The name of the partner that is synchronizing item information with UCCnet. This value is logged in audit entries. A sample entry is SAP. | No |
This object is only required for schema (XSD) support. It is not used for DTD support. There are two possible ways to configure this collaboration object, depending on whether you implement your own data pool (CIN operation) or use UCCnet as a data pool (CIP operation).
If you set up your system for CIN operation, then create and configure a collaboration object based on the ItemCommandRouter collaboration template:
Name the collaboration object and bind the ports using the values from the
following table.
Table 52. ItemCommandRouter collaboration object ports (CIN operation)
Collaboration object | Port | Type | Bind to |
---|---|---|---|
ItemCommandRouter_Obj | From | collaboration object | UCCnet_ItemSyncObject:To |
| ToCIN_CI | collaboration object | CIN_CIP_Dispatcher_forICR_Obj:From |
| ToRCIR | connector | AS2 channel connector |
If you set up your system for CIP operation, then create and configure a collaboration object based on the ItemCommandRouter collaboration template as follows:
Name the collaboration object and bind the ports using the values from the
following table.
Table 53. ItemCommandRouter collaboration object ports (CIP operation)
Collaboration object | Port | Type | Bind to |
---|---|---|---|
ItemCommandRouter_Obj | From | collaboration object | UCCnet_ItemSyncObject:To |
| ToCIN_CI | collaboration object | ItemCommandRouter_DE_LIST_WITHDRAWObject:FromItemBasic |
| ToRCIR | connector | AS2 channel connector |
This collaboration object is only created if you are using schema (XSD) support. If you are setting up for CIN operation, you will need to create two objects. If you are setting up for CIP operation, you only need one. Complete the following steps:
Table 54. CIN_CIP_Dispatcher collaboration object ports (CIN operation)
Collaboration object | Port | Type | Bind to |
---|---|---|---|
CIN_CIP_Dispatcher_forICR_Obj | From | collaboration object |
ItemCommandRouter_Obj:ToCIN_CI |
| To | connector | AS2 channel connector |
| DestinationAppRetrieve | connector | PortConnector |
CIN_CIP_Dispatcher_forPWL_Obj | From | collaboration object |
UCCnet_processWorklist: RCIR_RESPONSE |
| To | connector | AS2 channel connector |
| DestinationAppRetrieve | connector | PortConnector |
Table 55. CIN_CIP_Dispatcher collaboration object ports (CIP operation)
Collaboration object | Port | Type | Bind to |
---|---|---|---|
CIN_CIP_Dispatcher_forPWL_Obj | From | collaboration object |
UCCnet_processWorklist: PUBLICATION_CMD_RESPONSE |
| To | connector | AS2 channel connector |
| DestinationAppRetrieve | connector | PortConnector |
Table 56. CIN_CIP_Dispatcher collaboration object configuration properties
Collaboration object | Property name | Property description | Required |
---|---|---|---|
CIN_CIP_Dispatcher_forICR_Obj CIN_CIP_Dispatcher_forPWL_Obj | AUDIT_LOG_INSTANCE_NAME | Identifies the tag in the UCCnet section the
InterchangeServer.cfg file that contains the other tags
needed for audit logging. This value must be correct for the
CSIAuditLogger class to find the database information to make audit log
entries. Default:
UCCnet | Yes |
| DISPATCHER_GLN_FILE | The fully qualified name of the file that holds the GLNs subscribed to
each category code. Default:
C:\IBM\WebSphereICS\UCCnet\dispatcher_gln_file.txt | Yes |
| TO_UCCNETGBO_PROCESSING_MAP | Called by the CIN_CIP_Dispatcher object to map incoming item basic
objects to the outgoing Catalogue Item Notification or Cataloge Item
Publication message. Value:
| Yes |
| SUPPLIER_NAME | The name of the partner responsible for synchronizing item information with UCCnet. SAP, for example. This value is logged in audit entries. No default value. | No |
| GLN_ATTRIBUTE | Identifies where in the UCCnetGBO business object the GLN retrieved from
the Dispatcher GLN file should be placed. Values to use:
|
|
| TOPIC_ATTRIBUTE | Identifies where in the UCCnetGBO business object the collaboration
should get the topic value used for audit logging. Values to use:
|
|
The GLN_DISPATCHER file contains one or more category codes with a list of subscribing retailers after each category code. For example:
UDEX.01.0020.0855 7789333000026 7789333000027 7789333000028 UDEX.05.0139.0334 7789333000026 7789333000027 7789333000028 7789333000029 7789333000030 7789333000031
Here, UDEX.01.0020.0855 and UDEX.05.0139.0334 are the category codes. The numbers underneath each category code are the GLNs for the subscribing retailers.
To create and configure a collaboration object based on the UCCnet_requestWorklist collaboration template, complete the following steps:
Table 57. UCCnet_requestWorklist collaboration object ports
Collaboration object | Port | Type | Bind to |
---|---|---|---|
UCCnet_requestWorklistObject | From | connector | JTextRWLConnector |
To | connector | AS2 channel connector |
Table 58. UCCnet_requestWorklist collaboration object configuration properties
Collaboration object | Property name | Property description | Required |
---|---|---|---|
UCCnet_requestWorklistObject | DTD_URL | Sets the value for the DocType line in outgoing XML. The default
value is:
DOCTYPE envelope SYSTEM "http://www.uccnet.net/ \ xmlschema/2.2/Envelope.dtd" For schema support, the value is left blank. | No, unless the default value is incorrect for the environment to which the XML messages are being sent. |
| SET_UNIQUE_IDS | Controls whether unique IDs (messageIdentifier and
uniqueCreateorIdentification) are set in the output XML messages.
Possible values for this property are:
| No, unless the default value needs to be changed. |
To create and configure a collaboration object based on the UCCnet_processWorklist collaboration template, complete the following steps:
Table 59. UCCnet_processWorklist collaboration object ports
Collaboration object | Port | Type | Bind to |
---|---|---|---|
UCCnet_processWorklistObject | UNKNOWN_RESPONSE | collaboration object |
UCCnet_processWorklist_UNKNOWN_RESPONSEObject:From |
| CATALOGUE_ITEM_CONFIRMATION |
|
|
| DestinationAppRetrieve | connector | PortConnector |
| NEW_ITEM_PUBLICATION_REQUEST | connector | AS2 channel connector |
| AUTHORIZATION_RESPONSES | collaboration object |
UCCnet_processWorklist_AUTHORIZATION_RESPONSESObject:From |
| DEAD_LETTER_PUB_RECEIPT | collaboration object |
UCCnet_processWorklist_DEAD_LETTER_PUB_RECEIPTObject:From |
| From | connector | AS2 channel connector |
| ITEM_ADD_CHANGE | connector | AS2 channel connector |
| INITIAL_ITEM_LOAD_REQUEST | connector | AS2 channel connector |
| CATEGORY_ADD_CHANGE | collaboration object |
UCCnet_processWorklist_CATEGORY_ADD_CHANGEObject:From |
| UNKNOWN_MESSAGES | collaboration object |
UCCnet_processWorklist_UNKNOWN_MESSAGESObject:From |
| SIMPLE_RESPONSE | collaboration object |
UCCnet_processWorklist_SIMPLE_RESPONSEObject:From |
| RCIR_RESPONSE |
|
|
| CIN_RESPONSE |
|
|
| CI_RESPONSE |
|
|
| CIP_RESPONSE |
|
|
| PUBLICATION_CMD_RESPONSE |
|
|
| FAILURE | Collaboration object |
UCCnet_processWorklist_FAILURE_RESPONSEObject:From |
| RCIR_QUERY_RESPONSE |
|
|
Table 60. UCCnet_processWorklist collaboration object configuration properties
Collaboration object | Property name | Property description | Required |
---|---|---|---|
UCCnet_processWorklistObject | DB_USER | The user of the database associated with the WebSphere business integration system. | Yes |
| DB_PASSWORD | The password for the DB_USER. | Yes |
| JDBC_DRIVER | Pointer to the driver code used to connect to the database associated with the WebSphere business integration system. | Only if the ICS does not register the driver in the JVM. The Microsoft SQL driver, for example, is already registered in the JVM by the ICS and does not need to be specified. |
| JDBC_URL | The JDBC URL corresponding to the JDBC_DRIVER specified. | Yes |
| SEND_EMAIL_TO | Defines the email address to which problems detected during execution of the collaboration object are sent. This entry is for ICS 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 email. If this field is left blank, no email is sent. |
| AUDITLOG_INSTANCE_NAME | Identifies the tag in the UCCnet section within the InterchangeServer.cfg file under which other tags needed for audit logging are contained. The default value is UCCnet. This value must be correct for the CSIAuditLogger class to find the database information to make audit log entries. | Yes |
| SUPPLIER_NAME | The name of the partner that is synchronizing item information with UCCnet. This value is logged in audit entries. A sample entry is SAP. | No |
| DTD_URL | Sets the value for the DocType line in outgoing XML. The default
value is:
DOCTYPE envelope SYSTEM \ "http://www.uccnet.net/ \ xmlschema/2.2/Envelope.dtd" For schema support, the value is left blank. | No, unless the default value is incorrect for the environment to which the XML messages are being sent. |
| AUTO_RESPOND | Controls whether an automatic response is sent to UCCnet. The default value is: YES. | No, unless the default value needs to be changed. |
When using a DTD implementation, you must create and configure seven collaboration objects based on the Notify_by_eMail collaboration template. When using a schema implementation, you must create and configure either ten or twelve, depending on whether you are using CIN or CIP operation. To do this, complete the following steps:
Table 61. Notify_by_eMail collaboration objects and ports
Collaboration object | Port | Type | Bind to |
---|---|---|---|
UCCnet_processWorklist_AUTHORIZATION_RESPONSESObject | From | collaboration object |
UCCnet_processWorklistObject:AUTHORIZATION_RESPONSES |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_CATEGORY_ADD_CHANGEObject | From | collaboration object |
UCCnet_processWorklistObject:CATEGORY_ADD_CHANGE |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_DEAD_LETTER_PUB_RECEIPTObject | From | collaboration object |
UCCnet_processWorklistObject:DEAD_LETTER_PUB_RECEIPT |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_SIMPLE_RESPONSEObject | From | collaboration object |
UCCnet_processWorklistObject:SIMPLE_RESPONSE |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_UNKNOWN_MESSAGESObject | From | collaboration object |
UCCnet_processWorklistObject:UNKNOWN_MESSAGES |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_UNKNOWN_RESPONSEObject | From | collaboration object |
UCCnet_processWorklistObject:UNKNOWN_RESPONSE |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_FAILURE_RESPONSEObject | From | collaboration object |
UCCnet_processWorklistObject:FAILURE |
| FromItemBasic | connector | Port connector |
Table 62. Notify_by_eMail collaboration objects and ports (schema specific)
Collaboration object | Port | Type | Bind to |
---|---|---|---|
UCCnet_processWorklist_CATALOGUE_ITEM_CONFIRMATIONObject | From | collaboration object |
UCCnet_processWorklistObject:CATALOGUE_ITEM_CONFIRMATION |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_RCIR_QUERY_RESPONSEObject | From | collaboration object |
UCCnet_processWorklistObject:RCIR_QUERY_RESPONSE |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_CI_RESPONSEObject (For CIP operation only) | From | collaboration object |
UCCnet_processWorklistObject:CI_RESPONSE |
| FromItemBasic | connector | Port connector |
UCCnet_processWorklist_CIP_RESPONSEObject (For CIP operation only) | From | collaboration object |
UCCnet_processWorklistObject:CIP_RESPONSE |
| FromItemBasic | connector | Port connector |
ItemCommandRouter_DE_LIST_WITHDRAWObject (For CIP operation only) | From | connector | Port connector |
| FromItemBasic | collaboration object | ItemCommandRouter_Obj:ToCIN_CI |
UCCnet_processWorklist_CIN_RESPONSEObject (For CIN operation only) | From | collaboration object |
UCCnet_processWorklistObject:CIN_RESPONSE |
| FromItemBasic | connector | Port connector |
All of the collaboration objects based on the Notify_by_eMail collaboration template must have their properties updated to point to the correct location of these sample files or to your own custom email files.
Table 63. Notify_by_eMail collaboration object configuration properties
Use the values in this table for all of the following collaboration
objects:
| ||
Property name | Property description | Required |
---|---|---|
EMAIL_NOTIFICATION_RCPTS | Email address of the recipients. | Yes |
EMAIL_SUBJECT | Subject line of the email. This value can contain variables in the
form ${variable_name} into which the collaboration
object substitutes data from the business object dynamically. Type text
using the following escape codes:
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 email and for a sample value for this property. | Yes |
EMAIL_MESSAGE | Body of the email. 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 |
Set up the relationships, as follows:
Deploy the solution, as follows:
After the relationships have been deployed as a result of the steps in the section Deploying the solution, you must then populate the relationships with default values and make modifications needed in the default schemas by completing the following steps. Be sure to follow the instructions appropriate for your platform where indicated.
<ICS_installation_path>\collaborations\dependencies\ \ UCCnet\db2
<ICS_installation_path>\collaborations\dependencies\ \ UCCnet\oracle
sqlplus dbuser/passwd@SID @InitializeRelationshipTables.sql
sqlplus dbuser/passwd@SID @InitializeRelationshipTablesForXSD.sql
You might have to enable autoextension of the CWRepository datafile. Select the AUTOEXTEND option on the Storage tab for the datafile in the DBA Studio.
<ICS_installation_path>\collaborations\dependencies\ \ UCCnet\mss
<ICS_installation_path>/collaborations/dependencies/ \ UCCnet/db2
<ICS_installation_path>/collaborations/dependencies/ \ UCCnet/oracle
sqlplus dbuser/passwd@SID @InitializeRelationshipTables.sql
sqlplus dbuser/passwd@SID @InitializeRelationshipTablesForXSD.sql
You might have to enable autoextension of the CWRepository datafile. Select the AUTOEXTEND option on the Storage tab for the datafile in the DBA Studio.