Informatica® B2B Data Exchange

10.5.3

Developer Guide
Informatica B2B Data Exchange Developer Guide
10.5.3
December 2022
© Copyright Informatica LLC 2001, 2023

This software and documentation are provided only under a separate license agreement containing restrictions on use and disclosure. 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 LLC.

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial
computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, duplication, disclosure, modification, and adaptation is subject to the restrictions and license terms set forth in the applicable Government contract, and, to the
extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License.

Informatica, the Informatica logo, Informatica Cloud, PowerCenter, PowerExchange, and Data Engineering Integration are trademarks or registered trademarks of
Informatica LLC in the United States and many jurisdictions throughout the world. A current list of Informatica trademarks is available on the web at https://
www.informatica.com/trademarks.html. 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. Required third party notices are included with the product.

See patents at https://www.informatica.com/legal/patents.html.

DISCLAIMER: Informatica LLC provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied
warranties of noninfringement, merchantability, or use for a particular purpose. Informatica LLC 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.

The information in this documentation is subject to change without notice. If you find any problems in this documentation, report them to us at
[email protected].

Informatica products are warranted according to the terms and conditions of the agreements under which they are provided. INFORMATICA PROVIDES THE
INFORMATION IN THIS DOCUMENT "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT.

Publication Date: 2023-01-04

Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Knowledge Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Product Availability Matrices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Informatica Velocity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Informatica Marketplace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Informatica Global Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 1: PowerCenter Mappings and Workflows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

PowerCenter Mappings and Workflows Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Sample Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Step 1. Install the B2B Data Exchange PowerCenter Plug-Ins. . . . . . . . . . . . . . . . . . . . . . . . . . 10
Server Plug-In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Client Plug-In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Step 2. Create Source and Target Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Creating the Source Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Creating the Target Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Step 3. Create the Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Step 4. Configure the JMS and JNDI Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
JNDI Connection Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
JMS Connection Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Step 5. Create the PowerCenter Workflow and Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Step 6. Export the PowerCenter Workflow and Mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Updating the Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

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

B2B Data Exchange Transformations Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Installing and Registering Transformations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Configuring Transformations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Handling Transformation Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
B2B Data Exchange Transformations Rules and Guidelines. . . . . . . . . . . . . . . . . . . . . . . . 19
DX_Add_Document_To_Event Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
DX_Aggregate Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Table of Contents 3
 B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
DX_Complete_Correlation Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
DX_Create_Event Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
DX_Event_Attribute Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
DX_Event_Details Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
DX_Generate_Temporary_File Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
DX_Get_Document_File_Path Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
DX_Increment_Profile_Parameter Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
DX_Initiate_Correlation Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
DX_Profile_Parameters Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
DX_Release_Delayed_Events Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
DX_Resolve_Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
DX_Throw_Error. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Input Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Input/Output Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
B2B Data Exchange Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Chapter 3: B2B Data Exchange Workflows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

B2B Data Exchange Workflows Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

4 Table of Contents
Managing B2B Data Exchange Workflows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
B2B Data Exchange Workflow Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Chapter 4: Creating Workflows for Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . 42

Overview of Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Initiating and Completing an Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Initiating an Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Completing an Event Reconciliation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Reconciliation Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Chapter 5: Forms Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Forms Designer Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Forms Designer User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Forms Designer Actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Element Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Group Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Customizing Workflow Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Chapter 6: Configuring Email for Monitor Notification. . . . . . . . . . . . . . . . . . . . . . . 52

Overview of Email for Monitor Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
The Built-in Email Notification Message Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuring the Email Notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Configuring Email Notifications Using System Properties. . . . . . . . . . . . . . . . . . . . . . . . . 53
Configuring Email Notifications Using Event Properties. . . . . . . . . . . . . . . . . . . . . . . . . . 53
Configuring the Body of an Email Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Chapter 7: B2B Data Exchange Web Services API. . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Data Exchange Web Services Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
DX_TPM_Partner Web Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
DX_TPM_Partner Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
DX_TPM_Partner Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
DX_TPM_Partner Create Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
DX_TPM_Partner Search Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
DX_TPM_Partner Update Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
DX_TPM_Partner Delete Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
DX_TPM_Partner Count Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
DX_TPM_Partner Get Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
DX_TPM_Account Web Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
DX_TPM_Account Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
DX_TPM_Account Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
DX_TPM_Account Create Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
DX_TPM_Account Search Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
DX_TPM_Account Update Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Table of Contents 5
 DX_TPM_Account Delete Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
DX_TPM_Account Count Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
DX_TPM_Account Get Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
DX_TPM_Profile Web Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
DX_TPM_Profile Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
DX_TPM_Profile Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
DX_TPM_Profile Create Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
DX_TPM_Profile Search Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
DX_TPM_Profile Update Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
DX_TPM_Profile Delete Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
DX_TPM_Profile Count Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
DX_TPM_Profile Get Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
DX_Endpoint Web Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
DX_Endpoint Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
DX_Endpoint Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Complex Type Objects in the Data Exchange Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . 78
DXPartner Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
DXAccount Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
DXProfile Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
DXContactInformation Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
General B2B Data Exchange Web Service Behavior. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
B2B Data Exchange Web Service Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
User Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
User Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Chapter 8: B2B Data Exchange Run-time Java API. . . . . . . . . . . . . . . . . . . . . . . . . . . 83

B2B Data Exchange Run-time Java API Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
B2B Data Exchange Run-time Java API Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
API Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Chapter 9: B2B Data Exchange Forms Designer Java API. . . . . . . . . . . . . . . . . . . . . 88

B2B Data Exchange Forms Designer Java API Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
B2B Data Exchange Forms Designer Java API Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

6 Table of Contents
Preface
Use the B2B Data Exchange Developer Guide to learn how to develop workflows in PowerCenter to process
B2B Data Exchange documents. Learn how to create workflows for event reconciliation, use Forms Designer,
and configure email for monitor notification. You can also learn about B2B Data Exchange Web services, Run-
time Java API, and Forms Designer Java API.

Informatica Resources
Informatica provides you with a range of product resources through the Informatica Network and other online
portals. Use the resources to get the most from your Informatica products and solutions and to learn from
other Informatica users and subject matter experts.

Informatica Network
The Informatica Network is the gateway to many resources, including the Informatica Knowledge Base and
Informatica Global Customer Support. To enter the Informatica Network, visit
https://network.informatica.com.

As an Informatica Network member, you have the following options:

• Search the Knowledge Base for product resources.

• View product availability information.
• Create and review your support cases.
• Find your local Informatica User Group Network and collaborate with your peers.

Informatica Knowledge Base

Use the Informatica Knowledge Base to find product resources such as how-to articles, best practices, video
tutorials, and answers to frequently asked questions.

To search the Knowledge Base, visit https://search.informatica.com. If you have questions, comments, or
ideas about the Knowledge Base, contact the Informatica Knowledge Base team at
[email protected].

Informatica Documentation
Use the Informatica Documentation Portal to explore an extensive library of documentation for current and
recent product releases. To explore the Documentation Portal, visit https://docs.informatica.com.

7
 If you have questions, comments, or ideas about the product documentation, contact the Informatica
Documentation team at [email protected].

Informatica Product Availability Matrices

Product Availability Matrices (PAMs) indicate the versions of the operating systems, databases, and types of
data sources and targets that a product release supports. You can browse the Informatica PAMs at
https://network.informatica.com/community/informatica-network/product-availability-matrices.

Informatica Velocity
Informatica Velocity is a collection of tips and best practices developed by Informatica Professional Services
and based on real-world experiences from hundreds of data management projects. Informatica Velocity
represents the collective knowledge of Informatica consultants who work with organizations around the
world to plan, develop, deploy, and maintain successful data management solutions.

You can find Informatica Velocity resources at http://velocity.informatica.com. If you have questions,
comments, or ideas about Informatica Velocity, contact Informatica Professional Services at
[email protected].

Informatica Marketplace
The Informatica Marketplace is a forum where you can find solutions that extend and enhance your
Informatica implementations. Leverage any of the hundreds of solutions from Informatica developers and
partners on the Marketplace to improve your productivity and speed up time to implementation on your
projects. You can find the Informatica Marketplace at https://marketplace.informatica.com.

Informatica Global Customer Support

You can contact a Global Support Center by telephone or through the Informatica Network.

To find your local Informatica Global Customer Support telephone number, visit the Informatica website at
the following link:
https://www.informatica.com/services-and-training/customer-success-services/contact-us.html.

To find online support resources on the Informatica Network, visit https://network.informatica.com and
select the eSupport option.

8 Preface
Chapter 1

PowerCenter Mappings and

Workflows
This chapter includes the following topics:

• PowerCenter Mappings and Workflows Overview, 9

• Step 1. Install the B2B Data Exchange PowerCenter Plug-Ins, 10
• Step 2. Create Source and Target Definitions, 10
• Step 3. Create the Mapping , 13
• Step 4. Configure the JMS and JNDI Connections, 13
• Step 5. Create the PowerCenter Workflow and Session, 15
• Step 6. Export the PowerCenter Workflow and Mapping, 16

PowerCenter Mappings and Workflows Overview

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. Install and register the Data Exchange plug-in in a PowerCenter repository.

2. Create source (JMS, flat file, Data Transformation) and target definitions.
3. Create a mapping and use the B2B Data Exchange transformations, Unstructured Data transformations,
and other PowerCenter transformations to process the documents.
4. Create the connection objects for the JMS queues.
5. Create the workflow and add the session to run the mapping.
6. Export the PowerCenter workflow, including mapping, to use as a workflow definition file in B2B Data
Exchange.

Sample Scenarios

9
Step 1. Install the B2B Data Exchange PowerCenter
Plug-Ins
Use the B2B Data Exchange installer to install the B2B Data Exchange PowerCenter server and client plug-ins.

Use the B2B Data Exchange installer to install the Data Exchange server and client plug-ins.

Server Plug-In

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. Create Source and Target Definitions

B2B Data Exchange uses JMS to send and receive documents to and from PowerCenter real-time workflows.
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.

Creating the Source Definition

In the PowerCenter Designer, create the source and define the source properties .

The source definition process includes the following steps:

1. Create the source object.

2. Add ports to the source object. Add port information as properties in the JMS Message Property
Columns tab of the source definition. By default, the port properties have the prefix Prop_.

10 Chapter 1: PowerCenter Mappings and Workflows

The following table describes the B2B Data Exchange source properties:

Property Description

accountName Name of the account for which the B2B Data Exchange server sets the port that the workflow
uses to process the event.
Note: The property value can be null if you use a global profile.

accountNumber Number of the account for which the B2B Data Exchange server sets the port that the workflow
uses to process the event. The property value must be a string.
Note: The property value can be null if you use a global profile.

application Name of the application for which the B2B Data Exchange server sets the port that the
workflow uses to process the event.

dataByReference Determines whether the JMS message that B2B Data Exchange sends to PowerCenter contains
a document reference.
Possible values:
- True. The JMS message contains a reference to a document that is stored in the B2B Data
Exchange document store.
- False. The JMS message contains the actual document data.

eventId Identifier of the associated event for the documents that the workflow processes.

isEventReprocessed Determines if the associated event is reprocessed.

partnerName Name of the partner for which the B2B Data Exchange server sets the port that the workflow
uses to process the event.
Note: The property value can be null if you use a global profile.

partnerId Identifier of the partner for which the B2B Data Exchange server sets the port that the workflow
uses to process the event.
Note: The property value can be null if you use a global profile.

profileId Identifier of the profile for which the B2B Data Exchange server sets the port that the workflow
uses to process the event.

profileName Name of the profile for which the B2B Data Exchange server sets the port that the workflow
uses to process the event.

DXSentEventId List of identifiers for the events that triggered the event monitor.
Available when a regular delivery or a batch delivery event monitor triggers the workflow.

DXMonitorId Identifier for the event monitor that triggered the workflow.
Available when a regular delivery or a batch delivery event monitor triggers the workflow.

DXMonitorName Name of the event monitor that triggered the workflow.

Available when a regular delivery or a batch delivery event monitor triggers the workflow.

DXUser Name of the user that received the monitor notification.

Available when a regular delivery event monitor triggers the workflow.

Step 2. Create Source and Target Definitions 11

 Creating the Target Definition
In the PowerCenter Designer, create the target and add ports to store properties for running the workflow.
You can also add properties to store other B2B Data Exchange values that you want to send back from
PowerCenter.

The target definition process includes the following steps:

1. Create the target object.

2. Add ports to the target object. Add the port information as properties in the JMS Message Property
Columns tab of the target definition. By default, the port properties have the prefix Prop_.

The following table describes the B2B Data Exchange target properties:

Property Description

DXDataByReference Required. Determines whether the JMS message that PowerCenter sends back to B2B Data
Exchange contains a document reference.
Possible values:
- True. The JMS message contains a reference to a document that is stored in the B2B Data
Exchange document store.
- False. The JMS message contains the actual document data.

DXEventId Identifier of the event to use in the next workflow. If you do not set the value of this property,
the B2B Data Exchange server generates a new event ID for the next workflow.

DXParentEventId Identifier of the parent event to use in the next workflow. Set the value of this property if you
want to send the JMS message to multiple targets with a child event for each target. The B2B
Data Exchange then generates a new event ID for the next workflow to use for the child events.
Note: If you do not set the value of this property and send the message to multiple targets, all
targets inherit the parent event status and you cannot track the status of each child event.

DXStatusName Name of the event status to assign to the event in B2B Data Exchangeafter a successful
processing.

endpointName Name of the endpoint to which to route the message after processing.

profileId Identifier of the profile to which to route the message after processing.

profileName Name of the profile to which to route the message after processing.

accountName Name of the account to which to route the message after processing.

partnerName Name of the partner to which to route the message after processing.

sendToAccount Determines whether to send the message to a global endpoint or to an endpoint that is
associated with an account or a partner.
Possible values:
- True. Sends the message to an endpoint that is associated with an account or a partner. If
you set this value, you must set a value for the accountName or partnerName properties.
- False. Sends the message to a global endpoint.

Target Routing Procedure

B2B Data Exchange determines the Profile or Endpoint to which send a message is sent, based on the
following rules:

1. endpointName. If the endpointName is set, the message is sent to the specified endpoint.

