Except where noted, all the information in this guide applies to both IBM WebSphere Business Integration Express for Item Synchronization and IBM WebSphere Business Integration Express Plus for Item Synchronization. The term "WebSphere Business Integration Express for Item Synchronization" and its variants refer to both products.
The Item Synchronization Collaboration synchronizes item information in compliance with UCCnet standards. It is used to maintain the consistency of a supplier's item information in UCCnet and to ensure that the information is kept current with the most recent data in the supplier's application. The supplier can also communicate new or changed item information to subscribing trading partners in UCCnet.
The Item Synchronization Collaboration accomplishes these tasks through a set of component collaboration templates.
The way you communicate with UCCnet will determine which templates and connectors you use and how you configure them. Items to consider include:
Since the actual connector you use to communicate with UCCnet is dependent on your setup, the term "AS2 channel connector" is used throughout this document as a general term for either the iSoftConnector or JTextISoftConnector. Details on making these choices and implementing them can be found in the Installation Guide
If information in the documentation pertains only to a specific set of options, the following terminology is used to indicate it:
The collaboration templates available to use are as follows:
This collaboration template is used only if you are implementing a solution with the schema-based XML definition. If you are implementing a solution using CIN operation, then you must create two collaboration objects from this template since objects based on this template can receive a triggering object from one of two sources. If you are implementing a solution using CIP operation, you only need a single collaboration object.
This collaboration template is used only if you are implementing a solution with the schema-based XML definition.
To synchronize critical information throughout the item life cycle, the following business objects are used:
This application-specific business object is used by the AS2 channel connector when the DTD XML definition type is used.When a message is received from UCCnet, the AS2 channel connector and the XML DataHandler create this business object from the received XML file. Before it is processed by the collaboration objects included with the solution, it must first be transformed into a UCCnetGBO_envelope business object by passing through the UCCnetDTD_envelope_to_UCCnetGBO_envelope map.
When a message is sent to UCCnet, the UCCnetDTD_envelope business object is the result of the conversion of either an ItemBasic or a UCCnetGBO_envelope business object by one of the associated maps configured in the AS2 channel connector.
This application-specific business object is used by the AS2 channel connector when the XSD XML definition type is used.
When a message is received from UCCnet, the AS2 channel connector and the XML DataHandler create this business object from the received XML file. Before it is processed by the collaboration objects included with the solution, it must first be transformed into a UCCnetGBO_envelope business object by passing through the UCCnetXSD_envelope_to_UCCnetGBO_envelope map.
When a message is sent to UCCnet, the UCCnetXSD_envelope business object is the result of the conversion of either an ItemBasic or a UCCnetGBO_envelope business object by one of the associated maps configured in the AS2 channel connector.
The following sections include information on each collaboration template's ports and setup procedures for collaboration objects created from the collaboration templates:
For general information on creating collaboration objects, refer to the Collaboration Development Guide.
The following table provides information about the UCCnet_ItemSync collaboration template's ports. Use the ItemBasic business object for all ports.
Table 1. UCCnet_ItemSync collaboration template's ports
Port name | Bound to | Function | Verbs used |
---|---|---|---|
DestinationAppRetrieve | PortConnector | This port is currently unused. | None |
From | Source application's connector | Receives the triggering ItemBasic business object. | Create
Update |
To |
|
|
|
The following table provides information about the UCCnet_requestWorklist collaboration template's ports. Use the UCCnetGBO_envelope business object for all ports.
Table 2. UCCnet_requestWorklist collaboration template's ports
Port name | Bound to | Function | Verbs used |
---|---|---|---|
DestinationAppRetrieve | PortConnector | This port is currently unused. | None |
From | JTextRWLConnector | Receives the input UCCnetGBO_envelope business object. | Create |
To | AS2 channel connector | Passes the processed UCCnetGBO_envelope business object to the AS2 channel connector, which transmits the data to the iSoft Peer-to-Peer Agent, which sends the command to UCCnet. | Create |
The following table provides information about the UCCnet_processWorklist collaboration templates's ports.
Table 3. UCCnet_processWorklist collaboration template's ports
Port name | Bound to | Function | Verbs used |
---|---|---|---|
From | AS2 channel connector | A UCCnetGBO_envelope business object is passed in on this port. | Create |
NEW_ITEM_PUBLICATION_REQUEST | AS2 channel connector | A UCCnetGBO_envelope business object is passed out on this port. | Create |
ITEM_ADD_CHANGE | AS2 channel connector | A UCCnetGBO_envelope business object is passed out on this port. | Create |
INITIAL_ITEM_LOAD_REQUEST | AS2 channel connector | A UCCnetGBO_envelope business object is passed out on this port. | Create |
UNKNOWN_RESPONSE | Notify_by_eMail collaboration object set up for sending UNKNOWN_RESPONSE email | Triggers the sending of an email to the supplier, indicating that an UNKNOWN_RESPONSE has been received. | Create |
AUTHORIZATION_RESPONSES | Notify_by_eMail collaboration object set up for sending AUTHORIZATION_RESPONSE email | Triggers the sending of an email to the supplier, indicating that an authorization response has been received. | Create |
DEAD_LETTER_PUB_RECEIPT | Notify_by_eMail collaboration object set up for sending DEAD_LETTER_PUB_RECEIPT email | Triggers the sending of an email to the supplier, indicating that a DEAD_LETTER_PUB_RECEIPT has been received. | Create |
CATEGORY_ADD_CHANGE | Notify_by_eMail collaboration object set up for sending CATEGORY_ADD_CHANGE email | Triggers the sending of an email to the supplier, indicating that a CATEGORY_ADD_CHANGE has been received. | Create |
UNKNOWN_MESSAGES | Notify_by_eMail collaboration object set up for sending UNKNOWN_MESSAGES email | Triggers the sending of an email to the supplier, indicating that an unknown message has been received. | Create |
SIMPLE_RESPONSE | Notify_by_eMail collaboration object set up for sending SIMPLE_RESPONSE email | Triggers the sending of an email to the supplier, indicating that a SIMPLE_RESPONSE has been received. | Create |
CATALOGUE_ITEM_CONFIRMATION |
|
|
|
RCIR_RESPONSE |
|
|
|
DestinationAppRetrieve | A collaboration object or application that will provide the appropriate ItemBasic business object | An ItemBasic business object with key information is passed out on this port. The retrieved ItemBasic business object is returned through the same port. | Retrieve |
CIN_RESPONSE |
|
|
|
CIP_RESPONSE |
|
|
|
CI_RESPONSE |
(XSD support, CIP operation) or Port Connector (DTD support and XSD support, CIN operation) |
|
|
PUBLICATION_CMD_RESPONSE |
|
|
Create |
FAILURE | Notify_by_eMail collaboration object set up for sending FAILURE RESPONSE email | Triggers the sending of an email to the supplier, indicating that a FAILURE response has been received. | Create |
The following table provides information about the Notify_by_eMail collaboration template's port. Use the UCCnetGBO_envelope business object for the port.
Table 4. Notify_by_eMail collaboration template's port
Port name | Bound to | Function | Verbs used |
---|---|---|---|
From | UCCnet_processWorklist collaboration object | A UCCnetGBO_envelope business object is passed in on this port. The business object is incorporated into an email message and sent out to configured email recipients. | Create |
ItemBasicFrom | ItemCommandRouter collaboration object or UCCnet_processWorklist collaboration object | An ItemBasic business object is passed in on this port. The business object is incorporated into an email message and sent out to configured email recipients. | Create |
This collaboration template is only used with schema (XSD) support. You must create and configure either one or two collaboration objects based on this template, depending on your mode of operation. Two are required for CIN operation. Only one is required for CIP operation.
The following table provides information about the CIN_CIP_Dispatcher collaboration template's ports.
Table 5. CIN_CIP_Dispatcher collaboration template's ports
Port name | Bound to | Function | Verbs used |
---|---|---|---|
DestinationAppRetrieve | PortConnector | This port is currently not used. | None |
To | AS2 channel connector | A UCCnetGBO_envelope business object is passed out on this port. | Create, Update |
From | ItemCommandRouter or UCCnet_processWorklist | Receives an ItemBasic business object on this port. | Create
Update |
This collaboration template is only used with schema (XSD) support.
The following table provides information about the ItemCommandRouter collaboration template's ports.
Table 6. ItemCommandRouter collaboration template's ports
Port name | Bound to | Function | Verbs used |
---|---|---|---|
From | UCCnet_ItemSync collaboration object | Receives an ItemBasic business object. | Create, Update |
ToRCIR | AS2 channel connector | ItemBasic business object is passed out on this port. | Create, Update |
ToCIN_CI |
|
|
Update |
To set up any collaboration template supplied with the Item Synchronization Collaboration as a stand-alone collaboration object, complete the following steps:
The following sections illustrate the process logic for the collaboration templates included with the Item Synchronization Collaboration:
The supplied collaboration templates work together to handle workflows in systems using UCCnet XSDs or DTDs.
The XSD-based workflows include the following:
The DTD-based workflows include the following:
At the highest level, business data received from an ERP application (typically a supplier) is sent to the specific AS2 channel connector. This connector transforms the business object into an XML format that can be handled by the iSoft Peer-to-Peer Agent. The iSoft Peer-to-Peer Agent then sends the data to UCCnet. Detailed descriptions of the workflows exist in the Solution Development Guide.
The UCCnet_ItemSync and CIN_CIP_Dispatcher collaboration templates use the following standard processes for collaboration templates:
The UCCnet_requestWorklist, UCCnet_processWorklist, Notify_by_eMail, and ItemCommandRouter collaboration templates do not use standard processes.
The following sections describe configuration properties for the collaboration templates included with the Item Synchronization Collaboration:
The UCCnet_ItemSync and CIN_CIP_Dispatcher collaboration templates use the following standard configuration properties for collaboration templates:
The UCCnet_requestWorklist, UCCnet_processWorklist, Notify_by_eMail, and ItemCommandRouter collaboration templates do not use standard configuration properties.
In addition to its standard configuration properties, this collaboration template has the following configuration properties:
Table 7. Configuration properties specific to the UCCnet_ItemSync collaboration template
Property name | Property description | Required |
---|---|---|
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 code used to connect to the database containing the PROCESSED_GTIN and trading_partner tables. | Only if the ICS does not register the driver in the Java(TM) Virtual Machine (JVM). The Microsoft(R) 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 EmailConnector to run if email is entered. The SEND_EMAIL property must be set also. |
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 collaboration template has the following configuration properties.
Table 8. Configuration properties specific to the UCCnet_requestWorklist collaboration template
Property name | Property description | Required |
---|---|---|
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, this value should be 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. |
This collaboration template has the following configuration properties.
Table 9. Configuration properties specific to the UCCnet_processWorklist collaboration template
Property name | Property description | Required |
---|---|---|
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 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 EmailConnector 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, this value should be 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. |
This collaboration template has the following configuration properties.
Table 10. Configuration properties specific to the Notify_by_eMail collaboration template
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 into which the
collaboration object substitutes data from the business object
dynamically. Variables to be substituted must be enclosed in the
prefix characters ${ and the suffix character }
(for example, ${variable_name}). Note: These
characters might have to be changed to meet National Language
requirements. 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 |
In addition to its standard configuration properties, this collaboration template has the following configuration properties:
Table 11. Configuration properties specific to the CIN_CIP_Dispatcher collaboration template
Property name | Property description | Required |
---|---|---|
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 |
GLN_ATTRIBUTE | Identifies
where in the UCCnetGBO business object the GLN retrieved from the
Dispatcher GLN file should be placed. Values to use:
|
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 |
TO_UCCNETGBO_PROCESSING_MAP | Called by
the CIN_CIP_Dispatcher object to map incoming item basic objects to
the outgoing Catalogue Item Notification or Catalogue Item
Publication message. Value:
|
Yes |
TOPIC_ATTRIBUTE | Identifies
where in the UCCnetGBO business object the collaboration should get
the topic value used for audit logging. Values to use:
|
This collaboration template does not use any standard or collaboration template-specific configuration properties.
For more information concerning the WebSphere Business Integration Express and Express Plus for Item Synchronization products, see the following documents: