DX 901 Developer Guide en

Informatica B2B Data Exchange (Version 9.0.
1)
Developer Guide
Informatica B2B Data Exchange Developer Guide Version 9.0.1 July 2010 Copyright (c) 1998-2010 Informatica. All rights reserved. This software and documentation contain proprietary information of Informatica Corporation and are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation. This Software may be protected by U.S. and/or international Patents and other Patents Pending. Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable. The information in this product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us in writing. Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange, PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange and Informatica On Demand are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks of their respective owners. Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights reserved. Copyright Sun Microsystems. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright International Business Machines Corp. All rights reserved. Copyright Cleo Communications Inc. All rights reserved. Copyright Acresso Software Inc. All rights reserved. Copyright Tanuki Software, Ltd. All rights reserved. This product includes software developed by the Apache Software Foundation (http://www.apache.org/), and other software which is licensed under the Apache License, Version 2.0 (the "License"). You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This product includes software which is copyright JBoss/Red Hat Inc., all rights reserved; and other software which is licensed under the GNU Lesser General Public License Agreement, which may be found at http://www.gnu.org/licenses/lgpl.html. The materials are provided free of charge by Informatica, "as-is", without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. The product includes software copyright 2001-2005 MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://www.dom4j.org/ license.html. This product includes software copyright The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http:// www.eclipse.org/org/documents/epl-v10.php. This product includes software copyright 2003-2008, Terence Parr, all rights reserved. See the License http://www.antlr.org/license.html for the specific language governing permissions and limitations. This product includes software copyright 2000-2005 INRIA, France Telecom, all rights reserved. See the License http://www.asm.ow2.org/license.html for the specific language governing permissions and limitations. This product includes software licensed under the terms at: http://fusesource.com/downloads/license-agreements/fuse-message-broker-v-5-3-license-agreement. See the license for the specific language governing permissions and limitations. This product includes software licensed under the Common Public License http://www.eclipse.org/legal/cpl-v10.html. See the License for the specific language governing permissions and limitations. Source code is available at http://sourceforge.net/projects/wsdl4j. This product includes software licensed under the BSD License (http://www.opensource.org/licenses/bsd-license.php). This Software is protected by U.S. Patent Numbers 5,794,246; 6,014,670; 6,016,501; 6,029,178; 6,032,158; 6,035,307; 6,044,374; 6,092,086; 6,208,990; 6,339,775; 6,640,226; 6,789,096; 6,820,077; 6,823,373; 6,850,947; 6,895,471; 7,117,215; 7,162,643; 7,254,590; 7,281,001; 7,421,458; and 7,584,422, international Patents and other Patents Pending. DISCLAIMER: Informatica Corporation provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of non-infringement, merchantability, or use for a particular purpose. Informatica Corporation does not warrant that this software or documentation is error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation is subject to change at any time without notice. NOTICES This Informatica product (the Software) includes certain drivers (the DataDirect Drivers) from DataDirect Technologies, an operating company of Progress Software Corporation (DataDirect) which are subject to the following terms and conditions: 1. THE DATADIRECT DRIVERS ARE PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS. Part Number: DX-DVG-90100-0001
Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv
Informatica Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv Informatica Customer Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv Informatica Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv Informatica Web Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv Informatica How-To Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv Informatica Knowledge Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v Informatica Multimedia Knowledge Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v Informatica Global Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Chapter 1: Using PowerCenter with B2B Data Exchange. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Overview of Using PowerCenter with B2B Data Exchange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Step 1. Installing the B2B Data Exchange Plug-Ins. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Server Plug-In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Client Plug-In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Step 2. Creating the Source and Target Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Source Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Target Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Step 3. Creating the Mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Workflow Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Transformations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Step 4. Creating the Connection Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 JNDI Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 JMS Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Step 5: Create the Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Step 6. Exporting the Mapping/Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Updating the Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Chapter 2: B2B Data Exchange Transformations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

B2B Data Exchange Transformations Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Installation and Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Guidelines for Using the Data Exchange Transformations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Configuring Data Exchange Transformations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Error Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 DX_Add_Document_To_Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Table of Contents
DX_Aggregate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 DX_Complete_Correlation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 DX_Create_Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 DX_Event_Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 DX_Event_Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 DX_Generate_Temporary_File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 DX_Get_Document_File_Path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 DX_Increment_Profile_Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 DX_Initiate_Correlation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 DX_Profile_Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 DX_Release_Delayed_Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 DX_Resolve_Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
ii
Table of Contents
DX_Throw_Error. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Chapter 3: Creating Workflows for Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Overview of Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Initiating and Completing an Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Initiating an Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Completing an Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Reconciliation Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Chapter 4: Forms Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Overview of the Forms Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Using the Forms Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Creating a Dependency between Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Chapter 5: Configuring Email for Monitor Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Overview of Email for Monitor Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 The Built-in Email Notification Message Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Configuring the Email Notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Configuring Email Notifications Using System Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Configuring Email Notifications Using Event Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Configuring the Body of an Email Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Appendix A: B2B Data Exchange API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Overview of B2B Data Exchange API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 B2B Data Exchange API Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 API Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Table of Contents
iii
Preface
The B2B Data Exchange Developer Guide provides information about the tasks required to develop workflows in PowerCenter to process B2B Data Exchange documents. It assumes that you have a working knowledge of PowerCenter and are familiar with the format and requirements of the documents processed in B2B Data Exchange.
Informatica Resources
Informatica Customer Portal
As an Informatica customer, you can access the Informatica Customer Portal site at http://mysupport.informatica.com. The site contains product information, user group information, newsletters, access to the Informatica customer support case management system (ATLAS), the Informatica How-To Library, the Informatica Knowledge Base, the Informatica Multimedia Knowledge Base, Informatica Product Documentation, and access to the Informatica user community.
Informatica Documentation
The Informatica Documentation team takes every effort to create accurate, usable documentation. If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation team through email at infa_documentation@informatica.com. We will use your feedback to improve our documentation. Let us know if we can contact you regarding your comments. The Documentation team updates documentation as needed. To get the latest documentation for your product, navigate to Product Documentation from http://mysupport.informatica.com.
Informatica Web Site

You can access the Informatica corporate web site at http://www.informatica.com. The site contains information about Informatica, its background, upcoming events, and sales offices. You will also find product and partner information. The services area of the site includes important information about technical support, training and education, and implementation services.
Informatica How-To Library

As an Informatica customer, you can access the Informatica How-To Library at http://mysupport.informatica.com. The How-To Library is a collection of resources to help you learn more about Informatica products and features. It includes articles and interactive demonstrations that provide solutions to common problems, compare features and behaviors, and guide you through performing specific real-world tasks.
iv
Informatica Knowledge Base

As an Informatica customer, you can access the Informatica Knowledge Base at http://mysupport.informatica.com. Use the Knowledge Base to search for documented solutions to known technical issues about Informatica products. You can also find answers to frequently asked questions, technical white papers, and technical tips. If you have questions, comments, or ideas about the Knowledge Base, contact the Informatica Knowledge Base team through email at KB_Feedback@informatica.com.
Informatica Multimedia Knowledge Base

As an Informatica customer, you can access the Informatica Multimedia Knowledge Base at http://mysupport.informatica.com. The Multimedia Knowledge Base is a collection of instructional multimedia files that help you learn about common concepts and guide you through performing specific tasks. If you have questions, comments, or ideas about the Multimedia Knowledge Base, contact the Informatica Knowledge Base team through email at KB_Feedback@informatica.com.
Informatica Global Customer Support

You can contact a Customer Support Center by telephone or through the Online Support. Online Support requires a user name and password. You can request a user name and password at http://mysupport.informatica.com. Use the following telephone numbers to contact Informatica Global Customer Support:
North America / South America Toll Free Brazil: 0800 891 0202 Mexico: 001 888 209 8853 North America: +1 877 463 2435 Europe / Middle East / Africa Toll Free France: 00800 4632 4357 Germany: 00800 4632 4357 Israel: 00800 4632 4357 Italy: 800 915 985 Netherlands: 00800 4632 4357 Portugal: 800 208 360 Spain: 900 813 166 Switzerland: 00800 4632 4357 or 0800 463 200 United Kingdom: 00800 4632 4357 or 0800 023 4632 Asia / Australia Toll Free Australia: 1 800 151 830 New Zealand: 1 800 151 830 Singapore: 001 800 4632 4357
Standard Rate North America: +1 650 653 6332
Standard Rate India: +91 80 4112 5738
Standard Rate Belgium: +32 15 281 702 France: 0805 804632 Germany: +49 1805 702 702 Netherlands: +31 306 022 797
Preface
vi
CHAPTER 1
Using PowerCenter with B2B Data Exchange

This chapter includes the following topics:
Overview of Using PowerCenter with B2B Data Exchange, 1 Step 1. Installing the B2B Data Exchange Plug-Ins, 2 Step 2. Creating the Source and Target Definitions, 2 Step 3. Creating the Mapping, 5 Step 4. Creating the Connection Objects, 5 Step 5: Create the Workflow, 6 Step 6. Exporting the Mapping/Workflow, 7
Overview of Using PowerCenter with B2B Data Exchange

Use the PowerCenter Client tools to develop workflows to process documents for B2B Data Exchange. You create the mappings and workflows for B2B Data Exchange in the same way you create other PowerCenter workflows. B2B Data Exchange provides transformations specifically designed to perform the transformation tasks required to process Data Exchange documents. When you add the transformations to a mapping, you can set properties that are used by the corresponding workflow in B2B Data Exchange. To develop a workflow in PowerCenter to process Data Exchange documents, complete the following steps: 1. 2. 3. 4. 5. 6. Install and register the Data Exchange plug-in in a PowerCenter repository. Create source (JMS, flat file, Data Transformation) and target definitions. Create a mapping and use the B2B Data Exchange transformations, Unstructured Data transformations, and other PowerCenter transformations to process the documents. Create the connection objects for the JMS queues. Create the workflow and add the session to run the mapping. Export the mapping to use as a workflow definition file in B2B Data Exchange.
Step 1. Installing the B2B Data Exchange Plug-Ins

Use the B2B Data Exchange installer to install the Data Exchange server and client plug-ins.
Server Plug-In
When you install the Data Exchange server plug-in, the installer copies the server plug-in file named dxplugin.xml to the following directory:
<DXInstallationDir>/powercenter/plugin<VERSION>/dxplugin.xml
Use the PowerCenter Administration Console to register the plug-in to the repository where you plan to build mappings and workflows for B2B Data Exchange. The Data Exchange transformations in PowerCenter are disabled until you register the server plug-in. For more information about registering the plug-in, see the PowerCenter Administrator Guide.
Client Plug-In
When you install the Data Exchange client plug-in, the installer registers the plug-in file with the PowerCenter Client tools.
Step 2. Creating the Source and Target Definitions

PowerCenter uses JMS to receive documents from B2B Data Exchange and to send documents back to B2B Data Exchange. The documents you send to JMS can be text or binary. When using a real-time workflow, you must add a JMS source definition to a mapping designed to receive and process Data Exchange documents. If you send documents to B2B Data Exchange after processing, you must also define a JMS target. You create the JMS source and target definitions for Data Exchange mappings in the PowerCenter Designer in the same way you create JMS source and target definitions for other mappings. PowerCenter batch workflows can have a flat file source,or no source at all. For more information, see the PowerCenter Designer Guide. The JMS source and target definitions require additional properties configured to work with B2B Data Exchange. These properties allow B2B Data Exchange to pass parameters from B2B Data Exchange to PowerCenter and from PowerCenter to B2B Data Exchange. Batch workflows require additional mapping parameters to interact with B2B Data Exchange. These mapping parameters allow B2B Data Exchange to exchange information with PowerCenter. Batch workflows are invoked using the Web Services hub.
Source Definition
After you create the JMS source, you can add ports to the JMS source to store Data Exchange properties needed to run the workflow. To add ports to the JMS source, edit the source definition and add properties in the JMS Message Property Columns tab. The Designer adds the property to the list of ports in the JMS source. By default, the Designer adds the prefix Prop_ to the port name. Use the PowerCenter designer to define the batch workflow mapping parameters for the PowerCenter mapping.
Chapter 1: Using PowerCenter with B2B Data Exchange
B2B Data Exchange Properties

You can use the following B2B Data Exchange properties as JMS source properties in realtime workflows, or as mapping parameters in batch workflows, to have the Data Exchange Server pass this information to the workflows:
Property Name accountName Description The Data Exchange Server sets the port to the account name associated with the event to be processed by the workflow. The Data Exchange Server sets the port to the account number associated with the event to be processed by the workflow. Note: accountNumber is a string datatype, not a number, despite its name. The Data Exchange Server sets the port to the application name associated with the event to be processed by the workflow. The Data Exchange Server sets this property to True when the JMS message sent to PowerCenter contains a document reference. The Data Exchange Server sets it to False when the JMS message sent to PowerCenter contains the document data. The Data Exchange Server sets this property to the event Id of the related sent message. If the event was reprocessed, the Data Exchange Server sets this port to True. The Data Exchange Server sets the port to the partner name associated with the event to be processed by the workflow. Note: accountName, accountNumber and partnerName can all be null if you have a global profile. The Data Exchange Server sets the port to the profile Id associated with the event to be processed by the workflow. The Data Exchage Server sets the port to the profile name associated with the event to be processed by the workflow.
accountNumber
application
DXDataByReference
DXEventId DXIsEventReprocessed partnerName
profileId
profileName
If an event monitor executed your profile, you will have additional properties, in addition to those shown above. For a regular delivery monitor, B2B Data Exchange adds the following properties:
DXSentEventId contains the list of event Ids DXMonitorId the monitor Id DXMonitorName the monitor name DXUser the recipient users
For a batch delivery monitor, B2B Data Exchange adds the following properties:
DXSentEventIds contains the list of event Ids DXMonitorId the monitor Id DXMonitorName the monitor name
Target Definition
After you create the JMS target, edit the target definition and add Data Exchange properties in the JMS Message Property Columns tab. The Designer adds the property to the list of ports in the JMS target. By default, the Designer adds the prefix Prop_ to the port name.
Step 2. Creating the Source and Target Definitions
Add the following properties to the JMS target definition:

Property Name DXDataByReference Description Required. Set this property to True to indicate that the JMS message sent back to B2B Data Exchange contains a document reference. Set it to False to indicate that the JMS message sent back to B2B Data Exchange contains the document data. The Data Exchange Server uses this property to determine the event ID to use for the event in the next workflow. If the JMS target contains this property, the Data Exchange Server does not generate a new event ID for the next workflow. The Data Exchange Server uses the value of this property as the event ID for the next workflow. The Data Exchange Server uses this property to determine the parent event ID to use for the event in the next workflow. If the JMS target contains this property, the Data Exchange Server generates a new event ID for the next workflow and uses the value of this property as the parent ID of the event ID of the next workflow. This property contains the event status name to which B2B Data Exchange should change the event status after successful event transformation. The Data Exchange Server uses this property to determine the endpoint to route to. If the property is set to an endpoint name, then this endpoint is used by the server to route the message. Used by the Data Exchange Server to determine which endpoint to route to. If the flag is True, the endpoint defined for the Partner/Account is used.
DXEventId
DXParentEventId
DXStatusName
endpointName
sendToAccount
You can also add properties to the JMS target to store other Data Exchange values that you want to send back to B2B Data Exchange. If you add a property to the JMS target, the Data Exchange configuration file must define how B2B Data Exchange handles the value of the property. Include a definition of the property in the JMS endpoint for inbound documents received from the workflow. Note: If you need to send an output message to more than one target, it is strongly recommended that you create a child event for each target, in order to be able to follow the transferring status of each message separately. Set the DXParentId property in the JMS target for this purpose. If you do not follow this procedure, all targets will update (overwrite) the same event status field and you will be unable to track the delivery status of any target.
Target Routing Procedure

B2B Data Exchange determines the Profile or Endpoint to which send a message is sent, based on the following rules: 1. 2. 3. endpointName JMS property. If the endpointName JMS property is set, the message is sent to the specified endpoint. profileId/profileName. If the profileID or profileName is set, the message is sent to the indicated profile. accountNumber/partnerName:
If sendToAccount is set to True, then send the message to the endpoint associated with the given accountNumber/ partnerName, which must be unique for the specified accountNumber/partnerName. - ORIf sendToAccount is not set (or set to False) then the profile is determined by the application, account, and partner. Note: If you want to route to an endpoint instead of a profile, it is strongly recommended that you use the accountNumber/partnerName routing method with sendToAccount set to True.
Step 3. Creating the Mapping

Create a mapping to process B2B Data Exchange documents in the same way you build other PowerCenter mappings. Add the JMS source and target definitions and the transformations you require.
Workflow Parameters
Use the DX_Profile_Parameters transformation in the mapping to get profile parameter values at runtime.
Transformations
You can use Data Exchange transformations and Unstructured Data transformations to add specific Data Exchange functionality to the mapping. You can also add other PowerCenter transformations to the mapping.
Step 4. Creating the Connection Objects

Before you create the connection objects for the Data Exchange workflows, verify that PowerExchange for JMS is installed on PowerCenter and you can create JMS connection objects. JMS sources and targets require the following connection objects:
JNDI application connection JMS application connection
JNDI Connection
Create a JNDI application connection object for the B2B Data Exchange JMS server. Set the attributes required for B2B Data Exchange. The following table describes the attributes of the JNDI connection object that you must configure:
Attribute JNDI Context Factory Description Name of the context factory specified for the B2B Data Exchange JMS provider. Set this attribute to the following value: com.informatica.b2b.dx.jndi.DXContextFactory URL for the JNDI provider in B2B Data Exchange. The host name and port number must match the host name and port number in the jndiProviderURL attribute of the JMS endpoints in the B2B Data Exchange configuration file. In case of a single node installation, the JNDI provider URL is, by default, failover:tcp://localhost:18616, In case of an ActiveMq cluster, you can provide multiple hosts here.
JNDI Provider URL
JMS Connection
Create one JMS application connection object for the input queue of each JMS source in each Data Exchange workflow. The input queue configuration must match the workflow name in B2B Data Exchange that represents the PowerCenter workflow.
Step 3. Creating the Mapping
Create one JMS application connection object for the B2B Data Exchange JMS server. All JMS targets in Data Exchange workflows use the same JMS application connection object for the output queue. The configuration of the output queue can use the configuration for the default inbound JMS endpoint defined in the B2B Data Exchange configuration file. The following table describes the attributes of the JMS connection object that you must configure:
Attribute JMS Destination Type Description Type of JMS destination for the Data Exchange messages. Set this attribute to QUEUE. Name of the connection factory in the JMS provider. Set this attribute to the following value:
connectionfactory.local
JMS Connection Factory Name
JMS Destination
Name of the destination. The destination name must have the following format:
queue.<DXWorkflowName>
DXWorkflowName is the name of the workflow in B2B Data Exchange that represents the PowerCenter workflow.
Step 5: Create the Workflow

Create a workflow and add a session to run the mapping. You can create the workflow in the same way you create other PowerCenter workflows. A JMS source is a real-time source. Configure the sessions in workflows that process Data Exchange documents as real-time sessions. Set the real-time properties, such as flush latency and commit type, to optimize processing. To configure the real-time session in a Data Exchange workflow: 1. 2. 3. In the Workflow Designer, edit the session object. In the Edit Tasks window, click the Properties tab. Set the values for the following attributes:
Attribute Commit Type Commit Interval Value Source 1
4. 5. 6.
Click the Mapping tab. In the Sources section on the left pane, select the JMS source. In the Properties section on the right pane, set the values for the following attributes:
Attribute Real-time Flush Latency JMS Queue Reader Mode Value 1 Message Consumer
7.
Save the session object.
For more information about real-time sessions, see the PowerCenter Advanced Workflow Guide. Test the workflow to ensure that it works correctly and processes documents as expected.
Step 6. Exporting the Mapping/Workflow

After you test the workflow and confirm that it is working correctly, export it. For batch workflows, you must export the workflow from the Repository Manager. For real-time workflows, you can export either the mapping or the workflow. You create a B2B Data Exchange workflow in the Operation Console to represent the workflow in PowerCenter. When you create the Data Exchange workflow, use the export file as the definition file. You can use the Forms Designer for designing the layout of the workflow parameters for the operator. For more information about the Forms Designer, see Using the Forms Designer on page 32.
Updating the Workflow

If you make changes to the workflow, export it again and update the definition file in the B2B Data Exchange Operation Console. Whenever a workflow is imported, B2B Data Exchange displays a list of its dependent profiles. It is highly recommended that you resolve the changes to updated workflow parameters (added or deleted parameters, parameter with changed types). In cases where a workflow parameter type is changed, it is necessary to re-enter the values of this parameter, since the import mechanism clears imported parameters whose type has changed. You have the option of disabling the dependent profiles until they are reviewed by the operator.
Step 6. Exporting the Mapping/Workflow
CHAPTER 2
B2B Data Exchange Transformations

B2B Data Exchange Transformations Overview, 8 DX_Add_Document_To_Event, 10 DX_Aggregate, 12 DX_Complete_Correlation, 14 DX_Create_Event, 15 DX_Event_Attribute, 16 DX_Event_Details, 17 DX_Generate_Temporary_File, 18 DX_Get_Document_File_Path, 19 DX_Increment_Profile_Parameter, 20 DX_Initiate_Correlation, 21 DX_Profile_Parameters, 22 DX_Release_Delayed_Events, 23 DX_Resolve_Profile, 24 DX_Throw_Error, 25
B2B Data Exchange Transformations Overview

You can run PowerCenter workflows to process Data Exchange documents. When you install B2B Data Exchange, you can install a set of transformations to use in PowerCenter workflows that process Data Exchange documents. When you create mappings, you can use the transformations to perform the B2B Data Exchange functions that you require. The Data Exchange transformations are custom Java transformations that allow you to access the B2B Data Exchange API without having to write code. You can use these transformations, the Unstructured Data transformation, and other transformations to process the B2B Data Exchange documents. If you require other functions that are not included in the transformations provided by B2B Data Exchange, you can create additional custom transformations and use the methods in the B2B Data Exchange API to define the transformation behavior.
The following table describes the B2B Data Exchange transformations:

Transformation DX_Add_Document_To_Event DX_Aggregate DX_Complete_Correlation DX_Event_Attrribute DX_Create_Event DX_Event_Details DX_Generate_Temporary_File DX_Get_Document_File_Path DX_Increment_Profile_Parameter DX_Initiate_Correlation DX_Profile_Parameters DX_Resolve_Profile Description Attaches a document to an event. Groups rows of data. Completes the correlation for an event. Gets or sets the value of event attributes. Creates an event and sets the properties of the event. Gets or sets the values of a property of an event. Generates a file name for a file in the Data Exchange document store. Converts a document reference into a file path. Increments the value of a parameter associated with a profile. Initiates a correlation for an event. Gets profile parameter values. Determines the profile ID based on the application, account number, and partner. Sets an event status to error if the transformation fails.
DX_Throw_Error
Installation and Registration

To use the Data Exchange transformations, run the B2B Data Exchange installer to install the following components:
Data Exchange server plug-in for PowerCenter. Use the PowerCenter Administration Console to register the
server plug-in.
Data Exchange client plug-in for PowerCenter. You can use the B2B Data Exchange installer to install and
register the client plug-in. If the Data Exchange transformations are disabled in the PowerCenter Designer, the plug-ins are not properly registered. Verify that you have installed and registered the plug-ins correctly. For more information, see the B2B Data Exchange Installation and Configuration Guide.
Guidelines for Using the Data Exchange Transformations

Use the following guidelines when you work with the Data Exchange transformations:
The Data Exchange transformations are based on the PowerCenter Custom transformation. They provide the
same configuration options as other custom transformations. You can use them as you use other PowerCenter transformations.
All Data Exchange transformations are connected transformations. All Data Exchange transformations are passive except the DX_Aggregate transformation.
B2B Data Exchange Transformations Overview
If a port in the transformation has a corresponding Data Exchange property, the value of the port takes
precedence over the value of the property at runtime. When the session runs, if the value of the port is not null, the Integration Service uses the value of the port for processing. If the value of the port is null, the Integration Service uses the value of the Data Exchange property for processing.
Port names are case insensitive and prefix insensitive. DXEventID, dxEVENTid, and eventid are all the same.
Configuring Data Exchange Transformations

After you add a Data Exchange transformation to a mapping, edit and configure the transformation based on your document processing requirements. When you edit a Data Exchange transformation, you can configure the transformation components on the following tabs:
Transformation tab. You can rename the transformation and add a description. Ports. You can add, edit, or delete ports or set ports to input or output. Properties tab. You can configure transformation properties such as module and function identifiers,
transaction properties, and the runtime location. The properties displayed on this tab are the same as the properties for other PowerCenter Custom transformations. For more information about the Properties tab, see the PowerCenter Transformation Guide.
DX Properties tab. You can set the default values for the ports in the transformation. You can also set the
default values for other Data Exchange properties.
Error Handling
Each Data Exchange transformation uses the following ports in error handling:
DXErrorCode. When a transformation fails, the transformation sets the DXErrorCode to a value greater than
zero.
DXErrorMessage. When a transformation fails, the transformation stores an error message in the
DXErrorMessage port to describe the failure. When a transformation generates an error, the transformation performs the following tasks:
The transformation writes the error to the PowerCenter session log. The error log includes the exception class,
description, cause, and stack trace. The logging level is based on the PowerCenter configuration. Up to 1K of the document associated with the error will be included in the log.
If the option to set the event status to error when a transformation fails is set to true, the transformation sets
the status of the event to error.
DX_Add_Document_To_Event
This transformation attaches a document to an event. For example, you can use this transformation to attach a log to an event.
10
Chapter 2: B2B Data Exchange Transformations
Input Ports
The DX_Add_Document_To_Event transformation has the following input ports:
Port DXDescription DXMIMEType DXEncoding Type string string string Description Description of the document to attach to the event. MIME type of the document to attach to the event. Character encoding of the document to attach to the event. This is the character set to use to when converting strings to byte arrays. Optional. Path and file name generated by the DX_Generate_Temporary_File transformation where the workflow stores a new file. The DX_Add_Document_To_Event transformation saves the file as a new document reference in B2B Data Exchange and attaches the file to the event. You can set this port or set the DXData and DXDataByReference ports. If this port and the DXData and DXDataByReference ports are not set, the transformation creates an empty document and adds it to the event.
DXTemporaryFilePath
string
Input/Output Ports
The DX_Add_Document_To_Event transformation has the following input/output ports:
Port DXEventId DXData Type string string binary text Description ID of the event to which a document will be attached. Required. Document to attach to the event. This port can contain the data of the document or a reference to the document. If this port is null, the transformation creates an empty document and adds the document to the event. To attach a document with text data, set the datatype of the port to string or text. To attach a document with binary data, change the datatype of the port to binary. Indicates whether the DXData port contains the document data or a document reference. If the value is true, the DXData port contains a document reference. If the value is null or the value is false, the DXData port contains the document data. ID of the document to attach to the event. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.
DXDataByReference
string
DXDocumentId DXErrorMessage DXErrorCode
string string string
DX_Add_Document_To_Event
11
Data Exchange Properties

You can configure the following Data Exchange properties in the DX_Add_Document_To_Event transformation:
Property Description Document Role Description Description of the document to attach to the event. Role of the document when it is attached to an event. Indicates how the document is used in the event. Select one of the following roles: - SOURCE. The document is attached to an event as a source document. When you view the event on the B2B Data Exchange Operation Console, you can view the attached document in the section labeled Source Data. - TARGET. The document is attached to an event as a target document. When you view the event on the B2B Data Exchange Operation Console, you can view the attached document in the section labeled Target Data. - LOG. The document is attached to an event as a log document. When you view the event on the B2B Data Exchange Operation Console, you can view the attached document in the section labeled Logging Information. Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
Generate an error in case a failure occurs in this transformation
DX_Aggregate
This transformation groups segments of data together for processing. For example, you previously split a large document so the workflow processes it in row sets. You can use the DX_Aggregate transformation to aggregate the row sets back into a single document to send to a partner. The data going into the DX_Aggregate transformation must be sorted by the DXParentEventId and DXGroupByKey ports. The transformation groups rows by the DXParentEventId and DXGroupByKey ports. The DX_Aggregate transformation is an active transformation. The DX_Aggregate transformation groups rows in the following manner: 1. 2. 3. 4. 5. 6. When the transformation reads the first row in the group, it creates a temporary file and writes the content of the DXData port to the file. On each subsequent row, the transformation appends the DXDelimiter and the content of the DXData port to the file. Then it increments the number of rows in the DXRowCount port. When the transformation reads the last row in the group, it closes the temporary file and increments the number of groups in the DXGroupSequence port. Then it passes the output to the pipeline. If the DXData port for a row is null, the transformation does not pass the row to the pipeline. The DX_Aggregate transformation drops rows that contain null values in the DXData port. It does not pass them out to the pipeline. For pass-through ports, the transformation sends the value from the last row of the group to the pipeline. It does not pass error and null rows to the pipeline.
The DX_Aggregate transformation uses indicators to determine the end of the group. If the following indicators are true, the transformation has reached the end of the data to aggregate:
End of data.
12
The value of the DXParentEventID port differs from the value in the previous row. The value of the DXGroupByKey port differs from the value in the previous row. The row count for the group has reached the value in the DXMaxRowsInGroup port. The value in the DXLastInGroup port is true.
Input Ports
The DX_Aggregate transformation has the following input ports:
Port DXParentEventId Type string Description ID of the parent event associated with the data. This is the primary GROUP BY key. Used with the parent event ID to group rows. Delimiter string to add between segments of data that indicates the end of a segment and the start of another segment. Data segment to aggregate. This port can contain the data segment or a document reference.
DXGroupByKey DXDelimiter
string string
DXData
string binary text string
DXDataByReference
Indicates whether the DXData port contains data or a document reference. If the value is true, the DXData port contains a document reference. If the value is null or the value is false, the DXData port contains data. Indicates that the row is the last row in a group. Indicates the maximum number of rows in a group.
DXLastInGroup DXMaxRowsInGroup
string integer
Input/Output Ports
The DX_Aggregate transformation has the following input/output ports:
Port DXGroupSequence Type integer Description Number of groups the transformation has processed since the Integration Service was started. The transformation increments the value of this port every time a group is processed. When the Integration Service starts, the value is set to zero. Number of rows successfully processed and added to the group. Path and file name for the temporary file where the transformation stores the grouped data. You can use this temporary file in subsequent transformations to create a B2B Data Exchange document. Number of rows that generated errors and were not added to the group.
DXRowCount DXTemporaryFilePath
integer string
DXErrorCount
integer
DX_Aggregate
13
Port DXErrorMessage DXErrorCode
Type string string
Description Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.

You can configure the following Data Exchange properties in the DX_Aggregate transformation:
Property Generate an error in case a failure occurs in this transformation Description Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
DX_Complete_Correlation
This transformation completes the correlation for an event. The transformation requires the correlation ID generated when you used the DX_Initiate_Correlation transformation to initiate the correlation.
Input Ports
The DX_Complete_Correlation transformation has the following input ports:
Port DXCorrelationId Type string Description Required. ID of the correlation to complete.
Input/Output Ports
Port DXEventId DXErrorMessage DXErrorCode Type string string string Description Required. ID of the event that completes the correlation. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.
14

You can configure the following Data Exchange properties in the DX_Complete_Correlation transformation:
Property Generate an error if the reconciliation ID does not exist Generate an error in case a failure occurs in this transformation Description Indicates whether to generate an error if the correlation ID does not exist. Default is true.
Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
DX_Create_Event
This transformation creates an event in the Data Exchange repository and set the properties of the event.
Input Ports
The DX_Create_Event transformation has the following input ports:
Port DXParentEventId Type string Description ID of parent event. If the DXParentEventId port is not null, the transformation creates a child event of the DXParentEventId event. If the DXParentEventId port is null, the transformation creates a root event. Name of the partner associated with the new event. Optional if the account number is unique across all partners or if the DXProfileId port is not null. ID of the profile associated with the new event. Optional if you use the application and partner name or account number to identify the profile. If the profile ID is not null, the transformation associates the profile ID with the event created by the transformation. If the profile ID is null, the transformation uses the DXApplication, DXAccountNumber, and DXPartnerName ports to determine the profile ID to associate with the event created by the transformation. Name of the application associated with the event. Required if the DXProfileId port is null. Account number associated with the event. Optional if the DXProfileId port is not null. Subject of the event to create. Can be up to 255 bytes long. Status of the event to create. If the value is not null, the transformation sets the status for the event. Type of the event to create.
DXPartnerName
string
DXProfileId
string
DXApplication
string
DXAccountNumber
string
DXSubject DXStatusName
string string
DXTypeName
string
DX_Create_Event
15
Input/Output Ports
The DX_Create_Event transformation has the following input/output ports:
Port DXNewEventId DXErrorMessage DXErrorCode Type string string string Description Event ID for the generated event. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.

You can configure the following Data Exchange properties in the DX_Create_Event transformation:
Property Event Status Event Type Event Subject Create root event Description Status of the event to create. Type of the event to create. Subject of the event to create. Indicates whether to create a root event. If true, the transformation creates a root event. If false, the transformation creates a child event of the DXParentEventId. Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
DX_Event_Attribute
You use the DX_Event_Attribute transformation to get or set event attribute values. To use this transformation, you must first configure an event attribute in the Operation Console, then use this transformation to set or get its value. You can add ports to DX_Event_Attribute that represent the event attributes you want to get or set. The port name must match the event attribute name exactly. If you set a value for the port, the transformation sets the event attribute to this value. If the port is value is Null, then DX_Event_Attribute gets (retrieves) the value of the event attribute. Note: The DXValue port, DXAttributeKey, and Event attribute name properties, used in pervious versions of B2B Data Exchange, are optional. Use the <attribute> port instead.
16
Input/Output Ports
The DX_Event_Attribute transformation has the following input/output ports:
Port DXEventId <Attribute> port Type string string Description ID of the event associated with the attribute to get or update. Represents an event attribute. The port name must match the event attribute name. The developer can define multiple attribute ports. If the port value is not null, the transformation sets the event attribute to this value. If the port value is null, the transformation gets the value of the event attribute. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.
DXErrorMessage DXErrorCode
string string

You can configure the following Data Exchange properties in the DX_Event_Attribute transformation:
Property Event attribute name Description Event attribute to update. The property must be configured in the B2B Data Exchange Operation Console. If the value is null, the transformation generates an error. Note: This property is optional. It is recommended that you use the <Attribute> port instead. This property is retained for backward compatibility. Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
DX_Event_Details
This transformation gets or sets multiple properties of an event. The ports represent the properties of an event. The transformation sets the property of the event with the value passed to the transformation through an input port. The transformation passes the value of the property through an output port.
DX_Event_Details
17
Input/Output Ports
The DX_Event_Details transformation has the following input/output ports:
Port DXStatusName Type string Description Status of the event. Note: The DXStatusName property provides progress information on the various steps that the event passed through during its "journey" through the B2B Data Exchange processing cycle. B2B Data Exchange sets event status to "Transferring" when writing a message to a target. Status is changed to "Complete" or "Error", depending on whether the transfer was successful, or not. If you want B2B Data Exchange to use a different status other than "Complete", use the DXStatusName in the JMS Target definition property to change it. ID of the event associated with the properties to get or update. Type of the event. Subject of the event. Number of child events associated with the event. ID of the parent event for this event. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.
DXEventId DXTypeName DXSubject DXChildCount DXParentEventId DXErrorMessage DXErrorCode
string string string double string string string

You can configure the following Data Exchange properties in the DX_Event_Details transformation:
Property Event Status Event Type Event Subject Description Status of the event. Type of the event. Subject of the event. Note: B2B Data Exchange creates events with the default value of Event Subject "in progress". We recommend that you change this property to a more meaningful value. You can use the DX_Event_Details transformation to update the Event Subject value. Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
DX_Generate_Temporary_File
This transformation gets the path and file name for a document in the Data Exchange document store.
18 Chapter 2: B2B Data Exchange Transformations
This transformation generates a unique file name in a temporary directory in the B2B Data Exchange document store. The transformation does not create a file. For example, you use an Unstructured Data transformation to write data to a temporary file. You can use this transformation to generate a file name for a file in the Data Exchange document store and write the data from the Unstructured Data transformation.
Input/Output Ports
The DX_Generate_Temporary_File transformation has the following input/output ports:
Port DXEventId DXTemporaryFilePath DXErrorMessage DXErrorCode Type string string string string Description ID of the event to associate with the generated file path. Path and file name of the temporary file. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.

You can configure the following Data Exchange properties in the DX_Generate_Temporary_File transformation:
DX_Get_Document_File_Path
This transformation determines the path and file name of a document based on a document reference.
Input Ports
The DX_Get_Document_File_Path transformation has the following input ports:
Port DXDocumentReference Type string Description Document reference to a document stored in a file in B2B Data Exchange document store.
DX_Get_Document_File_Path
19
Input/Output Ports
The DX_Get_Document_File_Path transformation has the following input/output ports:
Port DXEventId Type string Description Event associated with the document reference. Optional. If the value is not null, the transformation logs the event ID for tracking. Path and file name of the document identified by a document reference. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.
DXDocumentFilePath DXErrorMessage DXErrorCode
string string string

You can configure the following Data Exchange properties in the DX_Get_Document_File_Path transformation:
DX_Increment_Profile_Parameter
This transformation increments the value of a parameter associated with a profile. The parameter to be incremented must be numeric.
Input Ports
The DX_Increment_Profile_Parameter transformation has the following input ports:
Port DXApplication DXPartnerName Type string string Description Application associated with the profile. Required if the DXProfileId port is null. Name of the partner associated with the profile. Optional if the DXProfileId port is not null. Account number associated with the profile. Optional if the DXProfileId port is not null.
DXAccountNumber
string
20
Input/Output Ports
The DX_Increment_Profile_Parameter transformation has the following input/output ports:
Port DXProfileId DXValue DXErrorMessage DXErrorCode Type string string string string Description ID of the profile associated with the parameter to increment. Value by which to increment the parameter. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.

You can configure the following Data Exchange properties in the DX_Increment_Profile_Parameter transformation:
Property Profile parameter name Generate an error in case a failure occurs in this transformation Description Name of the profile parameter to increment. Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
DX_Initiate_Correlation
This transformation initiates a reconciliation for an event. Use this transformation in a workflow that processes a document that requires reconciliation. When a reconciliation is initiated, it needs to be completed. In a workflow, use the DX_Initiate_Correlation transformation to initiate a reconciliation. In another workflow, use the DX_Complete_Correlation transformation to complete the reconciliation. For more information, see Initiating and Completing an Event Reconciliation on page 28.
Input Ports
The DX_Initiate_Correlation transformation has the following input ports:
Port DXCorrelationType Type string Description Description of the type of correlation to initiate. Optional. The description can be a maximum of 255 bytes. The correlation type does not need to be defined in B2B Data Exchange. ID of the correlation to be initiated. Required. The time interval in seconds within which the correlation must be completed.
DXCorrelationId DXTimeWindow
string integer
DX_Initiate_Correlation
21
Input/Output Ports
The DX_Initiate_Correlation transformation has the following input/output ports:
Port DXEventId DXErrorMessage DXErrorCode Type string string string Description ID of the event associated with the correlation to be initiated. Required. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.

You can configure the following Data Exchange properties in the DX_Initiate_Correlation transformation:
Property Generate an error if the reconciliation ID already exists Generate an error in case a failure occurs in this transformation Description Generate error if the event is already associated with a correlation ID. Default is true.
Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
DX_Profile_Parameters
You can use this transformation to get the parameter values defined for a profile.
Input/Output Ports
The DX_Get_Profile_Parameters transformation has the following input/output ports:
Port DXProfileID DXEventId Type string string Description Profile Id. Mandatory port. Event Id EventId is optional. It is possible to provide EventId together with ProfileId. If EventId is provided, it looks up the parameter values from the Event Context. In case of excepitons, the associated event status will be set to Error.
22
Port DXParametersXML
Type string
Description Contains all the parameters defined for the profile, wrapped in an XML string that holds the parameter names and values. Each required parameter should have a port. In case of a value that represets multi-selection, it will be represented as a string containing a semicolon separated list of values.
<parameters> <parameter name="" isnull={true/false}" isdefault="{true/false}"> ...CDATA value... </parameter>
Note: B2B Data Exchange generates the XML only if the output port is connected.
<Parameter>port
string When a developer imports the PowerCenter workflow (or mapping) files into B2B Data Exchange. B2B Data Exchange parses all occurrences of DX_Profile_Parameters transformations. All the ports in these transformations that are not B2B Data Exchange built-in ports (for example, eventId, profileId, and so on) will be populated as profile parameters. Note: Ports are identified by name. Ports with the same name are treated as a single parameter. If a parameter port does not match a defined parameter, B2B Data Exchange logs a debug message. All <parameter> ports are strings. You can change types in the B2B Data Exchange Operation Console using the Form Designer. Boolean: {true | false} (case insensitive). Multi-selection: semicolon (;) separated list of strings Date format: MM/DD/YYYY HH24:MI:SS.US. See PowerCenter Dates appendix.
string string
Error message generated by the transformation. Error code generaed by the transformation. If the tgransformation fails, the alue of the DXError post is greater than zero.
DX_Release_Delayed_Events
This transformation releases the events delayed by a specific profile. Generally speaking, delayed events are released according to defined release rules. DX_Release_Delayed_Events overrides the release rules.
Input Ports
The DX_Release_Delayed_Events transformation has the following input ports:
Port DXProfileId Type string Description ID of the profile associated with the delayed processing rule used to determine which events to release. EventId to release. Comma-separated list for multiple events.
EventId list
string
DX_Release_Delayed_Events
23
Input/Output Ports
The DX_Release_Delayed_Events transformation has the following input/output ports:
Port DXErrorMessage DXErrorCode Type string string Description Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.

You can configure the following Data Exchange properties in the DX_Release_Delayed_Events transformation:
Property Release events without checking the delayed processing rules Description Release the event even if it is not within the scope of a delayed processing rule. If true, the transformation releases the event even if it is not within the scope of any delayed processing rule. If false, the transformation releases the event based on the delayed processing rules. Default is false. Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
DX_Resolve_Profile
This transformation determines the profile ID based on an application and a partner or account number. This transformation returns an error if the combination of an application and a partner or account number is not associated with any profile.
Input Ports
The DX_Resolve_Profile transformation has the following input ports:
Port DXApplication DXPartnerName DXAccountNumber Type string string string Description Application associated with the profile. Name of the partner associated with the profile. Required. Account number associated with the profile. Required if you use account numbers for partners.
24
Input/Output Ports
The DX_Resolve_Profile transformation has the following input/output ports:
Port DXProfileId Type string Description ID of the profile associated with the application and partner or account number. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.
string string

You can configure the following Data Exchange properties in the DX_Resolve_Profile transformation:
DX_Throw_Error
This transformation handles errors in the workflow. It generates an error when the transformation fails. It performs the following tasks:
Sets the status of the associated event to ERROR. Creates the error message from value of the DXDescription port. Attaches the error message to the associated event. Logs the error in the session log.
Input Ports
The DX_Throw_Error transformation has the following input ports:
Port DXDescription Type string Description Description of the error. This is the error message added to the session log. This is also used as the description for the log document attached to the event. Type of the error event. Optional. Alphanumeric value to associate with the event. Any value is valid. MIME type of the document to attach to the event.
DXMessageType
string
DXMIMEType
string
DX_Throw_Error
25
Input/Output Ports
The DX_Throw_Error transformation has the following input/output ports:
Port DXEventId DXData Type string string binary text Description ID of the event associated with the error. Log document to attach to the event. This port can contain the data of the document or a file path to the document. If the value of the parameter is null, the transformation creates an empty document and adds the document to the event. To attach a document with text data, set the datatype of the port to string or text. To attach a document with binary data, change the datatype of the port to binary. Indicates whether the DXData port contains the document data or a document reference. If the value is true, the DXData port contains a document reference. If the value is null or the value is false, the DXData port contains the document data. Error message generated by the transformation. Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.
DXDataByReference
string
string string

You can configure the following Data Exchange properties in the DX_Throw_Error transformation:
Property Error log document description Message type Generate an error in case a failure occurs in this transformation Description Description for the error log document that this transformation attaches to the event. Alphanumeric value to associate with the event. Any value is valid. Indicates whether to set the status of the event to ERROR when the transformation generates an error. Default is true.
26
CHAPTER 3
Creating Workflows for Event Reconciliation

Overview of Event Reconciliation, 27 Initiating and Completing an Event Reconciliation, 28 Reconciliation Status, 29
Overview of Event Reconciliation

Reconciliation is the process of correlating an event with another event. For example, you send a document file to a partner containing transactions such as payments or orders that require acknowledgment. When you send the file to the partner, you initiate a reconciliation. When you receive an acknowledgment from the partner, you complete the reconciliation. B2B Data Exchange uses a correlation ID to identify each reconciliation. One document can require multiple acknowledgments. For example, you send a partner an EDI document containing 10 purchase orders. Depending on the business requirements, you can require one acknowledgment for ten purchase orders, or one acknowledgment for each of the ten purchase orders. If you require one acknowledgment, you initiate one reconciliation. If you require ten acknowledgments, you must initiate ten reconciliations. Use PowerCenter workflows to reconcile events. Event reconciliation typically involves two workflows. One workflow processes the event that requires reconciliation and initiates the reconciliation. The second workflow processes the acknowledgment received from the partner and completes the reconciliation. The reconciliation process uses the correlation ID to associate a document with the acknowledgment. The reconciliation process involves the following steps: 1. 2. B2B Data Exchange receives a document file that requires an acknowledgment and sends it to PowerCenter for processing. The workflow designed to process the document initiates a reconciliation. If the document requires multiple acknowledgments, the workflow initiates multiple reconciliations. 3. 4. 5. 6. B2B Data Exchange sets the status for each reconciliation and sets the reconciliation status for the associated event. B2B Data Exchange receives an acknowledgment document and sends it to PowerCenter for processing. The workflow designed to process the acknowledgment determines if the document completes a reconciliation. B2B Data Exchange updates the reconciliation status.
27
Initiating and Completing an Event Reconciliation

You can use the following transformations to initiate and complete reconciliations in PowerCenter:
DX_Initiate_Correlation. Initiates a reconciliation for an event. When you create the workflow to process a
document that requires reconciliation, use this transformation to initiate the reconciliation.
DX_Complete_Correlation. Completes the reconciliation for an event. In the workflow to process the
acknowledgment document, use this transformation to complete the reconciliation. This transformation requires the correlation ID defined by the workflow that initiates the reconciliation. The B2B Data Exchange API also provides methods to initiate and complete a reconciliation. In the workflow to process a document that requires an acknowledgment, call the initiateCorrelation method to initiate a reconciliation. In the workflow to process the acknowledgment document, call the completeCorrelation method to complete the reconciliation. You must set a time limit within which the acknowledgment must be received. The Data Exchange Server sets the reconciliation status to indicate whether the acknowledgment was processed within the time limit. You can create a reconciliation monitor for the Data Exchange Server to set the status and to notify you when a reconciliation does not complete or completes after the time limit. For more information, see B2B Data Exchange Operator Guide.
Initiating an Event Reconciliation

In the workflow to process a document that requires an acknowledgement, include the DX_Initiate_Correlation transformation to initiate a reconciliation. The DX_Initiate_Correlation transformation associates the reconciliation with an event ID and generates a correlation ID. It also sets the timeout window for the reconciliation to complete. For more information, see DX_Initiate_Correlation on page 21. You can also call the initiateCorrelation method of the B2B Data Exchange API to initiate the reconciliation. The following example code shows how to call the initiateCorrelation method:
String openingEventId = this.eventid; String correlationId = doc.senderid + doc.receiverid + doc.transaction[i].id; String correlationType = 997; long timeWindowSeconds = 60*10; // 10 minutes server.initiateCorrelation (openingEventId, correlationId, correlationType, timeWindowSeconds);
Completing an Event Reconciliation

In the workflow that processes an acknowledgment document, include the DX_Complete_Correlation transformation to complete a reconciliation. The DX_Complete_Correlation transformation correlates the acknowledgment with the original document based on the correlation ID and completes the reconciliation. For more information, see DX_Complete_Correlation on page 14. You can also call the completeCorrelation method of the B2B Data Exchange API to complete the reconciliation. The following example code shows how to call the completeCorrelation method:
String closingEventId = this.eventid; String correlationId = doc.receiverid + doc.senderid + doc.acknowledgment[i].transactionid; String openingEventId = server.completeCorrelation (closingEventId, correlationId);
28
Chapter 3: Creating Workflows for Event Reconciliation
Reconciliation Status
A reconciliation can have one of the following statuses:
Pending reconciliation. No acknowledgment is received for a document and the timeout limit is not reached.
When you initiate a reconciliation, the Data Exchange Server sets the reconciliation status to Pending reconciliation. When you change the timeout interval, the Data Exchange Server can reset the reconciliation status to Pending reconciliation.
Timed out. Time limit for acknowledgment is reached and no acknowledgment is processed for the document. Reconciled after timeout. acknowledgment for the document is processed after the time limit. When you
complete a reconciliation after the time limit, the Data Exchange Server sets the reconciliation status to Reconciled after timeout.
Reconciliation complete. acknowledgment for the document is processed within the time limit. When you
complete a reconciliation, the Data Exchange Server sets the reconciliation status to reconciliation complete. You can also manually set the reconciliation status to Reconciliation Complete on the Operation Console. The following diagram shows the process that the Data Exchange Server follows to set the reconciliation status:
When an event has multiple reconciliations, the Data Exchange Server sets the reconciliation status of the event based on the status of all reconciliations associated with the event and its child events. The reconciliation status of the event is equivalent to the status of the reconciliation that is furthest from completion or requires operator action.
Reconciliation Status
29
B2B Data Exchange ranks the reconciliation statuses in the following order: 1. Timed out. One or more of the reconciliations associated with the event and its child events have not received an acknowledgment within the time limit. This status can indicate a problem with the acknowledgment and require immediate operator action. Pending reconciliation. All reconciliations associated with the event and its child events have been initiated but no reconciliation has completed or timed out. Reconciled after timeout. All reconciliations associated with the event and its child events have completed but one or more of the reconciliations completed after the timeout This status can indicate a problem with the acknowledgment process and require operator action. Reconciliation complete. All reconciliations associated with the event and its child events are complete. This status indicates that the event reconciliation process worked as expected.
2. 3.
4.
The reconciliation status of the event is equivalent to the highest ranked status of any of the reconciliations associated with the event and its child events. The following table shows examples of the event reconciliation status based on the status of the reconciliations associated with the event:
Event Status of the Reconciliations Associated with an Event Reconciliation Status of the Event Pending reconciliation
Event 01
Child event 101 Reconciliation 001: Pending reconciliation Reconciliation 002: Reconciliation complete Reconciliation 003: Pending reconciliation Child event 102 Reconciliation 011: Reconciliation complete Reconciliation 012: Reconciled after timeout Reconciliation 013: Reconciliation complete
Event 02
Child event 201 Reconciliation 021: Reconciliation complete Reconciliation 022: Pending reconciliation Reconciliation 023: Reconciled after timeout Reconciliation 024: Pending reconciliation Child event 202 Reconciliation 031: Timed out Reconciliation 032: Reconciled after timeout
Timed out
Event 03
Reconciliation 041 Reconciliation complete Reconciliation 042: Reconciled after timeout
Reconciled after timeout
30
Chapter 3: Creating Workflows for Event Reconciliation
CHAPTER 4
Forms Designer
Overview of the Forms Designer , 31 Using the Forms Designer, 32 Creating a Dependency between Fields, 34
Overview of the Forms Designer

The Forms Designer is a tool that developers and administrators can use to design the user interface of forms for various Operations Console screens that need to have a dynamic interface. These screens include:
Partner > Additional Information Partner > Account > Additional Information Profile > Workflow Parameters
You use the Forms Designer to arrange the screen layout, and to configure the individual fields. The Forms Designer lets you set up the following form properties:
Labels Descriptions Mandatory flags Read-only flags Parameter types Parameter representations Default values Valid values Relationships between fields User interface screen groups, such as tabs, columns, and headings
In the next section, Using the Forms Designer, we present a instructions for using the tool.
31
Using the Forms Designer

To use the Forms Designer: 1. In the Navigator, click Partner Management > Workflows. Click the edit icon for the workflow you want to edit. B2B Data Exchange displays the Update Workflow screen. 2. Click Workflow Parameters. A list of workflow parameters displays. These are the workflows that were imported from the PowerCenter workflow 3. Click Designer. The Forms Designer opens.
The following table explains the actions you can take on this screen:
Button Edit Create Tab Create Column Description Allows editing the properties of an element. Creates a tab. A tab is a group of elements contained in a screen tab. Creates a column. A column is a group of elements that you can display beside another column, across the width of the form you are designing. Creates a header element. A header allows you to create a header above a group of parameters Create a disclosure group. A disclosure group is a group of parameters that the operator can display or hide by clicking the name of the group. Deletes a group. The elements in the deleted group remain in the workflow. Move elements from one group (tab, column, header, or disclosure) to another.
Create Header
Create Disclosure
Delete Group Move to Group
The screen contains a grid display of the workflow elements. The following table describes the grid columns:
Attribute Id Label Type Representation Description The unique identifier of the element. The label of the element, as it appears in the form. The data type of the element, such as text or date. The representation of the element in the form, for example, entry field, radio button, or drop-down list.
32
Chapter 4: Forms Designer
Attribute Mandatory Read-Only Depends On
Description If selected, the element is mandatory. If selected, the element is read-only. If the element depends upon another element, the name of the other element appears here.
4.
Define the properties of each element, as described in the following table:

Attribute Label Description Mandatory Yes No Description Name of the parameter in the form. Short description of the parameter. The description appears as a tool tip. Select if the parameter is mandatory in the form, forcing the operator to enter a value. Select if the parameter is read only in the form. Read only parameters require a default value. Hides a parameter from the Operator. Used for workflow parameters that are not available for Operator edit. Data type of the parameter. Select from the list. The parameter's representation in the form. Select from the list. Initial value of the parameter in the form. A list of valid values for the parameter. Minimum value. Applies to numbers and string fields/types. If the field is a string, the attribute specifies the minmum length. Maximum value. Applies to numbers and string fields/types. If the field is a string, the attribute specifies the maximum length. For more information on enable/disable conditions, see Creating a Dependency between Fields on page 34
Mandatory
No
Read Only
No
Hidden
No
Type Representation Default Value Values Minimum
No No No No No
Maximum
No
Enable/disable condition
No
Using the Forms Designer
33
5.
To create a tab on the form: a. Click Actions> Create Tab. Enter the tab properties and click OK. The tab properties are:
Attribute Label Type Enable/Disable Condition Mandatory Yes Yes No Description The tab's label as it appears in the form. Tab. Allows you to enable or disable all the fields in the tab based on the value of another parameter in the form. To enable or disable a group, select the checkbox and fill in the parameters defining the enable/disable condition. For more information on enable/disable conditions, see Creating a Dependency between Fields on page 34
The tab appears in the workflow elements grid. b. 6. Drag and drop the elements that should appear in the tab to the new tab element.
To arrange elements in a column, click Actions > Create Column and enter the properties for the column. Click Enter. Drag and drop the parameters to the new column. Create two or more columns to display them side by side. The column element appears in the element grid.
7. 8. 9.
To create a header, click Actions > Create Header. Enter the header text in the Label field. Drag and drop the elements that should appear under the Header. To create a disclosure group, click Actions > Create Disclosure. Enter a label for the disclosure and drag and drop elements to it. Define the enabled/disabled condition if required. Click Save to save the workflow and the form.
The following screen image shows the final design of the Workflow Parameters screen:
Creating a Dependency between Fields

The purpose of a dependency is to enable or disable one field or group of fields, conditioned on the value of another field. For example, you might have a field that you want to display only if the value of the Choice Property field is "yes". You can define a condition between two parameters, two groups, or a parameter and a group. 1. From the list of parameters, select the parameter or group that you want to enable or disable. B2B Data Exchange highlights the selected parameter.
34
Chapter 4: Forms Designer
2. 3. 4. 5. 6.
Check the "This group/parameter should be" checkbox. Select "enabled" or "disabled" from the list. Select "when" from the list. Select "specific" or "any". If you chose specific in the preceding step, fill in the specific value. The following figure illustrates the complete expression definition:
Creating a Dependency between Fields
35
CHAPTER 5
Configuring Email for Monitor Notification

Overview of Email for Monitor Notification, 36 The Built-in Email Notification Message Format, 36 Configuring the Email Notifications, 37
Overview of Email for Monitor Notification

B2B Data Exchange generates events as it processes documents. Managing objects in the Operation Console also creates events, called logging events. Operators can track events by using event monitors. An event monitor can be created to track events for different profiles or to track different types of events. The creator of an event monitor can specify email notification when the monitor detects an event. For more information about event monitors, see the B2B Data Exchange Operator Guide. B2B Data Exchange provides a built-in email notification message format. The developer can modify this format by setting certain system and event properties as explained below. The user can even provide his own email message format.
The Built-in Email Notification Message Format

The built-in format of the email notification message that monitors send is shown below. The message contains the following information:
General information. The message includes details such as the monitor that sent the message, partner and
account details, and a link to the event. If you are logged on to the B2B Data Exchange console, clicking on the link displays event details.
Log details. The message includes a list of all log entries for this event, including document attachments. Reconciliation details. acknowledgment details received from the partner for this event.
36
You can use the built-in email format for event notifications, or you can customize it, as explained below.
Configuring the Email Notifications

You can customize individual e-mail properties by using the system properties and event properties described below. You can completely customize the body of the email message. For more information, see Configuring the Body of an Email Notification on page 38.
Configuring Email Notifications Using System Properties

Use the dx_email_from_field system property to customize the email notification that monitors send. For more information, see the B2B Data Exchange Administrator Guide.
Configuring Email Notifications Using Event Properties

The following table defines the event properties that can be used to modify built-in email notification messages. Use the DX_EVENT_ATTRIBUTE transformation to set the attributes for an event.
Event Property dx_email_bcc_field Description A comma-separated list of recipient email addresses. These recipients are added to the addressees defined in the monitor. The path to the file containing the custom body of the email. This file replaces the text of the body of the built-in email. For more information, see Configuring the Body of an Email Notification on page 38. A character string that is used to replace the body text of the built-in email. Maximum length is 255 characters.
dx_email_body_file
dx_email_body_field
Configuring the Email Notifications
37
Event Property dx_email_from_field dx_email_cc_field
Description This string becomes the "from field" of the email. A comma-separated list of recipient email addresses. These recipients are added to the addressees defined in the monitor. Default is "text/html"; charset=UTF-8. For more information about mime types, see http://www.mimetype.org. For more information about character sets, see http://en.wikipedia.org/wiki/Character set. Subject field of the email. A comma-separated list of recipient email addresses. These recipients are added to the list of addressees defined in the monitor.
dx_email_mimetype
dx_email_subject_field dx_email_to_field
Configuring the Body of an Email Notification

There are two ways to customize the body of an email notification:
Provide a text or HTML file that contains the body of the customized email. Assign the path of this file to
the dx_email_body_file event property. This file must be accessible to all Data Exchange Server instances.
Provide a text string that will replace the built-in body text. Assign this string to the dx_email_text event
property. The customized body of an email message can contain variables that are set during runtime, when the email notification is created. The following variables are built-in:
Variable $DXMonitorName $DXPartnerInfo Description The name of the monitor. Partner name, account name, and account number.
You can use event attributes in the customized body of an email. For example, you can define an event attribute called MyAttribute and embed it in the body of an email as $MyAttribute, meaning the value of the attribute MyAttribute. The developer assigns a value to MyAttribute using the DX_Event_Attribute transformation.
38
Chapter 5: Configuring Email for Monitor Notification
APPENDIX A
B2B Data Exchange API

This appendix includes the following topics:
Overview of B2B Data Exchange API, 39 API Reference, 40
Overview of B2B Data Exchange API

You can use the B2B Data Exchange API to access the B2B Data Exchange processes and repository. When you develop workflows in PowerCenter, you can use the B2B Data Exchange transformations to process B2B Data Exchange documents. The transformations call the B2B Data Exchange API methods to process the documents. You can create additional transformations and use the methods in the B2B Data Exchange API to define the transformation behavior. You can also call the API methods from other processes or applications based on your document processing requirements. The B2B Data Exchange API is contained in the following interface:
com.informatica.b2b.dx.client.DXClient
All B2B Data Exchange API methods that create a database transaction commit the transaction. For more information about the B2B Data Exchange API methods, see the online API reference:
<DXInstallationDir>\powercenter\javadoc\apidocs\com\informatica\b2b\dx\client\DXClient901.html
B2B Data Exchange API Versions

B2B Data Exchange 9.0.1 provides a new version of the B2B Data Exchange API. To use the new version of the B2B Data Exchange API, include the following line of code in your client application code:
DXClient dxClient = DXClientFactory.getClient(DXClientTypes.POWERCENTER_CLIENT);
Then, use the DXClient object when you call an API method. For example:
dxClient.flowEntry(profileId, reuseEventId);
By default, the DXClientFactory returns the latest version of the B2B Data Exchange API. To use the previous version of the API, you can perform one of the following tasks:
Modify your client code. Use the following lines of code in your client application code: DXClient861 dxClient = (DXClient861) DXClientFactory.getClient(DXClientTypes.POWERCENTER_CLIENT); Add the API 8.6.1 jar file to the Java SDK Classpath of the Integration Service. In the PowerCenter
Administration Console, edit the Integration Service that runs the Data Exchange workflows. Add the following jar file before all the other jar files in the Java SDK Classpath:
<DataExchangeInstallationDir>/powercenter/lib/dx-iface-api-8.6.1-9.0.1.jar;
39
For more information about the methods in the previous version of the B2B Data ExchangeAPI, see the online API reference:
<DXInstallationDIR>\powercener\javadoc\apidocs\com\informatica\b2b\dx\client\DXClient861.html
The online reference for B2B Data Exchange API 8.6.1 contains information about how to upgrade your code to use B2B Data Exchange API 9.0.1.
API Reference
The following table lists the methods available in the B2B Data Exchange API:
Method addEventDocument ( String eventId, Document document ) completeCorrelation ( String eventId, String correlationId ) completeCorrelations ( String eventId ) createChildEvent ( String parentEventId, String profileId ) createChildEvent ( String parentEventId, String profileId, String eventStatusName, String eventTypeName, String subject ) createDocument ( String temporaryFilePath, String eventId ) flowEntry ( String profileId ) flowEntry ( String profileId, String reuseEventId ) flowExit ( String eventId ) Return Value String Description Attaches a document to an event and returns the document ID for the document attached to the event.
String
Completes a reconciliation process and returns the ID of the event that initiated the reconciliation process.
void
Closes all correlation events of the specified event Id.
String
Creates a child event based on a profile ID and returns the event ID of the child event.
String
Creates a child event based on a profile ID and sets the properties of the child event. Returns the event ID of the child event.
Document
Moves a file into the B2B Data Exchange document store and returns the associated document reference.
String
Indicates the start of a workflow. This method creates an event and returns the event ID. Indicates the start of a workflow. You can specify the event ID to use.
String
String
Indicates the end of a workflow. This method updates the status of the event with the system default status and returns the event ID. Indicates the end of a workflow. This method updates the status of the event with the given status and returns the event ID.
flowExit ( String eventId, String status )
String
40
Appendix A: B2B Data Exchange API
Method generateTemporaryFilePath ( String eventId )
Return Value String
Description Creates a unique file name in the B2B Data Exchange temporary document directory and returns the path and file name. Returns the number of child events for a parent event.
getChildrenCount ( String parentEventId ) getDocumentData ( Document document, Long offset, Long count, String eventId ) getDocumentFilePath ( Document documentReference, String eventId ) getEventAttribute ( String eventId, String attributeKey ) getEventContext ( String eventId ) getEventDocuments ( String eventId ) getEventInfo ( String eventId ) getEventParentEventId ( String eventId ) getEventStatusName ( String eventId ) incrementProfileSequenceValue ( String profileId, String parameterSequenceId ) incrementProfileSequenceValue ( String profileId, String parameterSequenceId, String incrementBy ) initiateCorrelation ( String eventId, String correlationId, String correlationType, long timeWindowSeconds ) releaseDelayedEvents ( String profileId, List<String> eventIds )
Integer
byte[]
Returns the data of a document.
String
Returns the path and file name of the file associated with a document reference.
String
Returns the value of an event attribute.
Map
Returns the run-time context of an event.
List<Document>
Returns information about all documents associated with an event. Returns the information associated with an event, including event status, event type. Returns the event ID of the parent event.
Properties
String
String
Returns the status of an event.
String
Increments by one the value of a sequence parameter associated with a profile.
String
Increments by incrementBy the value of a sequence parameter associated with a profile.
void
Initiates a reconciliation process.
void
Releases delayed events.
API Reference
41
Method resolveProfileId ( String accountNumber, String application, String partnerName, String profileName ) setEventAttribute ( String eventId, String attributeKey, String attributeValue ) setEventStatus ( String eventId, String eventStatus ) setEventStatus ( String eventId, String eventStatusId, String comments ) setEventSubject ( String eventId, String subject ) setEventType ( String eventId, String eventType ) setProfileSequenceValue ( String profileId, String parameterSequenceId, Object newValue )
Return Value String
Description Returns the profile ID associated with an application and an account number or partner.
String
Sets the value of the attribute associated with an event.
void
Updates the status of an event.
void
Updates the status of an event.
void
Updates the subject of an event.
void
Updates the type of an event.
String
Assigns a value to a sequence parameter associated with a profile.
42
Appendix A: B2B Data Exchange API
INDEX
B
B2B Data Exchange PowerCenter mappings 5 PowerCenter workflows 6
C
client plug-in for PowerCenter installing Data Exchange transformations 2 connection objects Data Exchange workflows 5
DX_Generate_Temporary_File Data Exchange transformation 18 DX_Get_Document_File_Path Data Exchange transformation 19 DX_Increment_Profile_Parameter Data Exchange transformation 20 DX_Initiate_Correlation Data Exchange transformation 21 DX_Release_Delayed_Events Data Exchange transformation 23 DX_Resolve_Profile Data Exchange transformation 24 DX_Throw_Error Data Exchange transformation 25
D
Data Exchange plug-ins client plug-in for PowerCenter 2 server plug-in for PowerCenter 2 Data Exchange transformations configuring 10 DX_Add_Document_To_Event 10 DX_Aggregate 12 DX_Complete_Correlation 14 DX_Create_Event 15 DX_Event_Details 17 DX_Generate_Temporary_File 18 DX_Get_Document_File_Path 19 DX_Increment_Profile_Parameter 20 DX_Initiate_Correlation 21 DX_Release_Delayed_Events 23 DX_Resolve_Profile 24 DX_Throw_Error 25 error handling 10 guidelines 9 installing plug-ins 2, 9 Data Exchange workflows configuring real-time session 6 connection objects 5 JNDI connection 5 mapping 5 target definition 3 designer forms 32 DX_Add_Document_To_Event Data Exchange transformation 10 DX_Aggregate Data Exchange transformation 12 DX_Complete_Correlation Data Exchange transformation 14 DX_Create_Event Data Exchange transformation 15 DX_Event_Details Data Exchange transformation 17
E
email monitor notification 36 email for monitor notification configuring 36 event reconciliation overview 27
F
forms designer using 32
I
Index Term 6
J
JNDI connection Data Exchange workflows 5
M
mappings Data Exchange workflows 5 for B2B Data Exchange 5 monitor notification email 36
P
pending reconciliation reconciliation status 29
43
PowerCenter creating mappings for B2B Data Exchange 5 creating workflows for B2B Data Exchange 6 sources and targets for B2B Data Exchange 2
initiating 28
S
server plug-in for PowerCenter installing Data Exchange transformations 2
R
real-time session configuring Data Exchange workflows 6 reconciled after timeout reconciliation status 29 reconciliation complete reconciliation status 29 reconciliation status ranking 29 reconciled after timeout 29 reconciliation complete 29 reconciliation correlation 29 timed out 29 reconciliations completing 28 definition 27
T
target definition Data Exchange workflows 3 for B2B Data Exchange 3 timed out reconciliation status 29
W
workflows for B2B Data Exchange 6
44
Index

DX 901 Developer Guide en

Uploaded by

Copyright:

Available Formats

DX 901 Developer Guide en

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

DX 901 Developer Guide en

Uploaded by

Copyright:

Available Formats

Informatica B2B Data Exchange (Version 9.0.

Chapter 1: Using PowerCenter with B2B Data Exchange. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2: B2B Data Exchange Transformations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 3: Creating Workflows for Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Chapter 4: Forms Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 5: Configuring Email for Monitor Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Appendix A: B2B Data Exchange API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Informatica Web Site

Informatica How-To Library

Informatica Knowledge Base

Informatica Multimedia Knowledge Base

Informatica Global Customer Support

Standard Rate North America: +1 650 653 6332

Standard Rate India: +91 80 4112 5738

Using PowerCenter with B2B Data Exchange

Overview of Using PowerCenter with B2B Data Exchange

Step 1. Installing the B2B Data Exchange Plug-Ins

Step 2. Creating the Source and Target Definitions

Chapter 1: Using PowerCenter with B2B Data Exchange

B2B Data Exchange Properties

DXEventId DXIsEventReprocessed partnerName

Step 2. Creating the Source and Target Definitions

Add the following properties to the JMS target definition:

Target Routing Procedure

Chapter 1: Using PowerCenter with B2B Data Exchange

Step 3. Creating the Mapping

Step 4. Creating the Connection Objects

JNDI Provider URL

Step 3. Creating the Mapping

JMS Connection Factory Name

Step 5: Create the Workflow

Chapter 1: Using PowerCenter with B2B Data Exchange

Save the session object.

Step 6. Exporting the Mapping/Workflow

Updating the Workflow

Step 6. Exporting the Mapping/Workflow

B2B Data Exchange Transformations

B2B Data Exchange Transformations Overview

The following table describes the B2B Data Exchange transformations:

Installation and Registration

Guidelines for Using the Data Exchange Transformations

B2B Data Exchange Transformations Overview

Configuring Data Exchange Transformations

default values for other Data Exchange properties.

the status of the event to error.

Chapter 2: B2B Data Exchange Transformations

DXDocumentId DXErrorMessage DXErrorCode

string string string

Data Exchange Properties

Generate an error in case a failure occurs in this transformation

Chapter 2: B2B Data Exchange Transformations

string binary text string

Port DXErrorMessage DXErrorCode

Type string string

Data Exchange Properties

Chapter 2: B2B Data Exchange Transformations

Data Exchange Properties

Data Exchange Properties

Generate an error in case a failure occurs in this transformation