12 Chapter 1: PowerCenter Mappings and Workflows

 2. profileId/profileName. If the profileId or profileName is set, the message is sent to the indicated profile.
3. 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.

- OR-

If 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. Create the Mapping

Create a mapping that contains the source definition, target definition, and transformations that you want to
use to process documents for B2B Data Exchange.

You create a mapping for B2B Data Exchange in the same way you build other PowerCenter mappings. Use
B2B Data Exchange transformations and Unstructured Data transformations to add product-specific
functionality to the mapping. You can also add other PowerCenter transformation to the mapping.

Add the JMS source and target definitions and the transformations you require. If you require workflow
parameters, add the DX_Profile_Parameters transformation. The transformation gets profile parameter
values during run-time.

Step 4. Configure the JMS and JNDI Connections

Create a PowerExchange JNDI application connection for the B2B Data Exchange JMS provider and a JMS
application connection for the JMS source.

Before you create the connection objects, verify that PowerExchange for JMS is installed on the same
machine as PowerCenter and that you can create JMS connections. For general information about
PowerExchange for JMS, see the PowerExchange for JMS User Guide for PowerCenter.

JMS sources and targets require the following PowerExchange connection objects:

• JNDI application connection. General connection information for the B2B Data Exchange JMS provider.
• JMS application connection. Specific connection information for the JMS source.
In each connection object, you configure specific attributes to enable PowerCenter to send and receive
messages from B2B Data Exchange.

Step 3. Create the Mapping 13

 JNDI Connection Attributes
You define the JNDI application connection in PowerCenter and configure specific attributes to connect to
the B2B Data Exchange JMS provider.

The following table describes the attributes of the JNDI connection object to configure:

Attribute Description

JNDI Name of the context factory for the B2B Data Exchange JMS provider. Set the attribute to the following
Context value: com.informatica.b2b.dx.jndi.DXContextFactory
Factory

JNDI URL for the JNDI provider in B2B Data Exchange. The host name and the port number must match the
Provider URL host name and the port number in the jndiProviderURL attribute of the JMS endpoints in the B2B Data
Exchange configuration file.
If you use a single node installation, the default JNDI provider URL is: failover:tcp://
localhost:18616
If you use a cluster configuration, you can add multiple hosts.

JMS Connection Attributes

You define the JMS application connection in PowerCenter and configure specific attributes to connect to the
input queue of the JMS source. You create a connection for each workflow. The input queue configuration
must match the B2B Data Exchange workflow that represents the PowerCenter workflow.

All output queues of the JMS targets in B2B Data Exchange workflows can use the same JMS application
connection. The output queue configuration can use the default inbound JMS endpoint that you define in the
B2B Data Exchange configuration file.

The following table describes the attributes of the JMS connection object to configure:

Attribute Description

JMS Destination Type of JMS destination for the Data Exchange messages. Set the attribute to the following
Type value: QUEUE

JMS Connection Name of the connection factory in the JMS provider. Set the attribute to the following value:
Factory Name connectionfactory.local

JMS Destination Name of the destination. The destination value must match the name of the B2B Data
Exchange workflow that represents the PowerCenter workflow. Set the attribute value in the
following format:
queue.<DXWorkflowName>

14 Chapter 1: PowerCenter Mappings and Workflows

Step 5. Create the PowerCenter Workflow and
Session
Create the workflow and the session that runs the mapping. You create the workflow in the same way you
create other PowerCenter workflows. If you use a JMS source, you must configure the session as a real-time
session.

1. In the Workflow Designer, create the workflow and the session object. For general information about
creating workflows and sessions, see the PowerCenter Advanced Workflow Guide.
2. In the Edit Tasks dialog box, click the Properties tab.
3. Set the values for the following attributes:

Attribute Value

Commit Type Source

Commit Interval 1

4. In the Properties section for the selected source type, define the source attributes.
Set values for the following attributes:

Attribute Value

Source filename $InputFile_<eventAttributeValue>

Note: The event attribute value must match the value in the source event that B2B Data
Exchange sends to the workflow.

• If you select a JMS source, set the values for the following attributes:

Attribute Value

Real-time Flush Latency 1

JMS Queue Reader Mode Message Consumer

• If you select a file source, set the values for the following attributes:

Attribute Value

Source $InputFile_<eventAttributeValue>
filename Note: The event attribute value must match the value in the source event that B2B Data
Exchange sends to the workflow.

5. Save the session object.

6. To choose the format of the JMS message, select the Message Body Type option in the JMS Message
Body Columns tab of the Edit Tables dialog box.
• TextMessage. Sends the JMS message as a plain text file.

Step 5. Create the PowerCenter Workflow and Session 15

 • BytesMessage. Sends the JMS message as a binary file.
Note: You cannot use the MapMessage format in workflows for B2B Data Exchange.
7. Test the workflow to ensure that it works correctly.

Step 6. Export the PowerCenter Workflow and

Mapping
Export the workflow and the mapping from PowerCenter to an XML file. You then import the XML file to B2B
Data Exchange. You must use the Repository Manager to export the mapping and the workflow.

You create a B2B Data Exchange workflow in the Operation Console. The B2B Data Exchange workflow
represents the PowerCenter workflow and mapping. When you create the B2B Data Exchange workflow,
select the XML file as the workflow definition file to import the PowerCenter workflow to the B2B Data
Exchange repository.

You can use the Forms Designer to customize the layout and behavior of the workflow parameters that
appear when the operator creates or edits the profile that runs the workflow.

If you edit the PowerCenter workflow or mapping, you must export and import the XML file to B2B Data
Exchange.

After you test the PowerCenter workflow and confirm that it works 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.

During the import process, you can resolve changes to workflow parameters and parameter types. When you
change the type of a workflow parameter type, the import process deletes the values for the imported
parameters and you must manually enter the parameter values.

When you import an updated workflow definition file, a list of dependent profiles appear. You can disable
dependent profiles until the operator reviews the profiles.

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.

16 Chapter 1: PowerCenter Mappings and Workflows

Chapter 2

B2B Data Exchange

Transformations
This chapter includes the following topics:

• B2B Data Exchange Transformations Overview, 17

• DX_Add_Document_To_Event Transformation, 20
• DX_Aggregate Transformation, 22
• DX_Complete_Correlation Transformation, 24
• DX_Create_Event Transformation, 25
• DX_Event_Attribute Transformation, 27
• DX_Event_Details Transformation, 28
• DX_Generate_Temporary_File Transformation, 29
• DX_Get_Document_File_Path Transformation, 30
• DX_Increment_Profile_Parameter Transformation, 31
• DX_Initiate_Correlation Transformation, 32
• DX_Profile_Parameters Transformation, 33
• DX_Release_Delayed_Events Transformation, 35
• DX_Resolve_Profile, 35
• DX_Throw_Error, 36

B2B Data Exchange Transformations Overview

A B2B Data Exchange transformation is a set of functions that process B2B Data Exchange documents in
PowerCenter.

When you install B2B Data Exchange, you can install a set of transformations that you use in PowerCenter
workflows to process B2B Data Exchange documents. When you create mappings, you can use the
transformations to perform the functions that you require in the same way you use other PowerCenter
transformations.

B2B Data Exchange transformations are custom Java transformations that you use to access the B2B Data
Exchange API without writing Java code. You can use these transformations, the Unstructured Data
transformation, and other transformations to process B2B Data Exchange documents.

17
 You can also create custom transformations and use the methods in the B2B Data Exchange Web Services
API to define the transformation behavior.

The following table describes the B2B Data Exchange transformations:

Transformation Description

DX_Add_Document_To_Event Attaches a document to an event.

DX_Aggregate Groups rows of data.

DX_Complete_Correlation Completes the correlation for an event.

DX_Create_Event Creates an event and sets the properties of the event.

DX_Event_Attrribute Gets or sets the values of event attributes.

DX_Event_Details Gets or sets the values of a property of an event.

DX_Generate_Temporary_File Generates a file name for a file in the B2B Data Exchange document store.

DX_Get_Document_File_Path Converts a document reference into a file path.

DX_Increment_Profile_Parameter Increments the value of a parameter associated with a profile.

DX_Initiate_Correlation Initiates a correlation for an event.

DX_Profile_Parameters Gets profile parameter values.

DX_Release_Delayed_Events Releases all events for a profile.

DX_Resolve_Profile Determines the profile ID based on the application, account number, and partner.

DX_Throw_Error Sets an event status to error if the transformation fails.

Installing and Registering Transformations

To add B2B Data Exchange transformations to PowerCenter, use the B2B Data Exchange installer.

You install the following components:

• B2B Data Exchange PowerCenter server plug-in. Use the Administrator tool to register the plug-in.
• B2B Data Exchange PowerCenter Client plug-in. The installer registers the plug-in during the installation
process.
After you install and register the plug-ins, verify that the transformations are enabled in the PowerCenter
Designer. For more information about installing and configuring the plug-ins, see the B2B Data Exchange
Installation and Configuration Guide.

18 Chapter 2: B2B Data Exchange Transformations

Configuring Transformations
After you add a B2B Data Exchange transformation to a mapping, you edit and configure the transformation
based on your document processing requirements.

When you edit a B2B Data Exchange transformation, you can configure the transformation components on
the following tabs:

• Transformation tab. Rename the transformation and add a description.

• Ports. Add, edit, or delete ports. You can also designate ports as input or output ports.
• Properties tab. Configure transformation properties, such as module and function identifiers, transaction
properties, and the runtime location. The properties that appear 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. Set the default values for the ports in the transformation. You can also set the default
values for other B2B Data Exchange transformation properties.

Handling Transformation Errors

You can use certain transformation ports to define how to handle errors that occur during a workflow run.

Each B2B Data Exchange transformation uses the following ports to handle errors:

• DXErrorCode. When a transformation fails, the transformation sets the DXErrorCode to a value greater
than zero.
• DXErrorMessage. When a transformation fails, the transformation sends an error message that describes
the failure to the DXErrorMessage port.
When a transformation generates an error, 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 also
sets the status of the event to error.

You can set the error handling ports as input ports to prevent the transformation from running if an input
error occurs.

B2B Data Exchange Transformations Rules and Guidelines

When you work with B2B Data Exchange transformations in PowerCenter, follow rules and guidelines to
optimize performance and prevent errors.

The following list describes rules and guidelines for working with B2B Data Exchange transformations:

• B2B Data Exchange transformations are based on the PowerCenter Custom transformation and they
provide the same configuration options as other custom transformations. You can use them as you use
other PowerCenter transformations.
• B2B Data Exchange transformations are connected transformations. Connected transformations pass
data to or from other transformations.
• B2B Data Exchange transformations are passive transformations except for the DX_Aggregate
transformation.
• If a transformation port has a corresponding B2B Data Exchange property, the value of the port takes
precedence over the value of the property during runtime. When the session runs, if the value of the port is

B2B Data Exchange Transformations Overview 19

 not null, the PowerCenter Integration Service uses the value of the port for processing. If the value of the
port is null, the PowerCenter Integration Service uses the value of the B2B Data Exchange property for
processing.
• Port names are case insensitive and prefix insensitive. DXEventID, dxEVENTid, and eventid are all treated
as the same port.
• You can process only one event ID with one transformation at a time. To simultaneously process an event
with different transformations, use the DX_Create_Event transformation to create a child event for each
additional transformation that you want to use.
• When you run a PowerCenter workflow that uses a B2B Data Exchange transformation, PowerCenter tries
to connect to the B2B Data Exchange repository to get the list of event statuses and types to use in the
transformation. An error message indicates a failed connection. If the connection fails, PowerCenter gets
the event type values from the Client plug-in configuration file. To resolve connection errors, verify that
the connection section in the dxplugin.ini file contains the following configuration:
[DX_REPOSITORY]
; ODBC connection string to the DX repository
; CONNECTION_STRING=DRIVER={DataDirect 7.0 Oracle Wire Protocol};
UID=%1;PWD=%2;Host=localhost;Port=1521;SN=orcl
; CUSTOM_CONNECTION_STRING
; ODBC DSN to the DX repository
; DSN_NAME=dxOdbcResourceName
USER_NAME=DX
USER_PASSWD=DX
EVENT_TYPE_NAME=SELECT event_type_name FROM dx_event_type ORDER BY 1
EVENT_STATUS_NAME=SELECT event_status_name FROM dx_event_status ORDER BY 1

DX_Add_Document_To_Event Transformation
The DX_Add_Document_To_Event transformation attaches a document to an event.

You can use the transformation to add a document that you create in previous transformations. For example,
you can use the transformation to attach a log file to an event.

Input Ports
Configure input ports for the DX_Add_Document_To_Event transformation on the Ports tab.

The following table describes the DX_Add_Document_To_Event input ports:

Port Type Description

DXDescription string Description of the document to attach to the event.

DXMIMEType string MIME type of the document to attach to the event.

20 Chapter 2: B2B Data Exchange Transformations

 Port Type Description

DXEncoding string Character encoding of the document to attach to the event. This is the character set
to use to convert strings to byte arrays.

DXTemporaryFilePath string Optional. Path and file name generated by the DX_Generate_Temporary_File
transformation where the workflow stores the new file. The
DX_Add_Document_To_Event transformation saves the file as a new document
reference in the document store and attaches the file reference 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.

Input/Output Ports
Configure input/output ports for the DX_Add_Document_To_Event transformation on the Ports tab.

The following table describes the DX_Add_Document_To_Event input/output ports:

Port Type Description

DXEventId string Required. Identifier of the event to which to attach the document.

DXData string Document to attach to the event. This port can contain the data of the document or a
binary reference to the document. If this port is null, the transformation creates an empty
document and adds the document to the event.
text
To attach a document with text data, set the datatype of the port to string or text. To
attach a document with binary data, set the datatype of the port to binary.

DXDataByReference string 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 false, the DXData port contains the document data.

DXDocumentId string Identifier of the document to attach to the event.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of
the DXErrorCode port is greater than zero.

DX_Add_Document_To_Event Transformation 21
 B2B Data Exchange Properties
Configure properties for the DX_Add_Document_To_Event transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Add_Document_To_Event
transformation:

Property Description

Description Description of the document to attach to the event.

Document Role Role of the document when it is attached to an event. Select one of the following roles:
- SOURCE. The document is attached to an event as a source document. When you view
the event in the Operation Console, you can view the attached document in the Input
section.
- TARGET. The document is attached to an event as a target document. When you view
the event in the Operation Console, you can view the attached document in the Output
section.
- LOG. The document is attached to an event as a log document. When you view the
event in the Operation Console, you can view the attached document in the Logging
Information section.

Generate an error in case Indicates whether to set the status of the event to error when the transformation
a failure occurs in this generates an error.
transformation Selected by default.

DX_Aggregate Transformation
The DX_Aggregate active transformation groups segments of data to process.

You can use the transformation to aggregate row sets that you previously split back into a single document

You set the DXParentEventId and the DXGroupByKey ports to sort the data that you want to aggregate.

The DX_Aggregate transformation groups rows in the following manner:

1. 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.
2. On each subsequent row, the transformation appends the DXDelimiter and the content of the DXData
port to the file. It then increments the number of rows in the DXRowCount port.
3. 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. It then passes the output to the pipeline.
4. If you use a pass-through port, the transformation sends the value from the last row of the group to the
pipeline.
If a row contains an error or a null value in the DXData port, the transformation drops the row from the file
and does not pass the output to the pipeline.

The DX_Aggregate transformation determines the end of the group in the following cases:

• There is no more data to aggregate.

• 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.

22 Chapter 2: B2B Data Exchange Transformations

 • The row count for the group reached the value that you define in the DXMaxRowsInGroup port.
• The value of the DXLastInGroup port is true.

Input Ports
Configure input ports for the DX_Aggregate transformation on the Ports tab.

The following table describes the DX_Aggregate input ports:

Port Type Description

DXParentEventId string Identifier of the parent event associated with the data. This is the primary GROUP BY
key.

DXGroupByKey string Indicates whether to group rows with the primary key.

DXDelimiter string Delimiter string to add between segments of data. The valuedetermines the end of a
segment and the start of another segment.

DXData string Data segment to aggregate. This port can contain the data segment or a document
binary reference.
text

DXDataByReference string 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
false, the DXData port contains data.

DXLastInGroup string Indicates whether the row is the last row in a group.

DXMaxRowsInGroup integer Maximum number of rows in a group.

Input/Output Ports
Configure input/output ports for the DX_Aggregate transformation on the Ports tab.

The following table describes the DX_Aggregate input/output ports:

Port Type Description

DXGroupSequence integer Number of groups the transformation processed since the PowerCenter Integration
Service started. The transformation increments the value of this port every time a
group is processed. When the PowerCenter Integration Service starts, the value is
set to zero.

DXRowCount integer Number of rows successfully processed and added to the group.

DXTemporaryFilePath string 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 document and add it to an event.

DXErrorCount integer Number of rows that generated errors and were not added to the group.

DX_Aggregate Transformation 23
 Port Type Description

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of
the DXErrorCode port is greater than zero.

B2B Data Exchange Properties

Configure properties for the DX_Aggregate transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Aggregate transformation:

Property Description

Generate an error in case a failure occurs in Indicates whether to set the status of the event to error when the
this transformation transformation generates an error.
Selected by default.

DX_Complete_Correlation Transformation
The DX_Complete_Correlation transformation completes a correlation for an event.

Use the transformation with the DX_Initiate_Correlation. The DX_Initiate_Correlation generates a correlation
ID that you must pass to the DX_Complete_Correlation to complete the correlation.

Input Ports
Configure input ports for the DX_Complete_Correlation transformation on the Ports tab.

The following table describes the DX_Complete_Correlation input ports:

Port Type Description

DXCorrelationId string Required. Identifier of the correlation to complete.

24 Chapter 2: B2B Data Exchange Transformations

 Input/Output Ports
Configure input/output ports for the DX_Complete_Correlation transformation on the Ports tab.

The following table describes the DX_Complete_Correlation input/output ports:

Port Type Description

DXEventId string Required. Identifier of the event that completes the correlation.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of the
DXErrorCode port is greater than zero.

B2B Data Exchange Properties

Configure properties for the DX_Complete_Correlation transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Complete_Correlation
transformation:

Property Description

Generate an error if the reconciliation ID Indicates whether to set the status of the event to error if the
does not exist correlation ID does not exist.
Selected by default.

Generate an error in case a failure occurs in Indicates whether to set the status of the event to error when the
this transformation transformation generates an error.
Selected by default.

DX_Create_Event Transformation
The DX_Create_Event transformation creates an event in the Data Exchange repository and set the properties
of the event.

If you define a parent event in the transformation, the workflow generates a child event for the parent event
that you set.

DX_Create_Event Transformation 25
 Input Ports
Configure input ports for the DX_Create_Event transformation on the Ports tab.

The following table describes the DX_Create_Event input ports:

Port Type Description

DXParentEventId string Optional. Identifier of the parent event.

If the DXParentEventId port has a value, the transformation creates a child event of the
DXParentEventId event. If the DXParentEventId port is null and you select the Create root
event property, the transformation creates a root event.

DXSubject string Subject of the event to create. The subject cant contain up to 255 bytes.

DXStatusName string Status of the event to create. If the value is not null, the transformation sets the status
for the event.

DXTypeName string Type of the event to create.

Input/Output Ports
Configure input/output ports for the DX_Create_Event transformation on the Ports tab.

The following table describes the DX_Create_Event input/output ports:

Port Type Description

DXNewEventId string Identifier of the event to generate.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of the
DXErrorCode port is greater than zero.

DXProfileId string Required. Identifier of the profile associated with the event to generate.
If the profile ID port has a value, the transformation associates the profile ID with the
event.
If the profile ID port value is null, the transformation uses the DXApplication,
DXAccountNumber, and DXPartnerName ports to determine the profile ID to associate
with the event.

B2B Data Exchange Properties

Configure properties for the DX_Create_Event transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Create_Event transformation:

Property Description

Event Status Status of the event to create.

Event Type Type of the event to create.

26 Chapter 2: B2B Data Exchange Transformations

 Property Description

Event Subject Subject of the event to create.

Create root event 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.

Generate an error in case a failure Indicates whether to set the status of the event to error when the transformation
occurs in this transformation generates an error.
Selected by default.

DX_Event_Attribute Transformation
The DX_Event_Attribute gets or sets event attribute values.

To use this transformation, you first configure an event attribute in the Operation Console. You then add
ports to the transformation. Each port represents the event attribute that you want to get or set.

The port name must match the event attribute name. However, the attribute name is not case sensitive. For
example, the event_att1 attribute and the EVENT_ATT1 are treated as the same attribute.

Unlike other profile parameters, the event name is not prefix insensitive. For example, the DX_event_att1
attribute and the event_att1 attribute are not treated as the same attribute.

If you set a value for the port, the transformation sets the event attribute to this value. To get the value of an
event attribute, create an empty port.

Note: The DXValue port, the DXAttributeKey property, and the Event attribute property are optional and
retained for backwards compatibilty. Use the <attribute> port.

Input/Output Ports
Configure input/output ports for the DX_Event_Attribute transformation on the Ports tab.

The following table describes the DX_Event_Attribute input/output ports:

Port Type Description

DXEventId string Required. Identifier of the event associated with the attribute to get or to update.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of the
DXErrorCode port is greater than zero.

DX_Event_Attribute Transformation 27
 B2B Data Exchange Properties
Configure properties for the DX_Event_Attribute transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Event_Attribute transformation:

Property Description

Event attribute name Name of the event attribute to update. You configure the property in the Operation
Console. If the value is null, the transformation generates an error.
Note: Optional property. It is recommended that you use the <Attribute> port
instead. This property is retained for backward compatibility.

Generate an error in case a Indicates whether to set the status of the event to error when the transformation
failure occurs in this generates an error.
transformation Selected by default.

DX_Event_Details Transformation
The DX_Event_Details transformation gets or sets multiple properties for an event.

The transformation ports represent the properties of an event. The transformation sets the property of the
event based on the value that the input port passes to the transformation. The transformation passes the
value of the property through an output port to the event.

Input/Output Ports
Configure input/output ports for the DX_Event_Details transformation on the Ports tab.

The following table describes the DX_Event_Details input/output ports:

Port Type Description

DXStatusName string Status of the event. The status indicates the stages that the event passes during
processing.
To set a status for a completed event that is different from Complete, set the status
name in the DXStatusName attribute of the JMS Target definition property.

DXEventId string Required. Identifier of the event associated with the properties to get or update.

DXTypeName string Type of the event.

DXSubject string Subject of the event.

DXChildCount double Number of child events associated with the event.

DXParentEventId string Identifier of the parent event for this event.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of the
DXErrorCode port is greater than zero.

28 Chapter 2: B2B Data Exchange Transformations

 B2B Data Exchange Properties
Configure properties for the DX_Event_Details transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Event_Details transformation:

Property Description

Event Status Status of the event.

Event Type Type of the event.

Event Subject Subject of the event. It is recommended to change the name to a unique
value.
Default value is In Progress.

Generate an error in case a failure Indicates whether to set the status of the event to error when the
occurs in this transformation transformation generates an error.
Selected by default.

DX_Generate_Temporary_File Transformation
The DX_Generate_Temporary_File transformation generates a path and a file name for a document to store in
the B2B Data Exchange document store.

Use the transformation to generate a unique file name in a temporary directory within the document store.
For example, if you use an Unstructured Data transformation to write data to a temporary file, you can use the
DX_Generate_Temporary_File transformation to generate a file name for a file in the document store. You
then assign the file name and path to the file.

After you create the file in the temporary directory, you can use it in other transformations. For example, you
can use the DX_Add_Document_To_Event transformation to attach the file to an event. PowerCenter copies
the file from the temporary directory to the directory that contains all of the documents that it adds to events.

Input/Output Ports
Configure input/output ports for the DX_Generate_Temporary_File transformation on the Ports tab.

The following table describes the DX_Generate_Temporary_File input/output ports:

Port Type Description

DXEventId string Required. Identifier of the event to associate with the generated file.

DXTemporaryFilePath string Path and file name of the temporary file.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of
the DXErrorCode port is greater than zero.

DX_Generate_Temporary_File Transformation 29
 B2B Data Exchange Properties
Configure properties for the DX_Generate_Temporary_File transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Generate_Temporary_File
transformation:

Property Description

Do not use a temporary Indicates whether to generate the file path within the temporary directory in the B2B
folder in the generated file Data Exchange document store, or to generate the file path directly in the regular
path documents directory. Select this option to increase performance for documents that
PowerCenter passes by reference and eliminate the additional backup that the
temporary directory provides.
Note: Select this option if you use the DX_Add_Document_To_Event transformation for
an event with a document reference.
Cleared by default.

Set the event status to Error Indicates whether to set the status of the event to Error when the transformation
if the transformation fails generates an error.
Selected by default.

DX_Get_Document_File_Path Transformation
The DX_Get_Document_File_Path transformation gets the path and file name of a document from a
document reference.

Input/Output Ports
Configure input/output ports for the DX_Get_Document_File_Path transformation on the Ports tab.

The following table describes the DX_Get_Document_File_Path input/output ports:

Port Type Description

DXEventId string Optional. Event associated with the document reference. If the value is not null, the
transformation logs the event ID for tracking.

DXDocumentFilePath string Path and file name of the referenced document.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of
the DXErrorCode port is greater than zero.

30 Chapter 2: B2B Data Exchange Transformations

 B2B Data Exchange Properties
Configure properties for the DX_Get_Document_File_Path transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Get_Document_File_Path
transformation:

Property Description

Generate an error in case a failure occurs in Indicates whether to set the status of the event to error when the
this transformation transformation generates an error.
Selected by default.

DX_Increment_Profile_Parameter Transformation
The DX_Increment_Profile_Parameter transformation increments the value of a parameter that is associated
with a profile.

You can only increment numeric parameter values.

Input/Output Ports
Configure input/output ports for the DX_Increment_Profile_Parameter transformation on the Ports tab.

The following table describes the DX_Increment_Profile_Parameter input/output ports:

Port Type Description

DXProfileId string Identifier of the profile that is associated with the parameter to increment.

DXValue string Value to use to increment the parameter. Default value is 1.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of the
DXErrorCode port is greater than 0.

DX_Increment_Profile_Parameter Transformation 31
 B2B Data Exchange Properties
Configure properties for the DX_Increment_Profile_Parameter transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Increment_Profile_Parameter
transformation:

Property Description

Profile parameter name Name of the profile parameter to increment.

Generate an error in case a failure occurs in Indicates whether to set the status of the event to error when the
this transformation transformation generates an error.
Selected by default.

DX_Initiate_Correlation Transformation
The DX_Initiate_Correlation transformation initiates a reconciliation for an event. Use this transformation in a
workflow that processes a document that requires reconciliation.

Every reconciliation that you initiate needs to be completed. After you create the workflow with the
DX_Initiate_Correlation transformation, use the DX_Complete_Correlation in another workflow to complete
the reconciliation.

Input Ports
Configure input ports for the DX_Initiate_Correlation transformation on the Ports tab.

The following table describes the DX_Initiate_Correlation input ports:

Port Type Description

DXCorrelationType string Required. Description of the correlation type to initiate. The description can contain
up to 255 bytes. You configure the correlation type in the transformation properties.

DXCorrelationId string Required. Identifier of the correlation to initiate.

DXTimeWindow integer The time interval in seconds to complete the correlation.

32 Chapter 2: B2B Data Exchange Transformations

 Input/Output Ports
Configure input/output ports for the DX_Initiate_Correlation transformation on the Ports tab.

The following table describes the DX_Initiate_Correlation input/output ports:

Port Type Description

DXEventId string Required. Identifier of the event that is associated with the correlation to initiate.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of the
DXErrorCode port is greater than zero.

B2B Data Exchange Properties

Configure properties for the DX_Initiate_Correlation transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Initiate_Correlation
transformation:

Property Description

Generate an error if the reconciliation ID Indicates whether to set the status of the event to error if the event is
already exists already associated with a correlation ID.
Selected by default.

Generate an error in case a failure occurs Indicates whether to set the status of the event to error when the
in this transformation transformation generates an error.
Selected by default.

DX_Profile_Parameters Transformation
The DX_Profile_Parameters transformation to get the parameter values defined for a profile.

DX_Profile_Parameters Transformation 33
 Input/Output Ports
Configure input/output ports for the DX_Profile_Parameters transformation on the Ports tab.

The following table describes the DX_Profile_Parameters input/output ports:

Port Type Description

DXProfileID string Required. Identifier of the profile.

DXEventId string Optional. Identifier of the associated event. You can use this port together with the
ProfileId port.
If you set the EventId port, the transformation retrieves the parameter values from the
event context.
If an exception occurs, the associated event status is set to Error.

DXErrorMessage string Error message that the transformation generates.

DXErrorCode string Error code that the transformation generates. If the transformation fails, the value of the
DXError port is greater than zero.

The following table describes the DX_Profile_Parameters output-only ports:

Port Type Description

DXParametersXML string XML string that contains all the defined parameter names and values for the profile.
Each required parameter must have a port. If the value represents a multiple selection,
the value appears as a string that contains a semicolon-separated list of values. For
example:
<parameters>
<parameter name="" isnull={true/false}" isdefault="{true/
false}">
...CDATA value...
</parameter>
To generate the XML string, the output port must be connected.

<Parameter> string Profile parameters that the transformation gets when you import a
DX_Profile_Parameters transformation.
The transformation populates the port from all the imported ports that are not default
ports, such as eventId or profileId.
Identifies the imported ports by name. Treats ports with the same name as a single
parameter.
If a parameter port does not match a defined parameter, B2B Data Exchange generates
a debug log message.
All <parameter> ports are strings. You can change the port type in the Operation
Console with the Form Designer to one of the following types:
- Boolean. {true | false}, not case sensitive.
- Multi-selection. Semicolon (;) separated list of strings.
- Date. MM/DD/YYYY HH24:MI:SS.US

34 Chapter 2: B2B Data Exchange Transformations

DX_Release_Delayed_Events Transformation
The DX_Release_Delayed_Events transformation releases delayed events for a specified profile.

The transformation releases the delayed events regardless of the delayed processing rule that you define for
the profile.

Input/Output Ports
Configure input/output ports for the DX_Release_Delayed_Events transformation on the Ports tab.

The following table describes the DX_Release_Delayed_Events input/output ports:

Port Type Description

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of the
DXErrorCode port is greater than zero.

DXProfileId string Associated profile for the delayed processing rule. The profiles determines the events to
release. Required if the value of the EventId list port is null.

EventId list string List of identifiers for the events to release, separated by commas. Required if the value of
the DXProfileId port is null.

DX_Resolve_Profile
The DX_Resolve_Profile transformation sets the profile ID based on the associated application and the
partner or account number.

The transformation returns an error if the combination of the application and the partner or account number
is not associated with any profile.

Input Ports
Configure input ports for the DX_Resolve_Profile transformation on the Ports tab.

The following table describes the DX_Resolve_Profile input ports:

Port Type Description

DXApplication string Application that is associated with the profile.

DXEventId string Identifier of the associated event. If the transformation fails, the event status changes
to error.

DX_Release_Delayed_Events Transformation 35
 Port Type Description

DXPartnerName string Required. Name of the partner that is associated with the profile.

DXAccountNumber string Account number that is associated with the profile. If you use the account number and
partner name to resolve the profile, the account number is required. If you use the
profile name to resolve the profile, the account number is not required.

Input/Output Ports
Configure input/output ports for the DX_Resolve_Profile transformation on the Ports tab.

The following table describes the DX_Resolve_Profile input/output ports:

Port Type Description

DXProfileId string Identifier of the profile that is associated with the application and with the partner or
account number.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of the
DXErrorCode port is greater than zero.

B2B Data Exchange Properties

Configure properties for the DX_Resolve_Profile transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Resolve_Profile transformation:

Property Description

Generate an error in case a failure occurs in Indicates whether to set the status of the event to error when the
this transformation transformation generates an error.
Selected by default.

DX_Throw_Error
The DX_Throw_Error transformation generates an error if an error occurs when the workflow runs.

Use the transformation to perform the following actions:

• Set the status of the associated event to error.

• Create the error message from the value of the DXDescription port.
• Attach the error message to the associated event.
• Send the error to the session log.

36 Chapter 2: B2B Data Exchange Transformations

Input Ports
Configure input ports for the DX_Throw_Error transformation on the Ports tab.

The following table describes the DX_Throw_Error input ports:

Port Type Description

DXDescription string Description of the error to send to the session log. This error is also the description for
the log document attached to the event.

DXMessageType string Optional. Type of the error event. Alphanumeric value to associate with the event. Any
value is valid.

DXMIMEType string MIME type of the document to attach to the event.

Input/Output Ports
Configure input/output ports for the DX_Throw_Error transformation on the Ports tab.

The following table describes the DX_Throw_Error input/output ports:

Port Type Description

DXEventId string Required. Identifier of the event that is associated with the error.

DXData string Log document to attach to the event. This port can contain the data of the document
binary 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.
text
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.

DXDataByReference string Indicates whether the DXData port contains the document data or a document
reference. Possible values:
- True. The DXData port contains a document reference.
- False. The DXData port contains the document data.
- Null. The DXData port contains the document data.

DXErrorMessage string Error message generated by the transformation.

DXErrorCode string Error code generated by the transformation. If the transformation fails, the value of
the DXErrorCode port is greater than zero.

DX_Throw_Error 37
 B2B Data Exchange Properties
Configure properties for the DX_Throw_Error transformation on the DX Properties tab.

The following table describes the B2B Data Exchange properties of the DX_Throw_Error transformation:

Property Description

Error log document description Description of the error log document that the transformation attaches to
the event.

Message type Alphanumeric value to associate with the event. You can enter any value.

Generate an error in case a failure Indicates whether to set the status of the event to error when the
occurs in this transformation transformation generates an error.
Selected by default.

38 Chapter 2: B2B Data Exchange Transformations

Chapter 3

B2B Data Exchange Workflows

This chapter includes the following topics:

• B2B Data Exchange Workflows Overview, 39

• Managing B2B Data Exchange Workflows, 39
• B2B Data Exchange Workflow Properties, 40

B2B Data Exchange Workflows Overview

A workflow is a set of instructions that define how to process documents that partners send to B2B Data
Exchange. A B2B Data Exchange workflow represents a PowerCenter workflow and mapping.

You can create a workflow in B2B Data Exchange from a PowerCenter workflow by either of these methods:

• Select a workflow directly from the PowerCenter repository.

• Export the PowerCenter workflow to an XML file using the Repository Manager tool. You then select the
XML file to import as the workflow definition file.

Along with the workflow definition file, you define basic workflow properties, and save the new workflow.

You can create multiple workflows and associate them with an application. You can associate one workflow
with one or more profiles. Real-time workflows use the JMS queue to communicate with PowerCenter.

If you assign event attributes that the dashboard uses in reports to a workflow, the event attribute value must
be numeric. An event attribute is numeric if the lexical syntax rules in the Java Language Specification define
it as a FloatValue.

Managing B2B Data Exchange Workflows

Use the Navigator to add, edit, and delete B2B Data Exchange workflows . Each workflow represents a
PowerCenter workflow or Informatica Intelligent Cloud Services (Data Integration) mapping.

1. In the Navigator, click Partner Management > Workflows.

The Workflows page appears.
2. Choose to create, edit, or delete a workflow.

39
 • To create a workflow, click New Workflow and define the workflow properties. For more information,
see “B2B Data Exchange Workflow Properties” on page 40.
• To edit a workflow, click the Edit icon next to the workflow that you want to edit and change the
workflow properties.
Note: If the workflow is associated with profiles, the Operation Console displays a list of the
associated profiles. If the changes to the workflow might cause problems in processing documents
for the partner defined in the profile, disable the profile and review the changes to the profile before
you enable the profile again.
• To delete a workflow, click the Delete icon next to the workflow that you want to delete and confirm
the deletion.
Note: If you delete the workflow, you also delete all of the dependent objects for that workflow.
3. If the workflow contains parameters, you can add values to the parameters on the Workflow Parameters
tab of the Create Workflow page. You can customize the layout and behavior of the parameters with the
Forms Designer. For more information, see “Customizing Workflow Parameters” on page 50.
4. To associate event attributes with the workflow, add event attributes on the Event Attributes tab.
5. To manually run an outbound batch workflow, click Partner Management > Profiles and run the profile
that is associated with the batch workflow.
6. To manually run a scheduled batch workflow, click Events > Event List and release the events for the
batch workflow.

B2B Data Exchange Workflow Properties

A B2B Data Exchange workflow contains an associated PowerCenter workflow or Informatica Intelligent
Cloud Services (Data Integration) mapping, and other properties such as name and description. You define
the properties when you create or edit a workflow.

A B2B Data Exchange workflow definition contains the following general properties:
Workflow Name

Name of the workflow. The name can contain up to 64 characters and can include spaces and special
characters.

Description

Optional description of the workflow. The description appears as a tooltip when the operator selects a
workflow in the Profiles and Monitors pages.

Application

Name of the application to which the workflow belongs. Select <none> to create a workflow without an
application.

Flow Type

The flow type depends on the application that is used to process documents.

Consider the following guidelines when you select the flow type:

• Select Informatica Cloud workflow to associate the workflow with a Informatica Intelligent Cloud
Services (Cloud Data Integration) mapping. A Cloud Data Integration mapping reads from a source
and writes to a target defined in the mapping. Use the mapping to process and transfer files over
Informatica Cloud.

40 Chapter 3: B2B Data Exchange Workflows

 • Select PowerCenter Batch workflow to associate the workflow with a PowerCenter batch workflow. A
PowerCenter batch workflow reads from a file, database, or another source. The workflow runs once
and stops after completion. You can use the PowerCenter batch workflows to process documents
from B2B Data Exchange. You can also use the workflows to generate documents for B2B Data
Exchange, such as outbound reports. Use the PowerCenter workflow export file as the workflow
definition file.
• Select PowerCenter Real-time workflow to associate the workflow with a real-time workflow. A
PowerCenter real-time workflow runs continuously and reads from real-time sources. You can use
these workflows to process documents from B2B Data Exchange. Use the PowerCenter mapping or
workflow export file as the workflow definition file.
• Select Java (advanced) to use Java classes as the flow engine in test mode or development mode.
Use the Java class file as the workflow definition file.

Workflow

A PowerCenter workflow that you want to add to B2B Data Exchange. Select one of the following
options:

• Select a workflow from the PowerCenter repository. Select a PowerCenter workflow that you saved
in the PowerCenter repository. To show all workflows in the repository, click Show All. To search for a
workflow by name, enter a string in the Folder Name text box and then click Search.
• Select a workflow definition file (XML). Select an XML PowerCenter workflow definition file that you
exported from the PowerCenter repository. To select a file, click the browse button, browse to the
location of the required file, select the file, and then click Upload.

B2B Data Exchange Workflow Properties 41

Chapter 4

Creating Workflows for Event

Reconciliation
This chapter includes the following topics:

• Overview of Event Reconciliation, 42

• Initiating and Completing an Event Reconciliation, 43
• Reconciliation Status, 44

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 10 purchase orders, or one acknowledgment for each of the 10 purchase orders. If you
require one acknowledgment, you initiate one reconciliation. If you require 10 acknowledgments, you must
initiate 10 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. B2B Data Exchange receives a document file that requires an acknowledgment and sends it to
PowerCenter for processing.
2. The workflow designed to process the document initiates a reconciliation.
If the document requires multiple acknowledgments, the workflow initiates multiple reconciliations.
3. B2B Data Exchange sets the status for each reconciliation and sets the reconciliation status for the
associated event.
4. B2B Data Exchange receives an acknowledgment document and sends it to PowerCenter for processing.

42
 5. The workflow designed to process the acknowledgment determines if the document completes a
reconciliation.
6. B2B Data Exchange updates the reconciliation status.

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 Transformation” on
page 32.

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 Transformation” on page 24.

Initiating and Completing an Event Reconciliation 43

 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);

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. An 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. An 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.

44 Chapter 4: Creating Workflows for Event Reconciliation

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.

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.
2. Pending reconciliation. All reconciliations associated with the event and its child events have been
initiated but no reconciliation has completed or timed out.
3. 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.
4. 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.

Reconciliation Status 45
 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

Event 01 Child event 101 Pending reconciliation

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 Timed out

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

Event 03 Reconciliation 041 Reconciliation complete Reconciled after timeout

Reconciliation 042: Reconciled after timeout

46 Chapter 4: Creating Workflows for Event Reconciliation

Chapter 5

Forms Designer
This chapter includes the following topics:

• Forms Designer Overview, 47

• Forms Designer User Interface, 47
• Element Properties, 49
• Group Properties, 50
• Customizing Workflow Parameters, 50

Forms Designer Overview

The Forms Designer is a tool that developers and administrators can use to customize user interface and
field behavior on Operations Console pages with a dynamic interface. You can use the Forms Designer to
customize pages that display workflow parameters, partner attributes, and account attributes.

In the Forms Designer, you use the Designer tab to customize behavior and appearance of fields. For
example, you can arrange large lists of workflow parameters in tabs or create dependencies between fields
so that a specific parameter only appears if another parameter has a value. You can also mark fields as
mandatory or read-only and determine the field type. For example, you can define a field as a text field or a
number field. You can preview the customized layout on the Preview tab.

When you customize partner attributes, account attributes, or workflow parameters, you can import values
from external lists with the B2B Data Exchange Forms Designer Java API. Use the API methods to configure
the external list and set the default value for the list if needed. Each time you populate the list, the API
overrides the values in the existing list. Therefore, if you manually modify any list value, the API deletes the
value.

Forms Designer User Interface

The Designer tab displays the elements to customize, such as workflow parameters, partner attributes, or
account attributes. You can use the Actions menu to add groups, such as tabs, columns, headers, or
disclosures. You can also drag and drop elements to group and nest the fields in up to four levels.

The Designer tab displays information about the elements, such as label and type. The information appears
in read-only mode.

47
 The following table describes the element properties that you can view on the Designer tab:

Column Description

ID Unique identifier of the element. For example, the name of the workflow parameter as defined in
PowerCenter.

Label Label of the element as it appears on the form. The label can be different from the ID of the
element.

Type Type of the element, such as text or date.

Representation Representation of the element in the form. For example, the element can be an entry field, a radio
button, or a drop-down list.

Mandatory Indicates whether the element is mandatory.

Read-Only Indicates whether the element is read-only.

Depends On Name of the element or group on which the parameter depends.

Forms Designer Actions

On the Designer tab, you can add a tab, column, header, or disclosure. If you select an element, you can edit
the element properties.

The following table describes the actions that you can perform on the Designer tab:

Action Description

Edit Opens a dialog box that you use to edit the properties of an element.
Available when you select an element.

Create Tab Creates a tab. You can drag and drop elements into tabs and move tabs up or down the element
list to determine the tab order. The top tab is visible by default.
You can nest tabs up to three levels.

Create Column Creates a column. When you add two or more columns, elements that you drag and drop into a
column appear side by side on the form.
You can nest columns up to three levels.

Create Header Creates a header. A header is a separator with a title that you use to group elements without hiding
them from the form.
You can nest headers up to three levels.

Create Create a disclosure. A disclosure is a header with a title and an expand arrow. When you click the
Disclosure arrow, an element group appears. By default, disclosures appear minimized on the form.
You can nest disclosures up to three levels.

Delete Group Deletes a tab, column, header, or disclosure. Deleting the group does not delete the elements from
the form.
Available when you select a group.

Move to Group Moves elements from one tab, column, header, or disclosure group to another group.
Available when you select an element.

48 Chapter 5: Forms Designer

Element Properties
When you edit an element in the Details dialog box, you can change element properties such as label, type,
and default value. If you use the Forms Designer Java API, you can define an element to display values from
external sources.

The dialog box appears when you select an element. If you select a group, you can edit only the label, type,
and field dependency for the group.

The following table describes the element properties:

Property Description

Label Required. Name of the element to display in the form. The label can be different from the ID.

Description Textual description of the parameter. The description appears in a tooltip when you hover over
the element in the form.

Mandatory Requires users to enter a value for the element in the form.

Read Only Defines the element as read-only and the users cannot change the element value.

Hidden Hides the element from the form. Select this check box for workflow parameters that operators
cannot edit.

Type Type of data for the element value. Choose one of the following options:
- Boolean. If you select this option, the Check box representation is selected by default.
- Date. If you select this option, the Date picker representation is selected by default.
- Number. If you select this option, the Entry field representation is selected by default.
- Text

Representation Type of input that users enter for the element value. Choose one of the following options:
- Entry field
- Dropdown list
- Radio button
- List
- Check box

Default Value Value that appears when the form appears. If you select a list or dropdown list representation and
populate the list with the Forms Designer Java API, the external data source determines the
default value.

Values A list of valid values for the parameter. If you select a list or dropdown list representation, enter
one or more values. The values list is not case sensitive.
Note: If you populate list values from an external source, do not change the values in the list. The
values from the external source override any manual changes you make to the list.

Minimum Minimum valid value for the element. For string elements, the value you enter in this property
determines the minimum number of characters. For number elements, the value you enter in this
property determines the minimum numeric value.
Available when you select a string or number element type.

Element Properties 49
 Property Description

Maximum Maximum valid value for the element. For string elements, the value you enter in this property
determines the maximum number of characters. For number elements, the value you enter in this
property determines the maximum numeric value.
Available when you select a string or number element type.

Field Dependency Set of conditions that determines whether to link the element to another element or group in the
form. For example, you can choose to enable the element only after users enters a value in a
different element.

Group Properties
When you create or edit a tab, column, header, or disclosure in the Details dialog box, you can change the
label, type or field dependency properties.

The following table describes the group properties:

Property Description

Label Mandatory. Name of the group to display in the form.

Type Mandatory. Type of the group. Choose from one of the following options:
-Tab
-Column
-Header
-Disclosure

Field Dependency Set of conditions that determines whether to link the group to another element or group in the
form. For example, you can choose to enable a tab only after users entered a specific value in a
different element.

Customizing Workflow Parameters

Use the Forms Designer to customize user interface layout and field behavior for workflows that contain
parameters in the Operation Console and in the Partners Portal Message Profile wizard. . The steps in this
task are similar to the steps you follow to customize partner attributes and account attributes.

Before you customize workflow parameters, create or edit the workflow in the Workflows page. Ensure that
the PowerCenter workflow contains workflow parameters.

1. In the Navigator, click Partner Management > Workflows.

2. Choose to create or edit a workflow.
• To create a workflow, click New Workflow. For details, see “B2B Data Exchange Workflow
Properties” on page 40.
• To edit a workflow, click Edit next to the workflow that you want to edit.
3. Click the Workflow Parameters tab.

50 Chapter 5: Forms Designer

 The Preview pane displays the default view of the workflow parameter list. The Portal Parameters tab
displays the list of workflow parameters that are shown and can be edited in the Message Profile wizard
in the Partners Portal.
Note: The name of the Portal Parameters tab is configurable, and the tab might have another name.
4. Click Designer.
The Designer pane displays the parameter list in alphabetic order.
5. To arrange the parameters and groups, drag the element or group you want to arrange.
To create a list of workflow parameters to display for message profiles in the Partners Portal, drag the
element or group you want to arrange under the Portal Parameters tab.
6. To change the behavior and appearance of a parameter element, click the parameter and click Actions >
Edit.
The Details dialog box appears.
7. Change the properties for the parameter and click Save.
Note: The Label property is a required property.
8. To add a group, click the Actions menu and choose to add a tab, column, header, or disclosure.
9. To preview the customized form, click Preview and verify the appearance of the form and any field
dependencies you defined.
10. Click Save to save the workflow.
The customized form appears when you create or edit a profile and associate the workflow with the
profile.

Customizing Workflow Parameters 51

Chapter 6

Configuring Email for Monitor

Notification
This chapter includes the following topics:

• Overview of Email for Monitor Notification, 52

• The Built-in Email Notification Message Format, 52
• Configuring the Email Notifications, 53

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. The user can 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 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.

52
 You can use the built-in email format for event notifications, or you can customize it.

Configuring the Email Notifications

You can use system properties and event properties to customize the email properties.

You can completely customize the body of the email message.

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 you can use to modify built-in email notification
messages. Use the DX_EVENT_ATTRIBUTE transformation to set the attributes for an event.

Event Property Description

dx_email_bcc_field A semicolon-separated list of recipient email addresses. These recipients are added to the
addressees defined in the monitor.

dx_email_body_file 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.

dx_email_body_field A character string that is used to replace the body text of the built-in email. Maximum length
is 255 characters.

dx_email_from_field This string becomes the "from field" of the email.

Configuring the Email Notifications 53

 Event Property Description

dx_email_cc_field A semicolon-separated list of recipient email addresses. These recipients are added to the
addressees defined in the monitor.

dx_email_mimetype Default is "text/html"; charset=UTF-8.

For more information about mime types, see http://www.mimetype.org.

dx_email_subject_field Subject field of the email.

dx_email_to_field A semicolon-separated list of recipient email addresses. These recipients are added to the
list of addressees defined in the monitor.

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.

The following variables are built-in:

Variable Description

$DXMonitorName The name of the monitor.

$DXPartnerInfo 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.

The developer assigns a value to MyAttribute using the DX_Event_Attribute transformation.

54 Chapter 6: Configuring Email for Monitor Notification

Chapter 7

B2B Data Exchange Web Services

API
This chapter includes the following topics:

• Data Exchange Web Services Overview, 55

• DX_TPM_Partner Web Service, 56
• DX_TPM_Account Web Service, 63
• DX_TPM_Profile Web Service, 70
• DX_Endpoint Web Service, 77
• Complex Type Objects in the Data Exchange Web Services, 78
• General B2B Data Exchange Web Service Behavior, 81
• B2B Data Exchange Web Service Security, 81

Data Exchange Web Services Overview

B2B Data Exchange provides a set of Web services that you can use to create and manage partners,
accounts, and profiles from a client application. You can also use the Web services to send input documents
to B2B Data Exchange.

When you install B2B Data Exchange, the Data Exchange Web services are installed as a set of XML files. The
XML files are PowerCenter export files that contain Web service workflows. To use the Web services, import
the XML files into PowerCenter and run the Web service workflows. Then you can call the Web service
operations from any Web service client application.

B2B Data Exchange provides the following Web services:

• DX_TPM_Partner. Creates and manages trading partners.

• DX_TPM_Account. Creates and manages accounts.
• DX_TPM_Profile. Creates and manages profiles.
• DX_Endpoint. Sends documents to B2B Data Exchange.

55
DX_TPM_Partner Web Service
The DX_TPM_Partner web service creates, deletes, and manages trading partners in the B2B Data Exchange
repository.

Use the DX_TPM_Partner web service to perform the following tasks:

• Create a partner.
• Delete a partner.
• Update the information for a partner.
• Search for a partner.
• Count of the number of partners in the repository.
• Get information for a partner by index.

Reserved System Partner

Do not use the name none when you create, update, or search for a partner. This name is reserved for a
dedicated system partner. The web service returns a fault response if you try to assign this name to another
partner.

DX_TPM_Partner Request
The DX_TPM_Partner request defines the task performed by the DX_TPM_Partner web service.

The DX_TPM_Partner request message includes the following elements:

operation

Required. Type of operation the web service will perform. The web service can perform one of the
following operations:

• create
• delete
• update
• search
• count
• get

partner

Complex type object DXPartner that includes elements that describe the trading partner to create.
Required by the create and update operations and ignored by other operations.

account

Complex type object DXAccount that includes elements that describe the partner account to create or
update. Required by the create operation and ignored by other operations.

partnerName

Name of the partner to search or delete. Required by the search and delete operations and ignored by
other operations.

index

Index for the partner to get. The index number starts at zero. Required by the get operation and ignored
by other operations.

56 Chapter 7: B2B Data Exchange Web Services API

DX_TPM_Partner Response
The DX_TPM_Partner response is the reply from the DX_TPM_Partner web service.

The DX_TPM_Partner response message includes the following elements:

partner

Complex type object DXPartner that includes elements that describe the trading partner to create or
update. The partner element is included in the response message for the following operations:

• create
• update
• get
• search

count

Number of partners in the B2B Data Exchange repository. The count element is included in the response
message for the count operation.

Note: The DX_TPM_Partner web service sends an empty response to the client when the web service
requests a delete operation.

DX_TPM_Partner Create Operation

The DX_TPM_Partner create operation creates a partner and an associated account.

Guidelines
Use the following guidelines when you create a partner:

• The request must use the create operation.

Response
The web service returns a DXPartnerResponse object that includes the partner information in a DXPartner
object.

The web service returns a fault response in the following situations:

• The DXPartner object has an element with an invalid value.

• The DXAccount object has an element with an invalid value.
• A partner in the Data Exchange repository has the same partner name specified in the DXPartner object.
• The name is already reserved for a dedicated system partner.

Create SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Partner web service to create a
partner:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>

DX_TPM_Partner Web Service 57

 <sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</
sec:DXPassword>
<!--<sec:Nonce>?</sec:Nonce>-->
<!--<sec:Created>?</sec:Created>-->
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXPartnerRequest>
<operation>create</operation>
<partner>
<Name>PartnerTestName</Name>
<Description>PartnerTest Description</Description>
<!--Zero or more repetitions:-->
<CategoryName>CategoryTest1</CategoryName>
<CategoryName>CategoryTest2</CategoryName>
<!--Zero or more repetitions:-->
<ContactInformation>
<Name>PartnerTestContact1</Name>
<Description>PartnerTestContact1 Description</Description>
<Title>PartnerTestContact1 Title</Title>
<Address>PartnerTestContact1 Address</Address>
<PhoneNumber>+12345678912</PhoneNumber>
<BusinessPhoneNumber>+12345678913</BusinessPhoneNumber>
<FaxNumber>+12345678914</FaxNumber>
<EmailAddress>[email protected]</EmailAddress>
</ContactInformation>
<ContactInformation>
<Name>PartnerTestContact2</Name>
<Description>PartnerTestContact2 Description</Description>
<Title>PartnerTestContact2 Title</Title>
<Address>PartnerTestContact2 Address</Address>
<PhoneNumber>+12345678922</PhoneNumber>
<BusinessPhoneNumber>+12345678923</BusinessPhoneNumber>
<FaxNumber>+12345678924</FaxNumber>
<EmailAddress>[email protected]</EmailAddress>
</ContactInformation>
<!--Zero or more repetitions:-->
<PartnerAttribute>
<Name>PartnerAttribute1</Name>
<Value>PartnerAttribute1Value</Value>
</PartnerAttribute>
<PartnerAttribute>
<Name>PartnerAttribute2</Name>
<Value>PartnerAttribute2Value</Value>
</PartnerAttribute>
</partner>
<account>
<Name>AccountTest1</Name>
<Number>123</Number>
<Description>AccountTest1 Description</Description>
<!--Zero or more repetitions:-->
<CategoryName>CategoryTest3</CategoryName>
<CategoryName>CategoryTest4</CategoryName>
<!--Zero or more repetitions:-->
<AccountAttribute>
<Name>AccountAttribute1</Name>
<Value>AccountAttribute2</Value>
</AccountAttribute>
<PartnerName>PartnerTestName</PartnerName>
</account>
</tpm:DXPartnerRequest>
</soapenv:Body>
</soapenv:Envelope>

58 Chapter 7: B2B Data Exchange Web Services API

DX_TPM_Partner Search Operation
The DX_TPM_Partner search operation searches the repository for a specified partner name.

Guidelines
Use the following guidelines when you search for a partner:

• The request must use the search operation.

• The search string must match the partner name exactly. For example, InformaticaCorp and Informa do
not match the partner name Informatica. The partner name is not case sensitive.

Response
The web service returns a DXPartnerResponse object that includes the partner information in a DXPartner
object.

DX_TPM_Partner Response
The DX_TPM_Partner web service returns NULL in the following situations:

• The partner name specified in the request does not exist in the repository.
• The partner name specified in the request is NULL or an empty string.
• The user account used to log in to the B2B Data Exchange Server is not authorized to view the partner.
• The name is already reserved for a dedicated system partner.

DX_TPM_Partner Update Operation

The DX_TPM_Partner update operation updates the information for a specified partner.

Guidelines
Use the following guidelines when you update a partner:

• The request must use the update operation.

• The search string must match the partner name exactly. For example, InformaticaCorp and Informa do
not match the partner name Informatica. The partner name is not case sensitive.

Response
The web service returns a fault response in the following situations:

• The partner name specified in the request does not exist in the repository.
• The name is already reserved for a dedicated system partner.

Update SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Partner web service to update
a partner:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>

DX_TPM_Partner Web Service 59

 <sec:DXPassword DXPasswordType="PasswordText">sys</
sec:DXPassword>
<!--<sec:Nonce>?</sec:Nonce>-->
<!--<sec:Created>?</sec:Created>-->
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXPartnerRequest>
<operation>update</operation>
<partner>
<Name>PartnerTestName</Name>
<Description>PartnerTest Description</Description>
<!--Zero or more repetitions:-->
<CategoryName>CategoryTest1</CategoryName>
<CategoryName>CategoryTest2</CategoryName>
<!--Zero or more repetitions:-->
<ContactInformation>
<Name>PartnerTestContact1</Name>
<Description>PartnerTestContact1 Description</Description>
<Title>PartnerTestContact1 Title</Title>
<Address>PartnerTestContact1 Address</Address>
<PhoneNumber>+12345678912</PhoneNumber>
<BusinessPhoneNumber>+12345678913</BusinessPhoneNumber>
<FaxNumber>+12345678914</FaxNumber>
<EmailAddress>[email protected]</EmailAddress>
</ContactInformation>
<ContactInformation>
<Name>PartnerTestContact2</Name>
<Description>PartnerTestContact2 Description</Description>
<Title>PartnerTestContact2 Title</Title>
<Address>PartnerTestContact2 Address</Address>
<PhoneNumber>+12345678922</PhoneNumber>
<BusinessPhoneNumber>+12345678923</BusinessPhoneNumber>
<FaxNumber>+12345678924</FaxNumber>
<EmailAddress>[email protected]</EmailAddress>
</ContactInformation>
<!--Zero or more repetitions:-->
<PartnerAttribute>
<Name>PartnerAttribute1</Name>
<Value>PartnerAttribute1Value</Value>
</PartnerAttribute>
<PartnerAttribute>
<Name>PartnerAttribute2</Name>
<Value>PartnerAttribute2Value</Value>
</PartnerAttribute>
</partner>
<account>
<Name>AccountTest1</Name>
<Number>123</Number>
<Description>AccountTest1 Description</Description>
<!--Zero or more repetitions:-->
<CategoryName>CategoryTest3</CategoryName>
<CategoryName>CategoryTest4</CategoryName>
<!--Zero or more repetitions:-->
<AccountAttribute>
<Name>AccountAttribute1</Name>
<Value>AccountAttribute2</Value>
</AccountAttribute>
<PartnerName>PartnerTestName</PartnerName>
</account>
</tpm:DXPartnerRequest>
</soapenv:Body>
</soapenv:Envelope>

60 Chapter 7: B2B Data Exchange Web Services API

DX_TPM_Partner Delete Operation
The DX_TPM_Partner delete operation deletes a partner from the repository.

Guidelines
Use the following guidelines when you delete a partner:

• The request must use the delete operation.

• The search string must match the partner name exactly. For example, InformaticaCorp and Informa do
not match the partner name Informatica. The partner name is not case sensitive.

Response
When the operation is successful, the web service sends an empty response to the client.

B2B Data Exchange ignores a delete request and does not return a fault response in the following situations:

• The partner name specified in the request does not exist in the repository.
• The partner name specified in the request is NULL or an empty string.
• The user account used to log in to the B2B Data Exchange Server is not authorized to delete the partner.

Delete SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Partner web service to delete a
partner:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXPartnerRequest>
<operation>delete</operation>
<partnerName>PartnerTest</partnerName>
</tpm:DXPartnerRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Partner Count Operation

The DX_TPM_Partner count operation returns the number of partners in the B2B Data Exchange repository.

Guidelines
Use the following guidelines when you count the partners in the repository:

• The request must use the count operation.

Response
The count operation returns the number of partners associated with the B2B Data Exchange user account in
the message header.

DX_TPM_Partner Web Service 61

 Count SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Partner web service to count
the number of partners in the Data Exchange repository:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXPartnerRequest>
<operation>count</operation>
</tpm:DXPartnerRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Partner Get Operation

The DX_TPM_Partner get operation returns information for the partner associated with a specified index.

You can use the count and get operations together to get information on a partner by index. For example, you
can get the total count of partners and use it to iterate through a "for" loop to get the information about each
partner.

When you use the count as the basis for an index in an iteration, ensure that the count does not change until
the iteration completes. If you insert or delete a partner during an iteration, the total number of partners can
change and invalidate the index.

Guidelines
Use the following guidelines when you get information about a partner:

• The request must use the get operation.

• Partners are indexed by name in alphabetical order.
• The index numbers range from zero to the total count of partners minus one (0...n-1).

Response
The web service returns a DXPartnerResponse object that includes the partner information in a DXPartner
object.

Get SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Partner web service to get
information on a partner by index:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>

62 Chapter 7: B2B Data Exchange Web Services API

 <Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
<!--<sec:Nonce>?</sec:Nonce>-->
<!--<sec:Created>?</sec:Created>-->
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXPartnerRequest>
<operation>get</operation>
<index>0</index>
</tpm:DXPartnerRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Account Web Service

The DX_TPM_Account web service creates, deletes, and manages accounts in the B2B Data Exchange
repository.

Use the DX_TPM_Account web service to perform the following tasks:

• Create an account.
• Delete an account.
• Update the information for an account.
• Search for an account.
• Count the number of accounts in the repository.
• Get information for an account by index.

Reserved System Account

Do not use the name none when you create or update an account. This name is reserved for a dedicated
system account. The web service returns a fault response if you try to assign this name to another account.

DX_TPM_Account Request
The DX_TPM_Account request defines the task for the DX_TPM_Account web service to perform.

The DX_TPM_Account request message includes the following elements:

operation

Required. Type of operation the web service will perform. The web service can perform one of the
following operations:

• create
• delete
• update
• search
• count

DX_TPM_Account Web Service 63

 • get

account

Complex type object DXAccount that describes the partner account to create or update. Required by the
create and update operations and ignored by other operations.

accountNumber

Account number to search or delete. Required by the search and delete operations and ignored by other
operations.

partnerName

Name of the partner associated with the account that will be counted. Required by the count, get, search,
and delete operations and ignored by other operations.

index

Index for the account to get. The index number starts at zero. Required by the get operation and ignored
by other operations.

DX_TPM_Account Response
The DX_TPM_Account response is the reply from the DX_TPM_Account web service.

The DX_TPM_Account response message includes the following elements:

account

Complex type object DXAccount that includes elements that describe the account to create or update.
The account element is included in the response message for the following operations:

• create
• update
• get
• search

count

Number of accounts in the B2B Data Exchange repository. The count element is included in the response
message for the count operation.

Note: When the web service request is a delete operation, the DX_TPM_Account web service sends an empty
response to the client.

DX_TPM_Account Create Operation

The DX_TPM_Account create operation creates an account with a specified account name and number.

Guidelines
Use the following guidelines when you create an account:

• The request must use the create operation.

Response
The web service returns a DXAccountResponse object with the new account information in a DXAccount
object.

64 Chapter 7: B2B Data Exchange Web Services API

The web service returns a fault response in the following situations:

• The DXAccount object has an element with an invalid value.

• The account already exists in the B2B Data Exchange repository.
• The account name or number identifies a dedicated system account.
• The partner for the account does not exist in the B2B Data Exchange repository.
• The associated partner name is reserved for a dedicated partner name or the account name is reserved
for a dedicated system account.

Create SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Account web service to create
an account:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXAccountRequest>
<operation>create</operation>
<account>
<Name>AccountTestName</Name>
<Number>123</Number>
<Description>AccountTest Description</Description>
<!--Zero or more repetitions:-->
<CategoryName>CategoryTest1</CategoryName>
<CategoryName>CategoryTest2</CategoryName>
<!--Zero or more repetitions:-->
<AccountAttribute>
<Name>AccountAttribute1</Name>
<Value>AccountAttribute1Value</Value>
</AccountAttribute>
<AccountAttribute>
<Name>AccountAttribute2</Name>
<Value>AccountAttribute2Value</Value>
</AccountAttribute>
<PartnerName>PartnerTestName</PartnerName>
</account>
</tpm:DXAccountRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Account Web Service 65

 DX_TPM_Account Search Operation
The DX_TPM_Account search operation searches the repository for a specified partner name and account
number.

Guidelines
Use the following guidelines when you search for an account:

• The request must use the search operation.

• The partner name and account number must exactly match the partner name and account number of the
account to search for.

Response
The web service returns a DXAccountResponse object that includes the account information in a DXAccount
object.

The web service returns NULL in the following situations:

• An account with the partner name and account number specified in the request does not exist in the
repository.
• The partner name or account number specified in the request is NULL or an empty string.
• The user account used to log in to the B2B Data Exchange Server is not authorized to view the account.
• The partner name or account number identifies a reserved system partner or account.

Search SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Account web service to search
for an account:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXAccountRequest>
<operation>search</operation>
<partnerName>myPartner</partnerName>
<accountNumber>myAccount</accountNumber>
</tpm:DXAccountRequest>
</soapenv:Body>
</soapenv:Envelope>

66 Chapter 7: B2B Data Exchange Web Services API

DX_TPM_Account Update Operation
The DX_TPM_Account update operation updates the information for a specified account number.

Guidelines
Use the following guidelines when you update an account:

• The request must use the update operation.

Response
The web service returns a fault response in the following situations:

• The account number specified in the request does not exist in the repository.
• The account number identifies a reserved system account.

Update SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Account web service to update
an account:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXAccountRequest>
<operation>update</operation>
<account>
<Name>AccountTestName</Name>
<Number>123</Number>
<Description>AccountTest Description</Description>
<!--Zero or more repetitions:-->
<CategoryName>CategoryTest1</CategoryName>
<CategoryName>CategoryTest2</CategoryName>
<!--Zero or more repetitions:-->
<AccountAttribute>
<Name>AccountAttribute1</Name>
<Value>AccountAttribute1Value</Value>
</AccountAttribute>
<AccountAttribute>
<Name>AccountAttribute2</Name>
<Value>AccountAttribute2Value</Value>
</AccountAttribute>
<PartnerName>PartnerTestName</PartnerName>
</account>
</tpm:DXAccountRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Account Web Service 67

 DX_TPM_Account Delete Operation
The DX_TPM_Account delete operation deletes an account from the repository.

Guidelines
Use the following guidelines when you delete an account:

• The request must use the delete operation.

• Specify a partner name and account number that exactly matches the partner name and account number
of the account to delete.

Response
When the operation is successful, the web service sends an empty response to the client.

B2B Data Exchange ignores a delete request and does not return a fault response in the following situations:

• The partner name and account number of the account specified in the request does not exist in the
repository.
• The partner name or account number specified in the request is NULL or an empty string.
• The user account used to log in to the B2B Data Exchange Server is not authorized to delete the account.

Delete SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Account web service to delete
an account:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXAccountRequest>
<operation>delete</operation>
<partnerName>myPartner</partnerName>
<accountNumber>myAccount</accountNumber>
</tpm:DXAccountRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Account Count Operation

The DX_TPM_Account count operation returns the number of accounts associated with a specified partner.

Guidelines
Use the following guidelines when you count the accounts for a partner:

• The request must use the count operation.

68 Chapter 7: B2B Data Exchange Web Services API

 Response
The web service returns a fault response in the following situations:

• The partner name does not exist in the B2B Data Exchange repository.
• The partner name is NULL or an empty string, or exceeds the maximum length.
• The partner name identifies a reserved system partner.

Count SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Account web service to count
the accounts for a partner:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXAccountRequest>
<operation>count</operation>
<partnerName>myPartner</partnerName>
</tpm:DXAccountRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Account Get Operation

The DX_TPM_Account get operation returns information for the account associated with a specified index.

You can use the count and get operations together to get information on the account by index. For example,
you can get the total number of accounts for a partner and use it to iterate through a "for" loop to get the
information about each account.

When you use the count as the basis for an index in an iteration, ensure that the count does not change until
the iteration completes. If you insert or delete an account during an iteration, the total number of accounts
can change and invalidate the index.

Guidelines
Use the following guidelines when you get information about an account:

• The request must use the get operation.

• Accounts are indexed by account name in alphabetical order.
• The index numbers range from zero to the total number of accounts minus one (0 ... n-1).

Response
The web service returns a DXAccountResponse object that includes the account information in a DXAccount
object.

DX_TPM_Account Web Service 69

 The web service returns a fault response in the following situations:

• The index is outside the range of index numbers.

• The partner name does not exist in the B2B Data Exchange repository.
• The partner name identifies a dedicated system partner or account.

Get SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Account web service to get an
account by index:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXAccountRequest>
<operation>get</operation>
<partnerName>myPartner</partnerName>
<index>0</index>
</tpm:DXAccountRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Profile Web Service

The DX_TPM_Profile web service creates, deletes, and manages profiles in the B2B Data Exchange
repository.

Use the DX_TPM_Profile web service to perform the following tasks:

• Create a profile.
• Delete a profile.
• Update the information for a profile.
• Search for a profile.
• Count the profiles in the repository.
• Get the information for a profile by index.

Reserved System Profile

Do not use the name none when you create or update a profile. This name is reserved for a dedicated system
profile. The web service returns a fault response if you try to assign this name to another profile.

70 Chapter 7: B2B Data Exchange Web Services API

DX_TPM_Profile Request
The DX_TPM_Profile request defines the task performed by the DX_TPM_Profile web service.

The DX_TPM_Profile request message includes the following elements:

operation

Required. Type of operation the web service will perform. The web service can perform one of the
following operations:

• create
• delete
• update
• search
• count
• get

profile

Complex type object DXProfile that describes the profile to create or update. Required by the create and
update operations and ignored by other operations.

profileName

Name of the profile to search or delete. Required by the search and delete operations.

index

Index of the profile to get. The index number starts at zero. Required by the get operation.

DX_TPM_Profile Response
The DX_TPM_Profile response message is the reply from the DX_TPM_Profile web service.

The DX_TPM_Profile response message includes the following elements:

profile

Complex type object DXProfile that describes the trading partner to create or update. The profile element
is included in the response message for the following operations:

• create
• update
• get
• search

count

Number of profiles in the B2B Data Exchange repository. The count element is included in the response
message for the count operation.

Note: When the web service request is a delete operation, the DX_TPM_Profile web service sends an empty
response to the client.

DX_TPM_Profile Web Service 71

 DX_TPM_Profile Create Operation
The DX_TPM_Profile create operation creates a profile with a specified profile name.

Guidelines
Use the following guidelines when you create a profile:

• The request must use the create operation.

Response
The web service returns a DXProfileResponse object with the new profile information in a DXProfile object.

The web service returns a fault response in the following situations:

• The DXProfile object has an element or attribute with an invalid value.

• The profile name already exists in the B2B Data Exchange repository.
• The partner name is not null but the account number is null.
• The account number is not null but the partner name is null.
• The profile name identifies a reserved system profile.

Create SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Profile web service to create a
profile:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXProfileRequest>
<operation>create</operation>
<profile>
<Id>123</Id>
<Name>ProfileTestName</Name>
<Description>ProfileTestName Description</Description>
<PartnerName>PartnerTestName</PartnerName>
<AccountNumber>123</AccountNumber>
<WorkflowName>WORKFLOW_TEST_NAME</WorkflowName>
<ScheduleName>ScheduleTestName</ScheduleName>
<Status>ENABLED</Status>
<!--Zero or more repetitions:-->
<WorkflowParameter>
<Name>WorkflowTempParameter1</Name>
<Value>WorkflowTempParameter1Value</Value>
</WorkflowParameter>
<WorkflowParameter>
<Name>WorkflowTempParameter2</Name>
<Value>WorkflowTempParameter2Value</Value>
</WorkflowParameter>
<!--Zero or more repetitions:-->
<CategoryName>CategoryName1</CategoryName>

72 Chapter 7: B2B Data Exchange Web Services API

 <CategoryName>CategoryName2</CategoryName>
<!--Zero or more repetitions:-->
<EventAttribute>
<Name>EventAttribute1</Name>
<Value>EventAttribute1Value</Value>
</EventAttribute>
<EventAttribute>
<Name>EventAttribute2</Name>
<Value>EventAttribute2Value</Value>
</EventAttribute>
</profile>
</tpm:DXProfileRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Profile Search Operation

The DX_TPM_Profile search operation searches the repository for a specified profile.

Guidelines
Use the following guidelines when you search for a profile:

• The request must use the search operation.

• The search string must match the profile name exactly. For example, IEDIWithAckn and Acknowledgement
do not match the profile name EDIWithAcknowledgement. The profile name is not case sensitive.

Response
The web service returns a DXProfileResponse object with the new profile information in a DXProfile object.

The web service returns NULL in the following situations:

• The profile name specified in the request does not exist in the repository.
• The profile name specified in the request is NULL or an empty string.
• The user account used to log in to the B2B Data Exchange Server is not authorized to view information
about the profile.
• The profile name identifies a reserved system profile.

Search SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Profile web service to search
for a profile:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXProfileRequest>
<operation>search</operation>
<profileName>myProfile</profileName>

DX_TPM_Profile Web Service 73

 </tpm:DXProfileRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Profile Update Operation

The DX_TPM_Profile update operation updates the information for a specified profile.

Guidelines
Use the following guidelines when you update a profile:

• The request must use the update operation.

Response
The web service returns a fault response in the following situations:

• The profile name specified in the request does not exist in the repository.
• The profile name identifies a reserved system profile.

Update SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Profile web service to update a
profile:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXProfileRequest>
<operation>update</operation>
<profile>
<Id>123</Id>
<Name>ProfileTestName</Name>
<Description>ProfileTestName Description</Description>
<PartnerName>PartnerTestName</PartnerName>
<AccountNumber>123</AccountNumber>
<WorkflowName>WORKFLOW_TEST_NAME</WorkflowName>
<ScheduleName>ScheduleTestName</ScheduleName>
<Status>ENABLED</Status>
<!--Zero or more repetitions:-->
<WorkflowParameter>
<Name>WorkflowTempParameter1</Name>
<Value>WorkflowTempParameter1Value</Value>
</WorkflowParameter>
<WorkflowParameter>
<Name>WorkflowTempParameter2</Name>
<Value>WorkflowTempParameter2Value</Value>
</WorkflowParameter>
<!--Zero or more repetitions:-->
<CategoryName>CategoryName1</CategoryName>
<CategoryName>CategoryName2</CategoryName>
<!--Zero or more repetitions:-->

74 Chapter 7: B2B Data Exchange Web Services API

 <EventAttribute>
<Name>EventAttribute1</Name>
<Value>EventAttribute1Value</Value>
</EventAttribute>
<EventAttribute>
<Name>EventAttribute2</Name>
<Value>EventAttribute2Value</Value>
</EventAttribute>
</profile>
</tpm:DXProfileRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Profile Delete Operation

The DX_TPM_Profile delete operation deletes a profile from the repository.

Guidelines
Use the following guidelines when you delete a profile:

• The request must use the delete operation.

Response
When the request is successful, the web service sends an empty response to the client.

B2B Data Exchange ignores a delete request and does not return a fault response in the following situations:

• The profile does not exist in the repository.

• The profile name specified in the request is NULL or an empty string.
• The user account used to log in to the B2B Data Exchange Server is not authorized to delete the profile.

Delete SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Profile web service to delete a
profile:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXProfileRequest>
<operation>delete</operation>
<profileName>myProfile</profileName>
</tpm:DXProfileRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Profile Web Service 75

 DX_TPM_Profile Count Operation
The DX_TPM_Profile count operation returns the number of profiles in the B2B Data Exchange repository.

Guidelines
Use the following guidelines when you count the profiles in the repository:

• The request must use the count operation.

Response
The count operation returns the number of profiles associated with the B2B Data Exchange user account in
the message header.

Count SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Profile web service to count the
profiles in the repository:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXProfileRequest>
<operation>count</operation>
</tpm:DXProfileRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_TPM_Profile Get Operation

The DX_TPM_Profile get operation returns information for the profile associated with a specified index.

You can use the count and get operations together to get information on a profile by index. For example, you
can get the total count of profiles and use it to iterate through a "for" loop to get the information about each
profile.

When you use the count as the basis for an index in an iteration, ensure that the count does not change until
the iteration completes. If you insert or delete a profile during an iteration, the total number of profiles can
change and invalidate the index.

Guidelines
Use the following guidelines when you get information about a profile:

• The request must use the get operation.

• Profiles are indexed by profile name in alphabetical order.
• The index numbers range from zero to the total count of profiles minus one (0...n-1).

76 Chapter 7: B2B Data Exchange Web Services API

 Response
The web service returns a DXProfileResponse object that includes the profile information in a DXProfile
object.

The web service sends a fault message to the client if the index is outside the range of index numbers.

Get SOAP Message Example

The following SOAP message shows an example of a request to the DX_TPM_Profile web service to get a
profile by index:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inf="http://www.informatica.com/" xmlns:sec="http://b2b.informatica.com/dx/
security" xmlns:tpm="http://b2b.informatica.com/dx/tpm/">
<soapenv:Header>
<inf:Security>
<UsernameToken>
<Username>Administrator</Username>
<Password>Administrator</Password>
</UsernameToken>
</inf:Security>
<sec:DXSecurity>
<sec:DXUsernameToken>
<sec:DXUsername>sys</sec:DXUsername>
<sec:DXPassword DXPasswordType="PasswordText">sys</sec:DXPassword>
</sec:DXUsernameToken>
</sec:DXSecurity>
</soapenv:Header>
<soapenv:Body>
<tpm:DXProfileRequest>
<operation>get</operation>
<index>0</index>
</tpm:DXProfileRequest>
</soapenv:Body>
</soapenv:Envelope>

DX_Endpoint Web Service

The DX_Endpoint web service sends a document to B2B Data Exchange and routes it to a profile for
processing.

DX_Endpoint Request
The DX_Endpoint request message defines a document for the DX_Endpoint web service to process.

The DX_Endpoint request message includes the following elements:

Data

Required. Document to be processed. The document must have Base64 encoding.

DXProperty

Key-value pair that contains the properties of the document. This element is defined by the complex type
object DXProperty and can occur multiple times.

You can include the following keys:

• application. Name of the application to use for routing the document to a profile for processing.

DX_Endpoint Web Service 77

 • profileName. Name of the profile to use for routing the document to a profile for processing.
• partnerName. Name of the partner to use for routing the document to a profile for processing.
• accountNumber. Account number to use for routing the document to a profile for processing.
• accountName. Name of the account to use for routing the document to a profile for processing.
• dataByReference. Indicates whether the request contains data or a reference to data. Set to true
when the request contains a reference to the data. Set to false when the request contains the data.
• mimetype. The MIME type of the data, such as text/plain or text/html.

CustomProperty

Key-value pair that contains custom properties of the document. This element can occur multiple times.

DX_Endpoint Response
The DX_Endpoint response defines the reply from the DX_Endpoint web service.

The DX_Endpoint web service sends an empty response to the client when the request completes
successfully.

Complex Type Objects in the Data Exchange Web

Services
The WSDL for the Data Exchange web services include the following complex type objects:

• DXPartner. Defines a partner.

• DXAccount. Defines an account.
• DXProfile. Defines a profile.
• DXContactInformation. Defines the contact information for a partner.
The properties of the elements in the complex type objects must match the properties of the corresponding
data in B2B Data Exchange. For example, the partner name element has the same maximum length as a
partner in the B2B Data Exchange repository.

DXPartner Object
The DXPartner object defines a partner.

The following table describes the elements and attributes in the DXPartner object:

Element Description

Id Unique identifier for the partner. Generated by B2B Data Exchange when a partner
is created.

Name Required. Name of the partner.

Description Description of the partner.

78 Chapter 7: B2B Data Exchange Web Services API

 Element Description

CategoryName Category of the partner. This element can occur multiple times.

ContactInformation DXContactInformation object that contains the details of the partner contact. This
element can occur multiple times.

PartnerAttribute DXPartnerAttibute object that consists of a name and attribute value pair. This
element can occur multiple times.

CreationDate Date when the partner is created. Generated by the B2B Data Exchange Server
when it creates the partner.

LastUpdatedDate Date when the partner was last updated. Generated by the B2B Data Exchange
Server when it updates the partner.

DXAccount Object
The DXAccount object defines an account.

The following table describes the elements and attributes in the DXAccount object:

Element Description

Number Required. Account number.

Name Required. Name of the account.

Description Description of the account.

CategoryName Category of the account. This element can occur multiple times.

AccountAttribute DXAccountAttibute object that consists of a name and attribute value pair. This
element can occur multiple times.

PartnerName Required. Name of the partner associated with the account.

CreationDate Date when the account is created. Generated by the B2B Data Exchange Server
when it creates the account.

LastUpdatedDate Date when the account was last updated. Generated by the B2B Data Exchange
Server when it updates the account.

Complex Type Objects in the Data Exchange Web Services 79

 DXProfile Object
The DXProfile object defines a profile.

The following table describes the elements and attributes in the DXProfile object:

Element Description

Id Unique identifier for the profile. Generated by B2B Data Exchange when a profile is
created.

Name Required. Name of the profile.

Description Description of the profile.

PartnerName Name of the partner associated with the account.

AccountNumber Account number.

WorkflowName Required. Name of the workflow associated with the profile.

ScheduleName Name of the schedule associated with the profile.

Status Required. DXProfileStatus object that describes the status of the profile.
Set this element to one of the following statuses:
- ENABLED
- DISABLED

WorkflowParameter Parameters for the workflow associated with the profile. The
DXWorkflowParameter object consists of a name and attribute value pair. This
element can occur multiple times.

CategoryName Category of the profile. This element can occur multiple times.

EventAttribute Event attribute associated with the profile. The DXEventAttibute object consists of
a name and attribute value pair. This element can occur multiple times.

CreationDate Date when the partner is created. Generated by the B2B Data Exchange Server
when it creates the profile.

LastUpdatedDate Date when the partner was last updated. Generated by the B2B Data Exchange
Server when it updates the profile.

DXContactInformation Object
The DXContactInformation object defines the contact information for a partner.

The following table describes the elements and attributes in the DXContactInformation object:

Element Description

Name Required. Name of the contact.

Description Description of the contact.

Title Title of the contact.

80 Chapter 7: B2B Data Exchange Web Services API

 Element Description

Address Address of the contact.

PhoneNumber Telephone number of the contact.

BusinessPhoneNumber Business telephone number of the contact.

FaxNumber Fax number of the contact.

EmailAddress Email address of the contact.

General B2B Data Exchange Web Service Behavior

The B2B Data Exchange web services cannot modify a dedicated system profile, account, or partner, or
properties that identify these objects.

The B2B Data Exchange web services have the following general characteristics and behavior:

• The web service operations do not retrieve or modify a dedicated system profile, account, or partner.
• The web service operations cannot modify a property that is used as an identifier. For example, you
cannot use the B2B Data Exchange web services to modify a partner name or an account number.
• The web services return fault responses in the following situations:
- An internal error occurs when a web service is running.

- A required parameter in the web service request is empty or set to NULL.

- An element in the DXPartner, DXAccount, or DXProfile object has a value that is not valid or exceeds the
maximum length.

B2B Data Exchange Web Service Security

When you send a request to a B2B Data Exchange web service, you must provide the user credentials to
access the PowerCenter repository and the B2B Data Exchange server. The user account for the B2B Data
Exchange server determines the web service access to the objects in the B2B Data Exchange repository.

User Authentication
A client application that calls a B2B Data Exchange web service must log in to the PowerCenter repository
and the B2B Data Exchange server to perform any operation.

You must provide the user credentials for the PowerCenter repository and for the B2B Data Exchange server
in the SOAP message header of the web service request.

General B2B Data Exchange Web Service Behavior 81

 The message header contains the following security elements:

• Security. Contains the user name and password to log in to the PowerCenter repository that stores the
B2B Data Exchange web services. The user account must have permissions to run the B2B Data Exchange
web services. You can use plain text passwords and digested passwords. For more information about
configuring digested passwords in PowerCenter, see the Informatica PowerCenter Web Services Provider
Guide.
• DXSecurity. Contains the user name and password of the user account to log in to the B2B Data Exchange
server. The user account must have permissions to view objects in the B2B Data Exchange repository.
The DXSecurity element can have one of the following passwords:
- Plain text password. Password in plain text.

- Digested password. Encrypted password that is hashed with a nonce value and a time stamp.

The password element has a password type attribute that indicates the type of password security used to
log in to the B2B Data Exchange server. Set the password type attribute to PasswordText for a plain text
password or to PasswordDigest for a digested password. If the password type attribute is omitted, the
password type defaults to PasswordText.
Note: Although a B2B Data Exchange user name can include a slash (/), a user account with a slash in the
user name is not valid for B2B Data Exchange web services.
The following example shows the message header for a B2B Data Exchange web service request with the
DXSecurity and Security elements:
<soap:Header>
<ns0:DXSecurity xmlns:ns0="http://b2b.informatica.com/dx/security">
<ns0:DXUsernameToken>
<ns0:DXUsername>[string]</ns0:DXUsername>
<ns0:DXPassword DXPasswordType="[undefined]">[string]</ns0:DXPassword>
<ns0:Nonce>[string]</ns0:Nonce>
<ns0:Created>[string]</ns0:Created>
</ns0:DXUsernameToken>
</ns0:DXSecurity>
<ns0:Security xmlns:ns0="http://www.informatica.com/">
<UsernameToken>
<Username>[string]</Username>
<Password>[string]</Password>
</UsernameToken>
</ns0:Security>
</soap:Header>

User Access
Permissions define the level of access to B2B Data Exchange objects that a user account can have. The
permissions for the user account in the DXSecurity element of the web service request header determines
access to the objects in the B2B Data Exchange repository.

For example, the B2B Data Exchange repository has a hundred partners and user AJones has permission on
five of the partners. A DX_TPM_Partner web service request that uses the credentials of AJones in the
DXSecurity element and performs a count operation returns five partners instead of a hundred.

82 Chapter 7: B2B Data Exchange Web Services API

Chapter 8

B2B Data Exchange Run-time

Java API
This chapter includes the following topics:

• B2B Data Exchange Run-time Java API Overview, 83

• API Reference, 84

B2B Data Exchange Run-time Java API Overview

Use the B2B Data Exchange Run-time 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 Run-time API methods to
process the documents. You can create additional transformations and use the methods in the B2B Data
Exchange Run-time API to define the transformation behavior. You can also call the methods from other
processes or applications based on your document processing requirements.

The B2B Data Exchange Run-time API contains the following package:
com.informatica.b2b.dx.client.DXClient
All B2B Data Exchange Run-time API methods that create a database transaction commit the transaction.

For more information about the B2B Data Exchange Run-time Java API, see the online API reference located
in: <DXInstallationDir>\powercenter\javadoc\dxserver\apidocs\index.html

B2B Data Exchange Run-time Java API Versions

The B2B Data Exchange Run-time Java API includes a client class for each B2B Data Exchange version. To
use the B2B Data Exchange Run-time 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 version 8.6.1 of the API, 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);

83
 • Add the API 8.6.1 jar file to the Java SDK Classpath of the Integration Service. In the Administrator Tool,
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-
<DataExchangeVersion>.jar;
For more information about the methods in the previous version of the B2B Data Exchange Run-time Java
API, see the online API reference:
<DXInstallationDIR>\powercenter\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 a later B2B Data Exchange Run-time Java API version.

API Reference
The following table lists the methods available in the B2B Data Exchange Run-time API:

Method Return Value Description

addEventDocument ( String Attaches a document to an event and returns the

String eventId, document ID for the document attached to the
event.
Document document )

completeCorrelation ( String Completes a reconciliation process and returns

String eventId, the ID of the event that initiated the reconciliation
process.
String correlationId )

completeCorrelations ( void Closes all correlation events of the specified event

String eventId ) Id.

createChildEvent ( String Creates a child event based on a profile ID and

String parentEventId, returns the event ID of the child event.
String profileId )

createChildEvent ( String Creates a child event based on a profile ID and

String parentEventId, sets the properties of the child event. Returns the
event ID of the child event.
String profileId,
String eventStatusName,
String eventTypeName,
String subject )

createDocument ( Document Moves a file into the B2B Data Exchange document
String temporaryFilePath, store and returns the associated document
reference.
String eventId )

flowEntry ( String Indicates the start of a workflow. This method

String profileId ) creates an event and returns the event ID.

84 Chapter 8: B2B Data Exchange Run-time Java API

Method Return Value Description

flowEntry ( String Indicates the start of a workflow. You can specify

String profileId, the event ID to use.
String reuseEventId )

flowExit ( String Indicates the end of a workflow. This method

String eventId ) updates the status of the event with the system
default status and returns the event ID.

flowExit ( String Indicates the end of a workflow. This method

String eventId, updates the status of the event with the given
status and returns the event ID.
String status )

generateTemporaryFilePath ( String Creates a unique file name in the B2B Data

String eventId ) Exchange temporary document directory and
returns the path and file name.

getChildrenCount ( Integer Returns the number of child events for a parent

String parentEventId ) event.

getDocumentData ( byte[] Returns the data of a document.

Document document,
Long offset,
Long count,
String eventId )

getDocumentFilePath ( String Returns the path and file name of the file
Document documentReference, associated with a document reference.
String eventId )

getEventAttribute ( String Returns the value of an event attribute.

String eventId,
String attributeKey )

getEventContext ( Map Returns the run-time context of an event.

String eventId )

getEventDocuments ( List<Document> Returns information about all documents

String eventId ) associated with an event.

getEventInfo ( Properties Returns the information associated with an event,

String eventId ) including event status and event type.

getEventParentEventId ( String Returns the event ID of the parent event.

String eventId )

getEventStatusName ( String Returns the status of an event.

String eventId )

API Reference 85
 Method Return Value Description

incrementProfileSequenceValue ( String Increments by one the value of a sequence

String profileId, parameter associated with a profile.
String parameterSequenceId )

incrementProfileSequenceValue ( String Increments by incrementBy the value of a

String profileId, sequence parameter associated with a profile.
String parameterSequenceId,
String incrementBy )

initiateCorrelation ( void Initiates a reconciliation process.

String eventId,
String correlationId,
String correlationType,
long timeWindowSeconds )

releaseDelayedEvents ( void Releases delayed events.

String profileId,
List<String> eventIds )

resolveProfileId ( String Returns the profile ID associated with an

String accountNumber, application and an account number or partner.
String application,
String partnerName,
String profileName )

setEventAttribute ( String Sets the value of the attribute associated with an

String eventId, event.
String attributeKey,
String attributeValue )

setEventStatus ( void Updates the status of an event.

String eventId,
String eventStatus )

setEventStatus ( void Updates the status of an event.

String eventId,
String eventStatusId,
String comments )

setEventSubject ( void Updates the subject of an event.

String eventId,
String subject )

86 Chapter 8: B2B Data Exchange Run-time Java API

Method Return Value Description

setEventType ( void Updates the type of an event.

String eventId,
String eventType )

setProfileSequenceValue ( String Assigns a value to a sequence parameter

String profileId, associated with a profile.
String parameterSequenceId,
Object newValue )

API Reference 87
Chapter 9

B2B Data Exchange Forms

Designer Java API
This chapter includes the following topics:

• B2B Data Exchange Forms Designer Java API Overview, 88

• B2B Data Exchange Forms Designer Java API Reference, 89

B2B Data Exchange Forms Designer Java API

Overview
Use the B2B Data Exchange Forms Designer Java API to manage values for partner attributes, account
attributes, and workflow parameters. When you use the Forms Designer, you can populate lists of possible
values from external sources. You can also set default values for the lists. B2B Data Exchange throws an
exception if any error occurs while the lists are populated.

The B2B Data Exchange Forms Designer Java API contains the following packages:

• com.informatica.b2b.dx.api.exception. Contains exceptions to throw if any error occurs while the Forms
Designer retrieves values from external sources.
• com.informatica.b2b.dx.client.tpm.rmi. Contains classes, interfaces, and methods to use when you define
the external sources from which to retrieve the list of values in the Forms Designer.

To use the API, you include JAR file dependencies in the classpath. Use the files from the following locations:

• <DXInstallationDir>\powercenter\lib\dx-client-powercenter-9.5.1.jar
• <DXInstallationDir>\powercenter\lib\log4j-1.2.16.jar

For more information about the B2B Data Exchange Forms Designer Java API, see the online API reference
located in the following directory: <DXInstallationDir>\powercenter\javadoc\tpm\apidocs\index.html.

88
B2B Data Exchange Forms Designer Java API
Reference
The following table lists the methods in the B2B Data Exchange Forms Designer Java API:

Method Return Description

Value

updateAccountCustomAttribute ( void Replaces the list of values for a custom account attribute with
String attributeId, values from an external list without setting a default value.
List<String> allowedValues )

updateAccountCustomAttribute ( void Replaces the list of values for a custom account attribute with
String attributeId, values from an external list and sets a default value.
List<String> allowedValues,
String defaultValue )

updatePartnerCustomAttribute ( void Replaces the list of values for a custom partner attribute with values
String attributeId, from an external list without setting a default value.
List<String> allowedValues )

updatePartnerCustomAttribute ( void Replaces the list of values for a custom partner attribute with values
String attributeId, from an external list and sets a default value.
List<String> allowdValues,
String defaultValue )

updateWorkflowParameters ( void Replaces the list of values for a custom workflow parameter with
String workflowName, values from an external list without setting a default value.
String parameterId,
List<String> allowedValues )

updateWorkflowParameters ( void Replaces the list of values for a custom workflow parameter with
String workflowName, values from an external list and sets a default value.
String parameterId,
List<String> allowedValues,
String defaultValue )

B2B Data Exchange Forms Designer Java API Reference 89

Index

B DX_Initiate_Correlation
definition 32
B2B Data Exchange workflow ports 32, 33
definition 39 properties 33
DX_Profile_Parameters
definition 33

C ports 34
DX_Release_Delayed_Events
client plug-in for PowerCenter definition 35
installing Data Exchange transformations 10 ports 35
DX_Resolve_Profile
definition 35

D ports 35, 36
properties 36
Data Exchange plug-ins DX_Throw_Error
client plug-in for PowerCenter 10 definition 36
server plug-in for PowerCenter 10 ports 37
Data Integration Hub workflows properties 38
managing 39
DX_Add_Document_To_Event
definition 20
ports 20, 21
E
properties 22 email
DX_Aggregate monitor notification 52
definition 22 email for monitor notification
ports 23 configuring 52
properties 24 event reconciliation
DX_Complete_Correlation overview 42
definition 24
ports 24, 25
properties 25
DX_Create_Event
F
definition 25 forms designer
ports 26 actions 48
properties 26 definition 47
DX_Event_Attribute Designer tab 47
definition 27 element properties 49
ports 27 group properties 50
properties 28 using 50
DX_Event_Details Forms Designer
definition 28 Java API reference 89
ports 28
properties 29
DX_Generate_Temporary_File
definition 29
M
ports 29 monitor notification
properties 30 email 52
DX_Get_Document_File_Path
definition 30
ports 30
properties 31
P
DX_Increment_Profile_Parameter pending reconciliation
definition 31 reconciliation status 44
ports 31 PowerCenter
properties 32 create mapping 13
creating source definition 10

90
PowerCenter (continued) Transformation
creating target definition 12 DX_Add_Document_To_Event 20
creating the workflow 15 DX_Aggregate 22
export workflow 16 DX_Complete_Correlation 24
installing plug-ins 10 DX_Create_Event 25
JMS connection 13, 14 DX_Event_Attribute 27
JNDI connection 13, 14 DX_Event_Details 28
sources and targets for B2B Data Exchange 10 DX_Generate_Temporary_File 29
DX_Get_Document_File_Path 30
DX_Increment_Profile_Parameter 31

R DX_Initiate_Correlation 32
DX_Profile_Parameters 33
reconciled after timeout DX_Release_Delayed_Events 35
reconciliation status 44 DX_Resolve_Profile 35
reconciliation complete DX_Throw_Error 36
reconciliation status 44 Transformations
reconciliation status configuring 19
ranking 44 definition 17
reconciled after timeout 44 error handling 19
reconciliation complete 44 guidelines 19
reconciliation correlation 44 installing plug-ins 18
timed out 44
reconciliations
completing 43
definition 42
W
initiating 43 workflow
B2B Data Exchange 39
workflow parameters

S customizing 50
workflows
server plug-in for PowerCenter properties 40
installing Data Exchange transformations 10

T
timed out
reconciliation status 44

Index 91